doc/docbook/GuideReferenceCommandLine.xml

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