doc/index.org

   1 #+TITLE: Instantlauncher - navigate to your files and programs quickly!
   2
   3 * (document settings) :noexport:
   4 ** use dark style for TWBS-HTML exporter
   5 #+HTML_HEAD: <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
   6 #+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
   7 #+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
   8 #+HTML_HEAD: <style type="text/css">
   9 #+HTML_HEAD:   footer {background-color: #111 !important;}
  10 #+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
  11 #+HTML_HEAD: </style>
  12
  13 * General
  14 - This program is free software: released under Creative Commons Zero
  15   (CC0) license
  16
  17 - Program author:
  18   - Svjatoslav Agejenko
  19   - Homepage: https://svjatoslav.eu
  20   - Email: mailto://svjatoslav@svjatoslav.eu
  21
  22 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
  23
  24 ** Source code
  25 - [[https://www2.svjatoslav.eu/gitweb/?p=instantlauncher.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
  26
  27 - [[https://www2.svjatoslav.eu/gitweb/?p=instantlauncher.git;a=summary][Browse Git repository online]]
  28
  29 - Clone Git repository using command:
  30   : git clone https://www2.svjatoslav.eu/git/instantlauncher.git
  31
  32 * Purpose
  33 Quick filesystem based document/application launcher. It starts by
  34 showing content of [[id:5ced6bf5-165a-49a0-8de4-3755d810d987][predefined directory]]. Sub directories can be chosen
  35 by simply moving mouse pointer over corresponding directory.
  36
  37 [[file:screenshot.png]]
  38
  39 Files types are color-coded.
  40
  41 * Usage
  42 Simply hovering mouse pointer over directory expands its contents in
  43 the next right column.
  44
  45
  46 + Executable file (red):
  47   + Left mouse click:
  48     + Run executable file.
  49   + Right mouse click:
  50     + Toggle executable state.
  51
  52 + Non-executable file (green):
  53   + Left mouse click:
  54     + Open file using corresponding application.
  55   + Right mouse click:
  56     + Toggle executable state.
  57
  58 + Directory/symlink (blue):
  59   + Left mouse click:
  60     + Open directory using configured filesystem browser.
  61   + Right mouse click:
  62     + Open directory using configured text based terminal emulator.
  63
  64 * Configuration
  65 When instantlauncher starts, it looks for configuration file under
  66 : ~/.instantlauncher
  67
  68 If file is not found, it creates new default configuration file in
  69 YAML format:
  70 #+BEGIN_SRC
  71 !configuration
  72 directoryOpenCommand: nautilus -w {file}
  73 directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
  74 fileAssociations:
  75 -  command: vlc {file}
  76    fileRegex: .*\.mkv$
  77 -  command: emacs {file}
  78    fileRegex: .*\.txt$
  79 -  command: eog {file}
  80    fileRegex: .*\.jpeg$
  81 -  command: eog {file}
  82    fileRegex: .*\.png$
  83 -  command: vlc {file}
  84    fileRegex: .*\.avi$
  85 -  command: vlc {file}
  86    fileRegex: .*\.mp4$
  87 -  command: eog {file}
  88    fileRegex: .*\.jpg$
  89 -  command: emacs {file}
  90    fileRegex: .*\.org$
  91 navigationRootPath: /home/svjatoslav/
  92 #+END_SRC
  93
  94 ** directoryOpenCommand
  95 Command to use when opening directory.
  96
  97 By default instantlauncher assumes that Gnome desktop environment is
  98 installed and uses Nautilus file manager:
  99 : directoryOpenCommand: nautilus -w {file}
 100 ** directoryTerminalOpenCommand
 101 Command to use when opening directory in text terminal based console.
 102
 103 By default instantlauncher assumes that Gnome desktop environment is
 104 installed and uses Gnome Terminal:
 105
 106 : directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
 107 ** fileAssociations
 108 Allows to map file name/extension using regular expression pattern
 109 matching to corresponding application.
 110
 111 Example:
 112 #+BEGIN_SRC conf
 113 -  command: vlc {file}
 114    fileRegex: .*\.mkv$
 115 #+END_SRC
 116
 117 Where:
 118 - command :: Command to execute to open given file. Special variable
 119              {file} will point to user chosen file using absolute file
 120              path.
 121
 122 - fileRegex :: Regular expression that must match the file.
 123 ** navigationRootPath
 124     :PROPERTIES:
 125     :ID:       5ced6bf5-165a-49a0-8de4-3755d810d987
 126     :END:
 127 Root directory from where to start navigation.
 128
 129 This parameter is user specific! In my case instantlauncher by default
 130 pointed this to my home directory. But it can be any directory user
 131 chooses.
 132
 133 I think good use-case is to create special directory to be used for
 134 instantlauncher root. This special root directory can in turn contain
 135 symlinks to various places user wants to visit often. Instantlauncher
 136 will follow symlinks as if they were directories.
 137
 138 : navigationRootPath: /home/svjatoslav/