<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>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="CommandLineOptions.xml" />
</para>
- <para>You may also use a URL as a filename. The file will be downloaded to a temporary file and displayed.</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=<w>x<h>+<x>+<y></entry>
- <entry>Set the <width> <height> <xoffset> <yoffset> of the window. The parameters are in pixels.</entry>
- </row>
- <row>
- <entry>-n</entry>
- <entry>--new-instance</entry>
- <entry>Open a new instance of Geeqie.</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[=<level>]</entry>
- <entry>Turn on debugging output (when compiled with Debug enabled). <level> is 0 to 4.</entry>
- </row>
- <row>
- <entry>-g:<regexp></entry>
- <entry>--grep:<regexp></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:<file></entry>
- <entry>--log-file:<file></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>
- <row>
- <entry />
- <entry>--disable-clutter</entry>
- <entry>Disable use of Clutter library (i.e. GPU accel.). If the Clutter library is compiled into Geeqie but Clutter fails to initialize, it is necessary to start Geeqie with this option.</entry>
- </row>
- <row>
- <entry />
- <entry>--cache-maintenance <path></entry>
- <entry>
- Run cache maintenance
- <footnote id='cachemaintenance'>
- <para><link linkend="CacheMaintenance">Cache Maintenance</link>.</para>
- </footnote>
- in non-GUI mode.
- </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:<folder></entry>
- <entry>Start recursive slide show for <folder> in main window.</entry>
- </row>
- <row>
- <entry>-d<[h:][m:][n][.m]></entry>
- <entry>--delay=<[h:][m:][n][.m]></entry>
- <entry>Set slide show delay to <[hrs:][mins:][n][.m]> 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:<file>|layout ID</entry>
- <entry>Load configuration from <file>. Use either a full path, or a saved window layout ID.</entry>
- </row>
- <row>
- <entry />
- <entry>--get-sidecars:<file></entry>
- <entry>Get list of sidecars of <file>.</entry>
- </row>
- <row>
- <entry />
- <entry>--get-destination:<file></entry>
- <entry>Get destination path of <file>. 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:<file>|<URL></entry>
- <entry>Open <file> or <URL> and bring Geeqie window to the top</entry>
- </row>
- <row>
- <entry />
- <entry>--file:<file>|<URL></entry>
- <entry>Open <file> or <URL> and bring Geeqie window to the top</entry>
- </row>
- <row>
- <entry />
- <entry>File:<file>|<URL></entry>
- <entry>Open <file> or <URL> and do not bring Geeqie window to the top</entry>
- </row>
- <row>
- <entry />
- <entry>--File:<file>|<URL></entry>
- <entry>Open <file> or <URL> 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>--get-rectangle</entry>
- <entry>Get rectangle coordinates</entry>
- </row>
- <row>
- <entry />
- <entry>--get-render-intent</entry>
- <entry>Get render intent</entry>
- </row>
- <row>
- <entry />
- <entry>--get-filelist:[<FOLDER>]</entry>
- <entry>Get list of files and class</entry>
- </row>
- <row>
- <entry />
- <entry>--get-filelist-recurse:[<FOLDER>]</entry>
- <entry>Get list of files and class recursive</entry>
- </row>
- <row>
- <entry />
- <entry>--get-collection:<COLLECTION></entry>
- <entry>Get collection content</entry>
- </row>
- <row>
- <entry />
- <entry>--get-collection-list</entry>
- <entry>Get collection list</entry>
- </row>
- <row>
- <entry />
- <entry>--get-file-info</entry>
- <entry>
- Get file info
- <footnote id='fileinfo'>
- <para>File info consists of: class, no. of pages (if multi-page image), (and if exif exists) country name, country code, timezone, local time.</para>
- </footnote>
- </entry>
- </row>
- <row>
- <entry />
- <entry>view:<file></entry>
- <entry>Open new window containing <file></entry>
- </row>
- <row>
- <entry />
- <entry>--view:<file></entry>
- <entry>Open new window containing <file></entry>
- </row>
- <row>
- <entry />
- <entry>--list-clear</entry>
- <entry>Clear command line collection list</entry>
- </row>
- <row>
- <entry />
- <entry>--list-add:<file></entry>
- <entry>Add <file> 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:<ID></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 />
- <entry>--geometry=[<w>x<h>][+<x>+<y>]</entry>
- <entry>Set the <width> <height> <xoffset> <yoffset> of the window. The parameters are in pixels.</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:<folder></entry>
- <entry>--cache-render:<folder></entry>
- <entry>render thumbnails</entry>
- </row>
- <row>
- <entry>-crr:<folder></entry>
- <entry>--cache-render-recurse:<folder></entry>
- <entry>render thumbnails recursively</entry>
- </row>
- <row>
- <entry>-crs:<folder></entry>
- <entry>--cache-render-shared:<folder></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:<folder></entry>
- <entry>--cache-render-shared-recurse:<folder></entry>
- <entry>render thumbnails recursively</entry>
- </row>
- <row>
- <entry />
- <entry>--lua:<file>,<lua script></entry>
- <entry>run lua script on file</entry>
- </row>
- <row>
- <entry />
- <entry>--PWD:<PWD></entry>
- <entry>Use PWD as working directory for following commands</entry>
- </row>
- <row>
- <entry />
- <entry>--print0</entry>
- <entry>Terminate returned data with null character instead of newline</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para />
- </section>
</section>
projects / geeqie.git / blobdiff