4 <title>Instantlauncher - navigate to your files and programs quickly!</title>
5 <!-- 2017-07-10 Mon 14:59 -->
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/darkly/bootstrap.min.css" rel="stylesheet">
11 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
12 <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/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>
201 <li><a href="http://www2.svjatoslav.eu/gitweb/?p=instantlauncher.git;a=snapshot;h=HEAD;sf=tgz">download latest snapshot</a>
204 <li>This program is free software; you can redistribute it and/or modify it under
205 the terms of version 3 of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> or later as
206 published by the Free Software Foundation.
211 <li>Svjatoslav Agejenko
213 <li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
215 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
220 <li><a href="http://www.svjatoslav.eu/programs.jsp">other applications hosted at svjatoslav.eu</a>
224 <div id="outline-container-sec-1" class="outline-2">
225 <h2 id="sec-1"><span class="section-number-2">1</span> General description</h2>
226 <div class="outline-text-2" id="text-1">
228 Quick filesystem based document/application launcher. It starts by
229 showing content of <a href="#sec-3-4">predefined directory</a>. Sub directories can be chosen
230 by simply moving mouse pointer over corresponding directory.
235 <p><img src="screenshot.png" class="img-responsive" alt="screenshot.png">
240 Files types are color-coded.
245 <div id="outline-container-sec-2" class="outline-2">
246 <h2 id="sec-2"><span class="section-number-2">2</span> Usage</h2>
247 <div class="outline-text-2" id="text-2">
249 Simply hovering mouse pointer over directory expands its contents in
250 the next right column.
255 <li>Executable file (red):
257 <li>Left mouse click:
259 <li>Run executable file.
263 <li>Right mouse click:
265 <li>Toggle executable state.
272 <li>Non-executable file (green):
274 <li>Left mouse click:
276 <li>Open file using corresponding application.
280 <li>Right mouse click:
282 <li>Toggle executable state.
289 <li>Directory/symlink (blue):
291 <li>Left mouse click:
293 <li>Open directory using configured filesystem browser.
297 <li>Right mouse click:
299 <li>Open directory using configured text based terminal emulator.
309 <div id="outline-container-sec-3" class="outline-2">
310 <h2 id="sec-3"><span class="section-number-2">3</span> Configuration</h2>
311 <div class="outline-text-2" id="text-3">
313 When instantlauncher starts, it looks for configuration file under
315 <pre class="example">
320 If file is not found, it creates new default configuration file in
323 <pre class="example">
325 directoryOpenCommand: nautilus -w {file}
326 directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
328 - command: vlc {file}
330 - command: emacs {file}
332 - command: eog {file}
334 - command: eog {file}
336 - command: vlc {file}
338 - command: vlc {file}
340 - command: eog {file}
342 - command: emacs {file}
344 navigationRootPath: /home/svjatoslav/
348 <div id="outline-container-sec-3-1" class="outline-3">
349 <h3 id="sec-3-1"><span class="section-number-3">3.1</span> directoryOpenCommand</h3>
350 <div class="outline-text-3" id="text-3-1">
352 Command to use when opening directory.
356 By default instantlauncher assumes that Gnome desktop environment is
357 installed and uses Nautilus file manager:
359 <pre class="example">
360 directoryOpenCommand: nautilus -w {file}
364 <div id="outline-container-sec-3-2" class="outline-3">
365 <h3 id="sec-3-2"><span class="section-number-3">3.2</span> directoryTerminalOpenCommand</h3>
366 <div class="outline-text-3" id="text-3-2">
368 Command to use when opening directory in text terminal based console.
372 By default instantlauncher assumes that Gnome desktop environment is
373 installed and uses Gnome Terminal:
376 <pre class="example">
377 directoryTerminalOpenCommand: gnome-terminal --working-directory={file}
381 <div id="outline-container-sec-3-3" class="outline-3">
382 <h3 id="sec-3-3"><span class="section-number-3">3.3</span> fileAssociations</h3>
383 <div class="outline-text-3" id="text-3-3">
385 Allows to map file name/extension using regular expression pattern
386 matching to corresponding application.
392 <div class="org-src-container">
394 <pre class="src src-conf">- command: vlc {file}
403 <dt> command </dt><dd>Command to execute to open given file. Special variable
404 {file} will point to user chosen file using absolute file
408 <dt> fileRegex </dt><dd>Regular expression that must match the file.
413 <div id="outline-container-sec-3-4" class="outline-3">
414 <h3 id="sec-3-4"><a id="ID-5ced6bf5-165a-49a0-8de4-3755d810d987" name="ID-5ced6bf5-165a-49a0-8de4-3755d810d987"></a><span class="section-number-3">3.4</span> navigationRootPath</h3>
415 <div class="outline-text-3" id="text-3-4">
417 Root directory from where to start navigation.
421 This parameter is user specific! In my case instantlauncher by default
422 pointed this to my home directory. But it can be any directory user
427 I think good use-case is to create special directory to be used for
428 instantlauncher root. This special root directory can in turn contain
429 symlinks to various places user wants to visit often. Instantlauncher
430 will follow symlinks as if they were directories.
433 <pre class="example">
434 navigationRootPath: /home/svjatoslav/
439 </div><div class="col-md-3"><nav id="table-of-contents">
440 <div id="text-table-of-contents" class="bs-docs-sidebar">
442 <li><a href="#sec-1">1. General description</a></li>
443 <li><a href="#sec-2">2. Usage</a></li>
444 <li><a href="#sec-3">3. Configuration</a>
446 <li><a href="#sec-3-1">3.1. directoryOpenCommand</a></li>
447 <li><a href="#sec-3-2">3.2. directoryTerminalOpenCommand</a></li>
448 <li><a href="#sec-3-3">3.3. fileAssociations</a></li>
449 <li><a href="#sec-3-4">3.4. navigationRootPath</a></li>
456 <footer id="postamble" class="">
457 <div><p class="author">Author: Svjatoslav Agejenko</p>
458 <p class="date">Created: 2017-07-10 Mon 14:59</p>
459 <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>