4 <title>Instantlauncher - navigate to your files and programs quickly!</title>
5 <!-- 2018-06-24 Sun 02:49 -->
7 <meta name="viewport" content="width=device-width, initial-scale=1">
8 <meta name="generator" content="Org-mode">
9 <meta name="author" content="Svjatoslav Agejenko">
10 <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
11 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
12 <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
13 <style type="text/css">
14 footer {background-color: #111 !important;}
15 pre {background-color: #111; color: #ccc;}
17 <style type="text/css">
18 /* org mode styles on top of twbs */
35 background-color: #f5f5f5;
62 display: inline-block;
74 .bs-docs-sidebar.affix {
77 @media (min-width: 768px) {
83 /* All levels of nav */
84 .bs-docs-sidebar .nav > li > a {
91 .bs-docs-sidebar .nav > li > a:hover,
92 .bs-docs-sidebar .nav > li > a:focus {
95 text-decoration: none;
96 background-color: transparent;
97 border-left: 1px solid #A1283B;
99 .bs-docs-sidebar .nav > .active > a,
100 .bs-docs-sidebar .nav > .active:hover > a,
101 .bs-docs-sidebar .nav > .active:focus > a {
105 background-color: transparent;
106 border-left: 2px solid #A1283B;
109 /* Nav: second level (shown on .active) */
110 .bs-docs-sidebar .nav .nav {
111 display: none; /* Hide by default, but at >768px, show it */
112 padding-bottom: 10px;
114 .bs-docs-sidebar .nav .nav > li > a {
121 .bs-docs-sidebar .nav .nav > li > a:hover,
122 .bs-docs-sidebar .nav .nav > li > a:focus {
125 .bs-docs-sidebar .nav .nav > .active > a,
126 .bs-docs-sidebar .nav .nav > .active:hover > a,
127 .bs-docs-sidebar .nav .nav > .active:focus > a {
132 /* Nav: third level (shown on .active) */
133 .bs-docs-sidebar .nav .nav .nav {
134 padding-bottom: 10px;
136 .bs-docs-sidebar .nav .nav .nav > li > a {
143 .bs-docs-sidebar .nav .nav .nav > li > a:hover,
144 .bs-docs-sidebar .nav .nav .nav > li > a:focus {
147 .bs-docs-sidebar .nav .nav .nav > .active > a,
148 .bs-docs-sidebar .nav .nav .nav > .active:hover > a,
149 .bs-docs-sidebar .nav .nav .nav > .active:focus > a {
154 /* Show and affix the side nav when space allows it */
155 @media (min-width: 992px) {
156 .bs-docs-sidebar .nav > .active > ul {
159 /* Widen the fixed sidebar */
160 .bs-docs-sidebar.affix,
161 .bs-docs-sidebar.affix-bottom {
164 .bs-docs-sidebar.affix {
165 position: fixed; /* Undo the static from mobile first approach */
168 .bs-docs-sidebar.affix-bottom {
169 position: absolute; /* Undo the static from mobile first approach */
171 .bs-docs-sidebar.affix .bs-docs-sidenav,.bs-docs-sidebar.affix-bottom .bs-docs-sidenav {
176 @media (min-width: 1200px) {
177 /* Widen the fixed sidebar again */
178 .bs-docs-sidebar.affix-bottom,
179 .bs-docs-sidebar.affix {
184 <script type="text/javascript">
188 $('.bs-docs-sidebar li').first().addClass('active');
190 $(document.body).scrollspy({target: '.bs-docs-sidebar'});
192 $('.bs-docs-sidebar').affix();
197 <div id="content" class="container">
198 <div class="row"><div class="col-md-9"><h1 class="title">Instantlauncher - navigate to your files and programs quickly!</h1>
200 <div id="outline-container-sec-1" class="outline-2">
201 <h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
202 <div class="outline-text-2" id="text-1">
204 <li>This program is free software: you can redistribute it and/or modify
205 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
206 published by the Free Software Foundation, either version 3 of the
207 License, or (at your option) any later version.
212 <li>Svjatoslav Agejenko
214 <li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
216 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
221 <li><a href="http://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
226 <div id="outline-container-sec-1-1" class="outline-3">
227 <h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
228 <div class="outline-text-3" id="text-1-1">
230 <li><a href="http://www2.svjatoslav.eu/gitweb/?p=instantlauncher.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
233 <li><a href="http://www2.svjatoslav.eu/gitweb/?p=instantlauncher.git;a=summary">Browse Git repository online</a>
236 <li>Clone Git repository using command:
237 <pre class="example">
238 git clone http://www2.svjatoslav.eu/git/instantlauncher.git
246 <div id="outline-container-sec-2" class="outline-2">
247 <h2 id="sec-2"><span class="section-number-2">2</span> Purpose</h2>
248 <div class="outline-text-2" id="text-2">
250 Quick filesystem based document/application launcher. It starts by
251 showing content of <a href="#sec-4-4">predefined directory</a>. Sub directories can be chosen
252 by simply moving mouse pointer over corresponding directory.
257 <p><img src="screenshot.png" class="img-responsive" alt="screenshot.png">
262 Files types are color-coded.
267 <div id="outline-container-sec-3" class="outline-2">
268 <h2 id="sec-3"><span class="section-number-2">3</span> Usage</h2>
269 <div class="outline-text-2" id="text-3">
271 Simply hovering mouse pointer over directory expands its contents in
272 the next right column.
277 <li>Executable file (red):
279 <li>Left mouse click:
281 <li>Run executable file.
285 <li>Right mouse click:
287 <li>Toggle executable state.
294 <li>Non-executable file (green):
296 <li>Left mouse click:
298 <li>Open file using corresponding application.
302 <li>Right mouse click:
304 <li>Toggle executable state.
311 <li>Directory/symlink (blue):
313 <li>Left mouse click:
315 <li>Open directory using configured filesystem browser.
319 <li>Right mouse click:
321 <li>Open directory using configured text based terminal emulator.
331 <div id="outline-container-sec-4" class="outline-2">
332 <h2 id="sec-4"><span class="section-number-2">4</span> Configuration</h2>
333 <div class="outline-text-2" id="text-4">
335 When instantlauncher starts, it looks for configuration file under
337 <pre class="example">
342 If file is not found, it creates new default configuration file in
345 <pre class="example">
347 directoryOpenCommand: nautilus -w {file}
348 directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
350 - command: vlc {file}
352 - command: emacs {file}
354 - command: eog {file}
356 - command: eog {file}
358 - command: vlc {file}
360 - command: vlc {file}
362 - command: eog {file}
364 - command: emacs {file}
366 navigationRootPath: /home/svjatoslav/
370 <div id="outline-container-sec-4-1" class="outline-3">
371 <h3 id="sec-4-1"><span class="section-number-3">4.1</span> directoryOpenCommand</h3>
372 <div class="outline-text-3" id="text-4-1">
374 Command to use when opening directory.
378 By default instantlauncher assumes that Gnome desktop environment is
379 installed and uses Nautilus file manager:
381 <pre class="example">
382 directoryOpenCommand: nautilus -w {file}
386 <div id="outline-container-sec-4-2" class="outline-3">
387 <h3 id="sec-4-2"><span class="section-number-3">4.2</span> directoryTerminalOpenCommand</h3>
388 <div class="outline-text-3" id="text-4-2">
390 Command to use when opening directory in text terminal based console.
394 By default instantlauncher assumes that Gnome desktop environment is
395 installed and uses Gnome Terminal:
398 <pre class="example">
399 directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
403 <div id="outline-container-sec-4-3" class="outline-3">
404 <h3 id="sec-4-3"><span class="section-number-3">4.3</span> fileAssociations</h3>
405 <div class="outline-text-3" id="text-4-3">
407 Allows to map file name/extension using regular expression pattern
408 matching to corresponding application.
414 <div class="org-src-container">
416 <pre class="src src-conf">- command: vlc {file}
425 <dt> command </dt><dd>Command to execute to open given file. Special variable
426 {file} will point to user chosen file using absolute file
430 <dt> fileRegex </dt><dd>Regular expression that must match the file.
435 <div id="outline-container-sec-4-4" class="outline-3">
436 <h3 id="sec-4-4"><a id="ID-5ced6bf5-165a-49a0-8de4-3755d810d987" name="ID-5ced6bf5-165a-49a0-8de4-3755d810d987"></a><span class="section-number-3">4.4</span> navigationRootPath</h3>
437 <div class="outline-text-3" id="text-4-4">
439 Root directory from where to start navigation.
443 This parameter is user specific! In my case instantlauncher by default
444 pointed this to my home directory. But it can be any directory user
449 I think good use-case is to create special directory to be used for
450 instantlauncher root. This special root directory can in turn contain
451 symlinks to various places user wants to visit often. Instantlauncher
452 will follow symlinks as if they were directories.
455 <pre class="example">
456 navigationRootPath: /home/svjatoslav/
461 </div><div class="col-md-3"><nav id="table-of-contents">
462 <div id="text-table-of-contents" class="bs-docs-sidebar">
464 <li><a href="#sec-1">1. General</a>
466 <li><a href="#sec-1-1">1.1. Source code</a></li>
469 <li><a href="#sec-2">2. Purpose</a></li>
470 <li><a href="#sec-3">3. Usage</a></li>
471 <li><a href="#sec-4">4. Configuration</a>
473 <li><a href="#sec-4-1">4.1. directoryOpenCommand</a></li>
474 <li><a href="#sec-4-2">4.2. directoryTerminalOpenCommand</a></li>
475 <li><a href="#sec-4-3">4.3. fileAssociations</a></li>
476 <li><a href="#sec-4-4">4.4. navigationRootPath</a></li>
483 <footer id="postamble" class="">
484 <div><p class="author">Author: Svjatoslav Agejenko</p>
485 <p class="date">Created: 2018-06-24 Sun 02:49</p>
486 <p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.1.1 (<a href="http://orgmode.org">Org-mode</a> 8.2.10)</p>