view doc/docbook/GuideReferenceCommandLine.xml @ 2912:3fc1b4b21177

Update documentation, remove obsolete GQview import options Update plugin and remote commands documentation. The last update for GQview was 13 years ago; presumably the import options are no longer useful.
author Colin Clark <colin.clark@cclark.uk>
date Wed, 27 Mar 2019 11:56:16 +0000
parents a03b5446e68f
children
line wrap: on
line source

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideReferenceCommandLine">
  <title>Command Line Options</title>
  <para>
    Geeqie is called by the command:
    <programlisting>
      geeqie [options] [path_to_file_or_collection]
      <footnote id='ref1'>The name of a collection, with or without either path or extension (.gqv) may be used. If a path is not used and there is a name conflict with a file or folder, that will take precedence.</footnote>
    </programlisting>
  </para>
  <para>These are the command line options available to Geeqie:</para>
  <table frame="all">
    <tgroup cols="3" rowsep="1" colsep="1">
      <thead rowsep="1" colsep="1">
        <row>
          <entry>Short Option</entry>
          <entry>Long Option</entry>
          <entry>Description</entry>
        </row>
      </thead>
      <tbody rowsep="1" colsep="1">
        <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 [filelist] [collectionlist]</entry>
          <entry>--list [filelist] [collectionlist]</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 />
          <entry>--blank</entry>
          <entry>Start with file list blank.</entry>
        </row>
        <row>
          <entry />
          <entry>--geometry=&lt;w&gt;x&lt;h&gt;+&lt;x&gt;+&lt;y&gt;</entry>
          <entry>Set the &lt;width&gt; &lt;height&gt; &lt;xoffset&gt; &lt;yoffset&gt; of the window. The parameters are in pixels.</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[=&lt;level&gt;]</entry>
          <entry>Turn on debugging output (when compiled with Debug enabled). &lt;level&gt; is 0 to 4.</entry>
        </row>
        <row>
          <entry>-g:&lt;regexp&gt;</entry>
          <entry>--grep:&lt;regexp&gt;</entry>
          <entry>Filter debug output with regular expression</entry>
        </row>
        <row>
          <entry>+w</entry>
          <entry>--show-log-window</entry>
          <entry>Display log window</entry>
        </row>
        <row>
          <entry>-o:&lt;file&gt;</entry>
          <entry>--log-file:&lt;file&gt;</entry>
          <entry>Save log data to file</entry>
        </row>
        <row>
          <entry />
          <entry>--alternate</entry>
          <entry>Use alternate similarity algorithm - experimental - requires re-compile.</entry>
        </row>
      </tbody>
    </tgroup>
  </table>
  <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>
    <table frame="all">
      <tgroup cols="3" rowsep="1" colsep="1">
        <thead rowsep="1" colsep="1">
          <row>
            <entry>Short Option</entry>
            <entry>Long Option</entry>
            <entry>Description</entry>
          </row>
        </thead>
        <tbody>
          <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 />
            <entry>--slideshow-recurse:&lt;folder&gt;</entry>
            <entry>Start recursive slide show for &lt;folder&gt; in main window.</entry>
          </row>
          <row>
            <entry>-d&lt;[h:][m:][n][.m]&gt;</entry>
            <entry>--delay=&lt;[h:][m:][n][.m]&gt;</entry>
            <entry>Set slide show delay to &lt;[hrs:][mins:][n][.m]&gt; seconds, range is 0.1 secs to 24 hours</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>--config-load:&lt;file&gt;</entry>
            <entry>Load configuration from &lt;file&gt;.</entry>
          </row>
          <row>
            <entry />
            <entry>--get-sidecars:&lt;file&gt;</entry>
            <entry>Get list of sidecars of &lt;file&gt;.</entry>
          </row>
          <row>
            <entry />
            <entry>--get-destination:&lt;file&gt;</entry>
            <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>
          </row>
          <row>
            <entry />
            <entry>file:&lt;file&gt;</entry>
            <entry>Open  &lt;file&gt; and bring Geeqie window to the top</entry>
          </row>
          <row>
            <entry />
            <entry>--file:&lt;file&gt;</entry>
            <entry>Open  &lt;file&gt; and bring Geeqie window to the top</entry>
          </row>
          <row>
            <entry />
            <entry>File:&lt;file&gt;</entry>
            <entry>Open  &lt;file&gt; and do not bring Geeqie window to the top</entry>
          </row>
          <row>
            <entry />
            <entry>--File:&lt;file&gt;</entry>
            <entry>Open  &lt;file&gt; and do not bring Geeqie window to the top</entry>
          </row>
          <row>
            <entry />
            <entry>--tell</entry>
            <entry>Print filename [and Collection] of current image</entry>
          </row>
          <row>
            <entry />
            <entry>--pixel-info</entry>
            <entry>Print X, Y and RGB of mouse pointer on current image</entry>
          </row>
          <row>
            <entry />
            <entry>view:&lt;file&gt;</entry>
            <entry>Open new window containing &lt;file&gt;</entry>
          </row>
          <row>
            <entry />
            <entry>--view:&lt;file&gt;</entry>
            <entry>Open new window containing &lt;file&gt;</entry>
          </row>
          <row>
            <entry />
            <entry>--list-clear</entry>
            <entry>Clear command line collection list</entry>
          </row>
          <row>
            <entry />
            <entry>--list-add:&lt;file&gt;</entry>
            <entry>Add &lt;file&gt; to command line collection list</entry>
          </row>
          <row>
            <entry />
            <entry>raise</entry>
            <entry>Bring the geeqie window to the top</entry>
          </row>
          <row>
            <entry />
            <entry>--raise</entry>
            <entry>Bring the geeqie window to the top</entry>
          </row>
          <row>
            <entry />
            <entry>--id:&lt;ID&gt;</entry>
            <entry>
              Window ID for following commands
              <footnote id='ref3'>
                <para>The ID is shown in the titlebar of the window. If multiple windows are open, it can be used to direct commands to a particular window e.g. --remote --id:main --tell</para>
              </footnote>
            </entry>
          </row>
          <row>
            <entry />
            <entry>--new-window</entry>
            <entry>Open new window</entry>
          </row>
          <row>
            <entry />
            <entry>--close-window</entry>
            <entry>Close window</entry>
          </row>
          <row>
            <entry>-ct:clear|clean</entry>
            <entry>--cache-thumbs:clear|clean</entry>
            <entry>clear or clean thumbnail cache</entry>
          </row>
          <row>
            <entry>-cs:clear|clean</entry>
            <entry>--cache-shared:clear|clean</entry>
            <entry>clear or clean shared thumbnail cache</entry>
          </row>
          <row>
            <entry>-cm</entry>
            <entry>--cache-metadata</entry>
            <entry>clean the metadata cache</entry>
          </row>
          <row>
            <entry>-cr:&lt;folder&gt;</entry>
            <entry>--cache-render:&lt;folder&gt;</entry>
            <entry>render thumbnails</entry>
          </row>
          <row>
            <entry>-crr:&lt;folder&gt;</entry>
            <entry>--cache-render-recurse:&lt;folder&gt;</entry>
            <entry>render thumbnails recursively</entry>
          </row>
          <row>
            <entry>-crs:&lt;folder&gt;</entry>
            <entry>--cache-render-shared:&lt;folder&gt;</entry>
            <entry>
              render thumbnails
              <footnote id='ref2'>
                <para>If standard thumbnail cache is not enabled, this command will be ignored.</para>
              </footnote>
            </entry>
          </row>
          <row>
            <entry>-crsr:&lt;folder&gt;</entry>
            <entry>--cache-render-shared-recurse:&lt;folder&gt;</entry>
            <entry>render thumbnails recursively</entry>
          </row>
          <row>
            <entry />
            <entry>--lua:&lt;file&gt;,&lt;lua script&gt;</entry>
            <entry>run lua script on file</entry>
          </row>
          <row>
            <entry />
            <entry>--PWD:&lt;PWD&gt;</entry>
            <entry>Use PWD as working directory for following commands</entry>
          </row>
        </tbody>
      </tgroup>
    </table>
    <para />
  </section>
</section>