X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=instantlauncher.git;a=blobdiff_plain;f=doc%2Findex.html;h=4088d6e394d5a3d8be3458aff6a78c8a84e8bf61;hp=febe9c0b816338284056b15d09c343a6b8aacf8b;hb=e3ffc2bb7c897529d91f0cd8d1a371cc6b7f893c;hpb=c97a79ee69acc8fc2030c04f3a9470aec8db0f79 diff --git a/doc/index.html b/doc/index.html index febe9c0..4088d6e 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ Instantlauncher - navigate to your files and programs quickly! - + @@ -225,9 +225,9 @@ published by the Free Software Foundation.

1 General description

-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.

@@ -245,8 +245,14 @@ Files types are color-coded.

2 Usage

+

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

+ +
    -
  • Executable file: +
  • Executable file (red):
    • Left mouse click:
        @@ -263,7 +269,7 @@ Files types are color-coded.
      • -
    • Non-executable file: +
    • Non-executable file (green):
      • Left mouse click:
          @@ -280,7 +286,7 @@ Files types are color-coded.
        • -
      • Directory/symlink: +
      • Directory/symlink (blue):
        • Left mouse click:
            @@ -304,17 +310,130 @@ Files types are color-coded.

            3 Configuration

            -TODO: +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/
+
            +
            + +
            +

            3.1 directoryOpenCommand

            +
            +

            +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}
+
            +
            +

            3.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}
+
            +
            +
            +
            +

            3.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. +
            +
            +
            +
            +
            +

            3.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/
+
            +