doc/docbook/GuideReferenceCommandLine.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideReferenceCommandLine">
   3   <title>Command Line Options</title>
   4   <para>
   5     Geeqie is called by the command:
   6     <programlisting>
   7       geeqie [options] [path_to_file_or_collection]
   8       <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>
   9     </programlisting>
  10   </para>
  11   <para>You may also use a URL as a filename. The file will be downloaded to a temporary file and displayed.</para>
  12   <para>These are the command line options available to Geeqie:</para>
  13   <table frame="all">
  14     <tgroup cols="3" rowsep="1" colsep="1">
  15       <thead rowsep="1" colsep="1">
  16         <row>
  17           <entry>Short Option</entry>
  18           <entry>Long Option</entry>
  19           <entry>Description</entry>
  20         </row>
  21       </thead>
  22       <tbody rowsep="1" colsep="1">
  23         <row>
  24           <entry>+t</entry>
  25           <entry>--with-tools</entry>
  26           <entry>Show file list, menu, and statusbar.</entry>
  27         </row>
  28         <row>
  29           <entry>-t</entry>
  30           <entry>--without-tools</entry>
  31           <entry>Hide file list, menu, and statusbar. Window contains image only.</entry>
  32         </row>
  33         <row>
  34           <entry>-f</entry>
  35           <entry>--fullscreen</entry>
  36           <entry>Start up in fullscreen.</entry>
  37         </row>
  38         <row>
  39           <entry>-s</entry>
  40           <entry>--slideshow</entry>
  41           <entry>Start up in slideshow mode.</entry>
  42         </row>
  43         <row>
  44           <entry>-l [filelist] [collectionlist]</entry>
  45           <entry>--list [filelist] [collectionlist]</entry>
  46           <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>
  47         </row>
  48         <row>
  49           <entry />
  50           <entry>--blank</entry>
  51           <entry>Start with file list blank.</entry>
  52         </row>
  53         <row>
  54           <entry />
  55           <entry>--geometry=&lt;w&gt;x&lt;h&gt;+&lt;x&gt;+&lt;y&gt;</entry>
  56           <entry>Set the &lt;width&gt; &lt;height&gt; &lt;xoffset&gt; &lt;yoffset&gt; of the window. The parameters are in pixels.</entry>
  57         </row>
  58         <row>
  59           <entry>-n</entry>
  60           <entry>--new-instance</entry>
  61           <entry>Open a new instance of Geeqie.</entry>
  62         </row>
  63         <row>
  64           <entry>-r</entry>
  65           <entry>--remote</entry>
  66           <entry>Send command line options to existing Geeqie process.</entry>
  67         </row>
  68         <row>
  69           <entry>-rh</entry>
  70           <entry>--remote-help</entry>
  71           <entry>List command line options available to --remote.</entry>
  72         </row>
  73         <row>
  74           <entry>-h</entry>
  75           <entry>--help</entry>
  76           <entry>Display brief command line option list.</entry>
  77         </row>
  78         <row>
  79           <entry>-v</entry>
  80           <entry>--version</entry>
  81           <entry>Display version of Geeqie.</entry>
  82         </row>
  83         <row>
  84           <entry />
  85           <entry>--debug[=&lt;level&gt;]</entry>
  86           <entry>Turn on debugging output (when compiled with Debug enabled). &lt;level&gt; is 0 to 4.</entry>
  87         </row>
  88         <row>
  89           <entry>-g:&lt;regexp&gt;</entry>
  90           <entry>--grep:&lt;regexp&gt;</entry>
  91           <entry>Filter debug output with regular expression</entry>
  92         </row>
  93         <row>
  94           <entry>+w</entry>
  95           <entry>--show-log-window</entry>
  96           <entry>Display log window</entry>
  97         </row>
  98         <row>
  99           <entry>-o:&lt;file&gt;</entry>
 100           <entry>--log-file:&lt;file&gt;</entry>
 101           <entry>Save log data to file</entry>
 102         </row>
 103         <row>
 104           <entry />
 105           <entry>--alternate</entry>
 106           <entry>Use alternate similarity algorithm - experimental - requires re-compile.</entry>
 107         </row>
 108         <row>
 109           <entry />
 110           <entry>--disable-clutter</entry>
 111           <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>
 112         </row>
 113         <row>
 114           <entry />
 115           <entry>--cache-maintenance &lt;path&gt;</entry>
 116           <entry>
 117             Run cache maintenance
 118             <footnote id='cachemaintenance'>
 119               <para><link linkend="CacheMaintenance">Cache Maintenance</link>.</para>
 120             </footnote>
 121             in non-GUI mode.
 122           </entry>
 123         </row>
 124       </tbody>
 125     </tgroup>
 126   </table>
 127   <para />
 128   <section id="Remotecommands">
 129     <title>Remote commands</title>
 130     <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>
 131     <table frame="all">
 132       <tgroup cols="3" rowsep="1" colsep="1">
 133         <thead rowsep="1" colsep="1">
 134           <row>
 135             <entry>Short Option</entry>
 136             <entry>Long Option</entry>
 137             <entry>Description</entry>
 138           </row>
 139         </thead>
 140         <tbody>
 141           <row>
 142             <entry>-n</entry>
 143             <entry>--next</entry>
 144             <entry>Change main window to display next image.</entry>
 145           </row>
 146           <row>
 147             <entry>-b</entry>
 148             <entry>--back</entry>
 149             <entry>Change main window to display previous image.</entry>
 150           </row>
 151           <row>
 152             <entry />
 153             <entry>--first</entry>
 154             <entry>Change main window to display first image.</entry>
 155           </row>
 156           <row>
 157             <entry />
 158             <entry>--last</entry>
 159             <entry>Change main window to display last image.</entry>
 160           </row>
 161           <row>
 162             <entry>-f</entry>
 163             <entry>--fullscreen</entry>
 164             <entry>Toggle full screen mode of the main window.</entry>
 165           </row>
 166           <row>
 167             <entry>-fs</entry>
 168             <entry>--fullscreen-start</entry>
 169             <entry>Start full screen mode for main window.</entry>
 170           </row>
 171           <row>
 172             <entry>-fS</entry>
 173             <entry>--fullscreen-stop</entry>
 174             <entry>Stop full screen mode for main window.</entry>
 175           </row>
 176           <row>
 177             <entry>-s</entry>
 178             <entry>--slideshow</entry>
 179             <entry>Toggle slide show for main window.</entry>
 180           </row>
 181           <row>
 182             <entry>-ss</entry>
 183             <entry>--slideshow-start</entry>
 184             <entry>Start slide show for main window.</entry>
 185           </row>
 186           <row>
 187             <entry>-sS</entry>
 188             <entry>--slideshow-stop</entry>
 189             <entry>Stop slide show for main window.</entry>
 190           </row>
 191           <row>
 192             <entry />
 193             <entry>--slideshow-recurse:&lt;folder&gt;</entry>
 194             <entry>Start recursive slide show for &lt;folder&gt; in main window.</entry>
 195           </row>
 196           <row>
 197             <entry>-d&lt;[h:][m:][n][.m]&gt;</entry>
 198             <entry>--delay=&lt;[h:][m:][n][.m]&gt;</entry>
 199             <entry>Set slide show delay to &lt;[hrs:][mins:][n][.m]&gt; seconds, range is 0.1 secs to 24 hours</entry>
 200           </row>
 201           <row>
 202             <entry>+t</entry>
 203             <entry>--tools-show</entry>
 204             <entry>Show tools for main window.</entry>
 205           </row>
 206           <row>
 207             <entry>-t</entry>
 208             <entry>--tools-hide</entry>
 209             <entry>Hide tools for main window.</entry>
 210           </row>
 211           <row>
 212             <entry>-q</entry>
 213             <entry>--quit</entry>
 214             <entry>Quit Geeqie.</entry>
 215           </row>
 216           <row>
 217             <entry />
 218             <entry>--config-load:&lt;file&gt;|layout ID</entry>
 219             <entry>Load configuration from &lt;file&gt;. Use either a full path, or a saved window layout ID.</entry>
 220           </row>
 221           <row>
 222             <entry />
 223             <entry>--get-sidecars:&lt;file&gt;</entry>
 224             <entry>Get list of sidecars of &lt;file&gt;.</entry>
 225           </row>
 226           <row>
 227             <entry />
 228             <entry>--get-destination:&lt;file&gt;</entry>
 229             <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>
 230           </row>
 231           <row>
 232             <entry />
 233             <entry>file:&lt;file&gt;|&lt;URL&gt;</entry>
 234             <entry>Open  &lt;file&gt; or &lt;URL&gt; and bring Geeqie window to the top</entry>
 235           </row>
 236           <row>
 237             <entry />
 238             <entry>--file:&lt;file&gt;|&lt;URL&gt;</entry>
 239             <entry>Open  &lt;file&gt; or &lt;URL&gt; and bring Geeqie window to the top</entry>
 240           </row>
 241           <row>
 242             <entry />
 243             <entry>File:&lt;file&gt;|&lt;URL&gt;</entry>
 244             <entry>Open  &lt;file&gt; or &lt;URL&gt; and do not bring Geeqie window to the top</entry>
 245           </row>
 246           <row>
 247             <entry />
 248             <entry>--File:&lt;file&gt;|&lt;URL&gt;</entry>
 249             <entry>Open  &lt;file&gt; or &lt;URL&gt; and do not bring Geeqie window to the top</entry>
 250           </row>
 251           <row>
 252             <entry />
 253             <entry>--tell</entry>
 254             <entry>Print filename [and Collection] of current image</entry>
 255           </row>
 256           <row>
 257             <entry />
 258             <entry>--pixel-info</entry>
 259             <entry>Print X, Y and RGB of mouse pointer on current image</entry>
 260           </row>
 261           <row>
 262             <entry />
 263             <entry>--get-rectangle</entry>
 264             <entry>Get rectangle coordinates</entry>
 265           </row>
 266           <row>
 267             <entry />
 268             <entry>--get-render-intent</entry>
 269             <entry>Get render intent</entry>
 270           </row>
 271           <row>
 272             <entry />
 273             <entry>--get-filelist:[&lt;FOLDER&gt;]</entry>
 274             <entry>Get list of files and class</entry>
 275           </row>
 276           <row>
 277             <entry />
 278             <entry>--get-filelist-recurse:[&lt;FOLDER&gt;]</entry>
 279             <entry>Get list of files and class recursive</entry>
 280           </row>
 281           <row>
 282             <entry />
 283             <entry>--get-collection:&lt;COLLECTION&gt;</entry>
 284             <entry>Get collection content</entry>
 285           </row>
 286           <row>
 287             <entry />
 288             <entry>--get-collection-list</entry>
 289             <entry>Get collection list</entry>
 290           </row>
 291           <row>
 292             <entry />
 293             <entry>--get-file-info</entry>
 294             <entry>
 295               Get file info
 296               <footnote id='fileinfo'>
 297                 <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>
 298               </footnote>
 299             </entry>
 300           </row>
 301           <row>
 302             <entry />
 303             <entry>view:&lt;file&gt;</entry>
 304             <entry>Open new window containing &lt;file&gt;</entry>
 305           </row>
 306           <row>
 307             <entry />
 308             <entry>--view:&lt;file&gt;</entry>
 309             <entry>Open new window containing &lt;file&gt;</entry>
 310           </row>
 311           <row>
 312             <entry />
 313             <entry>--list-clear</entry>
 314             <entry>Clear command line collection list</entry>
 315           </row>
 316           <row>
 317             <entry />
 318             <entry>--list-add:&lt;file&gt;</entry>
 319             <entry>Add &lt;file&gt; to command line collection list</entry>
 320           </row>
 321           <row>
 322             <entry />
 323             <entry>raise</entry>
 324             <entry>Bring the geeqie window to the top</entry>
 325           </row>
 326           <row>
 327             <entry />
 328             <entry>--raise</entry>
 329             <entry>Bring the geeqie window to the top</entry>
 330           </row>
 331           <row>
 332             <entry />
 333             <entry>--id:&lt;ID&gt;</entry>
 334             <entry>
 335               Window ID for following commands
 336               <footnote id='ref3'>
 337                 <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>
 338               </footnote>
 339             </entry>
 340           </row>
 341           <row>
 342             <entry />
 343             <entry>--new-window</entry>
 344             <entry>Open new window</entry>
 345           </row>
 346           <row>
 347             <entry />
 348             <entry>--close-window</entry>
 349             <entry>Close window</entry>
 350           </row>
 351           <row>
 352             <entry />
 353             <entry>--geometry=[&lt;w&gt;x&lt;h&gt;][+&lt;x&gt;+&lt;y&gt;]</entry>
 354             <entry>Set the &lt;width&gt; &lt;height&gt; &lt;xoffset&gt; &lt;yoffset&gt; of the window. The parameters are in pixels.</entry>
 355           </row>
 356           <row>
 357             <entry>-ct:clear|clean</entry>
 358             <entry>--cache-thumbs:clear|clean</entry>
 359             <entry>clear or clean thumbnail cache</entry>
 360           </row>
 361           <row>
 362             <entry>-cs:clear|clean</entry>
 363             <entry>--cache-shared:clear|clean</entry>
 364             <entry>clear or clean shared thumbnail cache</entry>
 365           </row>
 366           <row>
 367             <entry>-cm</entry>
 368             <entry>--cache-metadata</entry>
 369             <entry>clean the metadata cache</entry>
 370           </row>
 371           <row>
 372             <entry>-cr:&lt;folder&gt;</entry>
 373             <entry>--cache-render:&lt;folder&gt;</entry>
 374             <entry>render thumbnails</entry>
 375           </row>
 376           <row>
 377             <entry>-crr:&lt;folder&gt;</entry>
 378             <entry>--cache-render-recurse:&lt;folder&gt;</entry>
 379             <entry>render thumbnails recursively</entry>
 380           </row>
 381           <row>
 382             <entry>-crs:&lt;folder&gt;</entry>
 383             <entry>--cache-render-shared:&lt;folder&gt;</entry>
 384             <entry>
 385               render thumbnails
 386               <footnote id='ref2'>
 387                 <para>If standard thumbnail cache is not enabled, this command will be ignored.</para>
 388               </footnote>
 389             </entry>
 390           </row>
 391           <row>
 392             <entry>-crsr:&lt;folder&gt;</entry>
 393             <entry>--cache-render-shared-recurse:&lt;folder&gt;</entry>
 394             <entry>render thumbnails recursively</entry>
 395           </row>
 396           <row>
 397             <entry />
 398             <entry>--lua:&lt;file&gt;,&lt;lua script&gt;</entry>
 399             <entry>run lua script on file</entry>
 400           </row>
 401           <row>
 402             <entry />
 403             <entry>--PWD:&lt;PWD&gt;</entry>
 404             <entry>Use PWD as working directory for following commands</entry>
 405           </row>
 406           <row>
 407             <entry />
 408             <entry>--print0</entry>
 409             <entry>Terminate returned data with null character instead of newline</entry>
 410           </row>
 411         </tbody>
 412       </tgroup>
 413     </table>
 414     <para />
 415   </section>
 416 </section>