X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.html;h=f900ffe47a6b37d4ddcc74b32422ea673c1a3df7;hb=795b1120ecbbfed8d3e7575bac32608750362c8b;hp=068ef9a40fd67a70c5ebaf4599f0138aebfbc3ce;hpb=17d7a34974ab7b0142e10c6f85880c5290dbf0cd;p=instantlauncher.git diff --git a/doc/index.html b/doc/index.html index 068ef9a..f900ffe 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,194 +1,263 @@ - - - + + - - - Instantlauncher - navigate to your files and programs quickly! - - + + + + + + + + + - -
-

Instantlauncher - navigate to your files and programs quickly!

-
-

Table of Contents

-
- -
-
-
- +
+
+

1.1 Source code

+
+ +
+
+ + +
+

2 Purpose

+

-Quick filesystem based document/application launcher. It starts by showing -content of predefined directory. Sub directories can be chosen by simply moving -mouse pointer over corresponding directory. +Quick filesystem based document/application launcher. It starts by +showing content of predefined directory. Sub directories can be chosen +by simply moving mouse pointer over corresponding directory.

-
-

screenshot.png +

+

screenshot.png

-
+

Files types are color-coded. @@ -196,71 +265,231 @@ Files types are color-coded.

-
-

2 Usage

-
+
+

3 Usage

+
+

+Simply hovering mouse pointer over directory expands its contents in +the next right column. +

+ +
    -
  • Executable file: +
  • Executable file (red):
    • Left mouse click:
        -
      • Run executable file.
        • -
      • +
    • Run executable file. +
      • +
    +
  • Right mouse click:
      -
    • Toggle executable state.
      • -
    • -
+
  • Toggle executable state. +
    • + + + + -
  • Non-executable file: +
  • Non-executable file (green):
    • Left mouse click:
        -
      • Open file using corresponding application.
        • -
      • +
    • Open file using corresponding application. +
      • +
    +
  • Right mouse click:
      -
    • Toggle executable state.
      • -
    • - +
  • Toggle executable state. +
    • + + + + -
  • Directory/symlink: +
  • Directory/symlink (blue):
    • Left mouse click:
        -
      • Open directory using configured filesystem browser.
        • -
      • +
    • Open directory using configured filesystem browser. +
      • +
    +
  • Right mouse click:
      -
    • Open directory using configured text based terminal emulator.
      • -
    • - +
  • Open directory using configured text based terminal emulator. +
    • + + + +
    -
    -

    3 Configuration

    -
    +
    +

    4 Configuration

    +
    +

    +When instantlauncher starts, it looks for configuration file under +

    +
    +~/.instantlauncher
+
+
    + +

    +If file is not found, it creates new default configuration file in +YAML format: +

    +
    +!configuration
+directoryOpenCommand: nautilus -w {file}
+directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
+fileAssociations:
+-  command: vlc {file}
+   fileRegex: .*\.mkv$
+-  command: emacs {file}
+   fileRegex: .*\.txt$
+-  command: eog {file}
+   fileRegex: .*\.jpeg$
+-  command: eog {file}
+   fileRegex: .*\.png$
+-  command: vlc {file}
+   fileRegex: .*\.avi$
+-  command: vlc {file}
+   fileRegex: .*\.mp4$
+-  command: eog {file}
+   fileRegex: .*\.jpg$
+-  command: emacs {file}
+   fileRegex: .*\.org$
+navigationRootPath: /home/svjatoslav/
+
    +
    + +
    +

    4.1 directoryOpenCommand

    +

    -TODO: +Command to use when opening directory.

    + +

    +By default instantlauncher assumes that Gnome desktop environment is +installed and uses Nautilus file manager: +

    +
    +directoryOpenCommand: nautilus -w {file}
+
+
    +
    +

    4.2 directoryTerminalOpenCommand

    +
    +

    +Command to use when opening directory in text terminal based console. +

    -
    -

    4 TODO

    -

    -TODO: +By default instantlauncher assumes that Gnome desktop environment is +installed and uses Gnome Terminal:

    + +
    +directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
+
+
    +
    +

    4.3 fileAssociations

    +
    +

    +Allows to map file name/extension using regular expression pattern +matching to corresponding application. +

    + +

    +Example: +

    +
    + +
    -  command: vlc {file}
+   fileRegex: .*\.mkv$
+
    +
    + +

    +Where: +

    +
    +
    command
    Command to execute to open given file. Special variable +{file} will point to user chosen file using absolute file +path. +
    + +
    fileRegex
    Regular expression that must match the file. +
    +
    +
    +
    +
    +

    4.4 navigationRootPath

    +
    +

    +Root directory from where to start navigation. +

    + +

    +This parameter is user specific! In my case instantlauncher by default +pointed this to my home directory. But it can be any directory user +chooses. +

    + +

    +I think good use-case is to create special directory to be used for +instantlauncher root. This special root directory can in turn contain +symlinks to various places user wants to visit often. Instantlauncher +will follow symlinks as if they were directories. +

    + +
    +navigationRootPath: /home/svjatoslav/
+
+
    +
    +
    +
    +
    +
    +