Additional debug features
[geeqie.git] / doc / docbook / GuideReferenceCommandLine.xml
index 1294df7..0076433 100644 (file)
-<?xml version="1.0" encoding="utf-8"?>
-<section id="GuideReferenceCommandLine">
-    <title>
-      Command Line Options
-    </title>
-    <para>
-      These are the command line options available to Geeqie:
-    </para>
-    <informaltable><tgroup cols="3"><tbody><row><entry>
-          Short Option
-        </entry><entry>
-          Long Option
-        </entry><entry>
-          Description
-        </entry></row>
-<row><entry>
-          +t
-        </entry><entry>
-          --with-tools
-        </entry><entry>
-          Show file list, menu, and statusbar.
-        </entry></row>
-<row><entry>
-          -t
-        </entry><entry>
-          --without-tools
-        </entry><entry>
-          Hide file list, menu, and statusbar. Window contains image only.
-        </entry></row>
-<row><entry>
-          -f
-        </entry><entry>
-          --fullscreen
-        </entry><entry>
-          Start up in fullscreen.
-        </entry></row>
-<row><entry>
-          -s
-        </entry><entry>
-          --slideshow
-        </entry><entry>
-          Start up in slideshow mode.
-        </entry></row>
-<row><entry>
-          -l
-        </entry><entry>
-          --list
-        </entry><entry>
-          Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection.
-        </entry></row>
-<row><entry>
-          -r
-        </entry><entry>
-          --remote
-        </entry><entry>
-          Send command line options to existing Geeqie process.
-        </entry></row>
-<row><entry>
-          -rh
-        </entry><entry>
-          --remote-help
-        </entry><entry>
-          List command line options available to --remote.
-        </entry></row>
-<row><entry>
-          -h
-        </entry><entry>
-          --help
-        </entry><entry>
-          Display brief command line option list.
-        </entry></row>
-<row><entry>
-          -v
-        </entry><entry>
-          --version
-        </entry><entry>
-          Display version of Geeqie.
-        </entry></row>
-<row><entry/><entry>
-          --debug
-        </entry><entry>
-          Enable Debug output to console.
-        </entry></row>
-</tbody></tgroup></informaltable>
-    <para/><section id="Remotecommands"><title>
-      Remote commands
-    </title>
-    <para>
-      The --remote command line option will send all entered commands to an existing Geeqie process, a new process will be started if one does not exist. These are the additional commands that can be used with the remote command:
-    </para>
-    <informaltable><tgroup cols="3"><tbody><row><entry>
-          Short Option
-        </entry><entry>
-          Long Option
-        </entry><entry>
-          Description
-        </entry></row>
-<row><entry>
-          -n
-        </entry><entry>
-          --next
-        </entry><entry>
-          Change main window to display next image.
-        </entry></row>
-<row><entry>
-          -b
-        </entry><entry>
-          --back
-        </entry><entry>
-          Change main window to display previous image.
-        </entry></row>
-<row><entry/><entry>
-          --first
-        </entry><entry>
-          Change main window to display first image.
-        </entry></row>
-<row><entry/><entry>
-          --last
-        </entry><entry>
-          Change main window to display last image.
-        </entry></row>
-<row><entry>
-          -f
-        </entry><entry>
-          --fullscreen
-        </entry><entry>
-          Toggle full screen mode of the main window.
-        </entry></row>
-<row><entry>
-          -fs
-        </entry><entry>
-          --fullscreen-start
-        </entry><entry>
-          Start full screen mode for main window.
-        </entry></row>
-<row><entry>
-          -fS
-        </entry><entry>
-          --fullscreen-stop
-        </entry><entry>
-          Stop full screen mode for main window.
-        </entry></row>
-<row><entry>
-          -s
-        </entry><entry>
-          --slideshow
-        </entry><entry>
-          Toggle slide show for main window.
-        </entry></row>
-<row><entry>
-          -ss
-        </entry><entry>
-          --slideshow-start
-        </entry><entry>
-          Start slide show for main window.
-        </entry></row>
-<row><entry>
-          -sS
-        </entry><entry>
-          --slideshow-stop
-        </entry><entry>
-          Stop slide show for main window.
-        </entry></row>
-<row><entry>
-          -sr&amp;lt;folder&amp;gt;
-        </entry><entry>
-          --slideshow-recurse&amp;lt;folder&amp;gt;
-        </entry><entry>
-          Start recursive slide show for &amp;lt;folder&amp;gt; in main window.
-        </entry></row>
-<row><entry>
-          -d&amp;lt;n&amp;gt;
-        </entry><entry>
-          --delay=&amp;lt;n&amp;gt;
-        </entry><entry>
-          Set slide show delay to &amp;lt;n&amp;gt; seconds, range is 0.1 to 3600
-        </entry></row>
-<row><entry>
-          +t
-        </entry><entry>
-          --tools-show
-        </entry><entry>
-          Show tools for main window.
-        </entry></row>
-<row><entry>
-          -t
-        </entry><entry>
-          --tools-hide
-        </entry><entry>
-          Hide tools for main window.
-        </entry></row>
-<row><entry>
-          -q
-        </entry><entry>
-          --quit
-        </entry><entry>
-          Quit Geeqie.
-        </entry></row>
-<row><entry/><entry>
-          file:&amp;lt;filename&amp;gt;
-        </entry><entry>
-          Change main window to display &amp;lt;filename&amp;gt;
-        </entry></row>
-<row><entry/><entry>
-          view:&amp;lt;filename&amp;gt;
-        </entry><entry>
-          Open new window containing &amp;lt;filename&amp;gt;
-        </entry></row>
-</tbody></tgroup></informaltable>
-  <para/></section></section>
+<?xml version="1.0" encoding="utf-8"?>\r
+<section id="GuideReferenceCommandLine">\r
+  <title>Command Line Options</title>\r
+  <para>\r
+    Geeqie is called by the command:\r
+    <programlisting>geeqie [options] [path_to_file]</programlisting>\r
+  </para>\r
+  <para>These are the command line options available to Geeqie:</para>\r
+  <table frame="all">\r
+    <tgroup cols="3" rowsep="1" colsep="1">\r
+      <thead rowsep="1" colsep="1">\r
+        <row>\r
+          <entry>Short Option</entry>\r
+          <entry>Long Option</entry>\r
+          <entry>Description</entry>\r
+        </row>\r
+      </thead>\r
+      <tbody rowsep="1" colsep="1">\r
+        <row>\r
+          <entry>+t</entry>\r
+          <entry>--with-tools</entry>\r
+          <entry>Show file list, menu, and statusbar.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-t</entry>\r
+          <entry>--without-tools</entry>\r
+          <entry>Hide file list, menu, and statusbar. Window contains image only.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-f</entry>\r
+          <entry>--fullscreen</entry>\r
+          <entry>Start up in fullscreen.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-s</entry>\r
+          <entry>--slideshow</entry>\r
+          <entry>Start up in slideshow mode.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-l [filelist] [collectionlist]</entry>\r
+          <entry>--list [filelist] [collectionlist]</entry>\r
+          <entry>Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection.</entry>\r
+        </row>\r
+        <row>\r
+          <entry />\r
+          <entry>--blank</entry>\r
+          <entry>Start with file list blank.</entry>\r
+        </row>\r
+        <row>\r
+          <entry />\r
+          <entry>--geometry=&lt;w&gt;x&lt;h&gt;+&lt;x&gt;+&lt;y&gt;</entry>\r
+          <entry>Set the &lt;width&gt; &lt;height&gt; &lt;xoffset&gt; &lt;yoffset&gt; of the window. The parameters are in pixels.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-r</entry>\r
+          <entry>--remote</entry>\r
+          <entry>Send command line options to existing Geeqie process.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-rh</entry>\r
+          <entry>--remote-help</entry>\r
+          <entry>List command line options available to --remote.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-h</entry>\r
+          <entry>--help</entry>\r
+          <entry>Display brief command line option list.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-v</entry>\r
+          <entry>--version</entry>\r
+          <entry>Display version of Geeqie.</entry>\r
+        </row>\r
+        <row>\r
+          <entry />\r
+          <entry>--debug[=&lt;level&gt;]</entry>\r
+          <entry>Turn on debugging output (when compiled with Debug enabled). &lt;level&gt; is 0 to 4.</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-g:&lt;regexp&gt;</entry>\r
+          <entry>--grep:&lt;regexp&gt;</entry>\r
+          <entry>Filter debug output with regular expression</entry>\r
+        </row>\r
+        <row>\r
+          <entry>+w</entry>\r
+          <entry>--show-log-window</entry>\r
+          <entry>Display log window</entry>\r
+        </row>\r
+        <row>\r
+          <entry>-o:&lt;file&gt;</entry>\r
+          <entry>--log-file:&lt;file&gt;</entry>\r
+          <entry>Save log data to file</entry>\r
+        </row>\r
+        <row>\r
+          <entry />\r
+          <entry>--alternate</entry>\r
+          <entry>Use alternate similarity algorithm - experimental - requires re-compile.</entry>\r
+        </row>\r
+      </tbody>\r
+    </tgroup>\r
+  </table>\r
+  <para />\r
+  <section id="Remotecommands">\r
+    <title>Remote commands</title>\r
+    <para>The --remote command line option will send all entered commands to an existing Geeqie process, a new process will be started if one does not exist. These are the additional commands that can be used with the remote command:</para>\r
+    <table frame="all">\r
+      <tgroup cols="3" rowsep="1" colsep="1">\r
+        <thead rowsep="1" colsep="1">\r
+          <row>\r
+            <entry>Short Option</entry>\r
+            <entry>Long Option</entry>\r
+            <entry>Description</entry>\r
+          </row>\r
+        </thead>\r
+        <tbody>\r
+          <row>\r
+            <entry>-n</entry>\r
+            <entry>--next</entry>\r
+            <entry>Change main window to display next image.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-b</entry>\r
+            <entry>--back</entry>\r
+            <entry>Change main window to display previous image.</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--first</entry>\r
+            <entry>Change main window to display first image.</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--last</entry>\r
+            <entry>Change main window to display last image.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-f</entry>\r
+            <entry>--fullscreen</entry>\r
+            <entry>Toggle full screen mode of the main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-fs</entry>\r
+            <entry>--fullscreen-start</entry>\r
+            <entry>Start full screen mode for main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-fS</entry>\r
+            <entry>--fullscreen-stop</entry>\r
+            <entry>Stop full screen mode for main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-s</entry>\r
+            <entry>--slideshow</entry>\r
+            <entry>Toggle slide show for main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-ss</entry>\r
+            <entry>--slideshow-start</entry>\r
+            <entry>Start slide show for main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-sS</entry>\r
+            <entry>--slideshow-stop</entry>\r
+            <entry>Stop slide show for main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--slideshow-recurse:&lt;folder&gt;</entry>\r
+            <entry>Start recursive slide show for &lt;folder&gt; in main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-d&lt;[n][.m]&gt;</entry>\r
+            <entry>--delay=&lt;[n][.m]&gt;</entry>\r
+            <entry>Set slide show delay to &lt;[n][.m]&gt; seconds, range is 0.1 to 3600</entry>\r
+          </row>\r
+          <row>\r
+            <entry>+t</entry>\r
+            <entry>--tools-show</entry>\r
+            <entry>Show tools for main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-t</entry>\r
+            <entry>--tools-hide</entry>\r
+            <entry>Hide tools for main window.</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-q</entry>\r
+            <entry>--quit</entry>\r
+            <entry>Quit Geeqie.</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--config-load:&lt;file&gt;</entry>\r
+            <entry>Load configuration from &lt;file&gt;.</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--get-sidecars:&lt;file&gt;</entry>\r
+            <entry>Get list of sidecars of &lt;file&gt;.</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--get-destination:&lt;file&gt;</entry>\r
+            <entry>Get destination path of &lt;file&gt;. This is used by the symlink desktop file to implement the symbolic link operation. There is no useful function for the user.</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>file:&lt;file&gt;</entry>\r
+            <entry>Open  &lt;file&gt; and bring Geeqie window to the top</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>File:&lt;file&gt;</entry>\r
+            <entry>Open  &lt;file&gt; and do not bring Geeqie window to the top</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--tell</entry>\r
+            <entry>Print filename of current image</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>view:&lt;file&gt;</entry>\r
+            <entry>Open new window containing &lt;file&gt;</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--list-clear</entry>\r
+            <entry>Clear command line collection list</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>--list-add:&lt;file&gt;</entry>\r
+            <entry>Add &lt;file&gt; to command line collection list</entry>\r
+          </row>\r
+          <row>\r
+            <entry />\r
+            <entry>raise</entry>\r
+            <entry>Bring the geeqie window to the top</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-ct:clear|clean</entry>\r
+            <entry>--cache-thumbs:clear|clean</entry>\r
+            <entry>clear or clean thumbnail cache</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-cs:clear|clean</entry>\r
+            <entry>--cache-shared:clear|clean</entry>\r
+            <entry>clear or clean shared thumbnail cache</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-cm</entry>\r
+            <entry>--cache-metadata</entry>\r
+            <entry>clean the metadata cache</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-cr:&lt;folder&gt;</entry>\r
+            <entry>--cache-render:&lt;folder&gt;</entry>\r
+            <entry>render thumbnails</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-crr:&lt;folder&gt;</entry>\r
+            <entry>--cache-render-recurse:&lt;folder&gt;</entry>\r
+            <entry>render thumbnails recursively</entry>\r
+          </row>\r
+          <row>\r
+            <entry>-crs:&lt;folder&gt;</entry>\r
+            <entry>--cache-render-shared:&lt;folder&gt;</entry>\r
+            <entry>\r
+              render thumbnails\r
+              <footnote id='ref2'>\r
+                <para>If standard thumbnail cache is not enabled, this command will be ignored.</para>\r
+              </footnote>\r
+            </entry>\r
+          </row>\r
+          <row>\r
+            <entry>-crsr:&lt;folder&gt;</entry>\r
+            <entry>--cache-render-shared-recurse:&lt;folder&gt;</entry>\r
+            <entry>render thumbnails recursively</entry>\r
+          </row>\r
+        </tbody>\r
+      </tgroup>\r
+    </table>\r
+    <para />\r
+  </section>\r
+</section>\r