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>These are the command line options available to Geeqie:</para>\r
  12   <table frame="all">\r
  13     <tgroup cols="3" rowsep="1" colsep="1">\r
  14       <thead rowsep="1" colsep="1">\r
  15         <row>\r
  16           <entry>Short Option</entry>\r
  17           <entry>Long Option</entry>\r
  18           <entry>Description</entry>\r
  19         </row>\r
  20       </thead>\r
  21       <tbody rowsep="1" colsep="1">\r
  22         <row>\r
  23           <entry>+t</entry>\r
  24           <entry>--with-tools</entry>\r
  25           <entry>Show file list, menu, and statusbar.</entry>\r
  26         </row>\r
  27         <row>\r
  28           <entry>-t</entry>\r
  29           <entry>--without-tools</entry>\r
  30           <entry>Hide file list, menu, and statusbar. Window contains image only.</entry>\r
  31         </row>\r
  32         <row>\r
  33           <entry>-f</entry>\r
  34           <entry>--fullscreen</entry>\r
  35           <entry>Start up in fullscreen.</entry>\r
  36         </row>\r
  37         <row>\r
  38           <entry>-s</entry>\r
  39           <entry>--slideshow</entry>\r
  40           <entry>Start up in slideshow mode.</entry>\r
  41         </row>\r
  42         <row>\r
  43           <entry>-l [filelist] [collectionlist]</entry>\r
  44           <entry>--list [filelist] [collectionlist]</entry>\r
  45           <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
  46         </row>\r
  47         <row>\r
  48           <entry />\r
  49           <entry>--blank</entry>\r
  50           <entry>Start with file list blank.</entry>\r
  51         </row>\r
  52         <row>\r
  53           <entry />\r
  54           <entry>--geometry=&lt;w&gt;x&lt;h&gt;+&lt;x&gt;+&lt;y&gt;</entry>\r
  55           <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
  56         </row>\r
  57         <row>\r
  58           <entry>-r</entry>\r
  59           <entry>--remote</entry>\r
  60           <entry>Send command line options to existing Geeqie process.</entry>\r
  61         </row>\r
  62         <row>\r
  63           <entry>-rh</entry>\r
  64           <entry>--remote-help</entry>\r
  65           <entry>List command line options available to --remote.</entry>\r
  66         </row>\r
  67         <row>\r
  68           <entry>-h</entry>\r
  69           <entry>--help</entry>\r
  70           <entry>Display brief command line option list.</entry>\r
  71         </row>\r
  72         <row>\r
  73           <entry>-v</entry>\r
  74           <entry>--version</entry>\r
  75           <entry>Display version of Geeqie.</entry>\r
  76         </row>\r
  77         <row>\r
  78           <entry />\r
  79           <entry>--debug[=&lt;level&gt;]</entry>\r
  80           <entry>Turn on debugging output (when compiled with Debug enabled). &lt;level&gt; is 0 to 4.</entry>\r
  81         </row>\r
  82         <row>\r
  83           <entry>-g:&lt;regexp&gt;</entry>\r
  84           <entry>--grep:&lt;regexp&gt;</entry>\r
  85           <entry>Filter debug output with regular expression</entry>\r
  86         </row>\r
  87         <row>\r
  88           <entry>+w</entry>\r
  89           <entry>--show-log-window</entry>\r
  90           <entry>Display log window</entry>\r
  91         </row>\r
  92         <row>\r
  93           <entry>-o:&lt;file&gt;</entry>\r
  94           <entry>--log-file:&lt;file&gt;</entry>\r
  95           <entry>Save log data to file</entry>\r
  96         </row>\r
  97         <row>\r
  98           <entry />\r
  99           <entry>--alternate</entry>\r
 100           <entry>Use alternate similarity algorithm - experimental - requires re-compile.</entry>\r
 101         </row>\r
 102       </tbody>\r
 103     </tgroup>\r
 104   </table>\r
 105   <para />\r
 106   <section id="Remotecommands">\r
 107     <title>Remote commands</title>\r
 108     <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
 109     <table frame="all">\r
 110       <tgroup cols="3" rowsep="1" colsep="1">\r
 111         <thead rowsep="1" colsep="1">\r
 112           <row>\r
 113             <entry>Short Option</entry>\r
 114             <entry>Long Option</entry>\r
 115             <entry>Description</entry>\r
 116           </row>\r
 117         </thead>\r
 118         <tbody>\r
 119           <row>\r
 120             <entry>-n</entry>\r
 121             <entry>--next</entry>\r
 122             <entry>Change main window to display next image.</entry>\r
 123           </row>\r
 124           <row>\r
 125             <entry>-b</entry>\r
 126             <entry>--back</entry>\r
 127             <entry>Change main window to display previous image.</entry>\r
 128           </row>\r
 129           <row>\r
 130             <entry />\r
 131             <entry>--first</entry>\r
 132             <entry>Change main window to display first image.</entry>\r
 133           </row>\r
 134           <row>\r
 135             <entry />\r
 136             <entry>--last</entry>\r
 137             <entry>Change main window to display last image.</entry>\r
 138           </row>\r
 139           <row>\r
 140             <entry>-f</entry>\r
 141             <entry>--fullscreen</entry>\r
 142             <entry>Toggle full screen mode of the main window.</entry>\r
 143           </row>\r
 144           <row>\r
 145             <entry>-fs</entry>\r
 146             <entry>--fullscreen-start</entry>\r
 147             <entry>Start full screen mode for main window.</entry>\r
 148           </row>\r
 149           <row>\r
 150             <entry>-fS</entry>\r
 151             <entry>--fullscreen-stop</entry>\r
 152             <entry>Stop full screen mode for main window.</entry>\r
 153           </row>\r
 154           <row>\r
 155             <entry>-s</entry>\r
 156             <entry>--slideshow</entry>\r
 157             <entry>Toggle slide show for main window.</entry>\r
 158           </row>\r
 159           <row>\r
 160             <entry>-ss</entry>\r
 161             <entry>--slideshow-start</entry>\r
 162             <entry>Start slide show for main window.</entry>\r
 163           </row>\r
 164           <row>\r
 165             <entry>-sS</entry>\r
 166             <entry>--slideshow-stop</entry>\r
 167             <entry>Stop slide show for main window.</entry>\r
 168           </row>\r
 169           <row>\r
 170             <entry />\r
 171             <entry>--slideshow-recurse:&lt;folder&gt;</entry>\r
 172             <entry>Start recursive slide show for &lt;folder&gt; in main window.</entry>\r
 173           </row>\r
 174           <row>\r
 175             <entry>-d&lt;[h:][m:][n][.m]&gt;</entry>\r
 176             <entry>--delay=&lt;[h:][m:][n][.m]&gt;</entry>\r
 177             <entry>Set slide show delay to &lt;[hrs:][mins:][n][.m]&gt; seconds, range is 0.1 secs to 24 hours</entry>\r
 178           </row>\r
 179           <row>\r
 180             <entry>+t</entry>\r
 181             <entry>--tools-show</entry>\r
 182             <entry>Show tools for main window.</entry>\r
 183           </row>\r
 184           <row>\r
 185             <entry>-t</entry>\r
 186             <entry>--tools-hide</entry>\r
 187             <entry>Hide tools for main window.</entry>\r
 188           </row>\r
 189           <row>\r
 190             <entry>-q</entry>\r
 191             <entry>--quit</entry>\r
 192             <entry>Quit Geeqie.</entry>\r
 193           </row>\r
 194           <row>\r
 195             <entry />\r
 196             <entry>--config-load:&lt;file&gt;</entry>\r
 197             <entry>Load configuration from &lt;file&gt;.</entry>\r
 198           </row>\r
 199           <row>\r
 200             <entry />\r
 201             <entry>--get-sidecars:&lt;file&gt;</entry>\r
 202             <entry>Get list of sidecars of &lt;file&gt;.</entry>\r
 203           </row>\r
 204           <row>\r
 205             <entry />\r
 206             <entry>--get-destination:&lt;file&gt;</entry>\r
 207             <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
 208           </row>\r
 209           <row>\r
 210             <entry />\r
 211             <entry>file:&lt;file&gt;</entry>\r
 212             <entry>Open  &lt;file&gt; and bring Geeqie window to the top</entry>\r
 213           </row>\r
 214           <row>\r
 215             <entry />\r
 216             <entry>File:&lt;file&gt;</entry>\r
 217             <entry>Open  &lt;file&gt; and do not bring Geeqie window to the top</entry>\r
 218           </row>\r
 219           <row>\r
 220             <entry />\r
 221             <entry>--tell</entry>\r
 222             <entry>Print filename of current image</entry>\r
 223           </row>\r
 224           <row>\r
 225             <entry />\r
 226             <entry>view:&lt;file&gt;</entry>\r
 227             <entry>Open new window containing &lt;file&gt;</entry>\r
 228           </row>\r
 229           <row>\r
 230             <entry />\r
 231             <entry>--list-clear</entry>\r
 232             <entry>Clear command line collection list</entry>\r
 233           </row>\r
 234           <row>\r
 235             <entry />\r
 236             <entry>--list-add:&lt;file&gt;</entry>\r
 237             <entry>Add &lt;file&gt; to command line collection list</entry>\r
 238           </row>\r
 239           <row>\r
 240             <entry />\r
 241             <entry>raise</entry>\r
 242             <entry>Bring the geeqie window to the top</entry>\r
 243           </row>\r
 244           <row>\r
 245             <entry>-ct:clear|clean</entry>\r
 246             <entry>--cache-thumbs:clear|clean</entry>\r
 247             <entry>clear or clean thumbnail cache</entry>\r
 248           </row>\r
 249           <row>\r
 250             <entry>-cs:clear|clean</entry>\r
 251             <entry>--cache-shared:clear|clean</entry>\r
 252             <entry>clear or clean shared thumbnail cache</entry>\r
 253           </row>\r
 254           <row>\r
 255             <entry>-cm</entry>\r
 256             <entry>--cache-metadata</entry>\r
 257             <entry>clean the metadata cache</entry>\r
 258           </row>\r
 259           <row>\r
 260             <entry>-cr:&lt;folder&gt;</entry>\r
 261             <entry>--cache-render:&lt;folder&gt;</entry>\r
 262             <entry>render thumbnails</entry>\r
 263           </row>\r
 264           <row>\r
 265             <entry>-crr:&lt;folder&gt;</entry>\r
 266             <entry>--cache-render-recurse:&lt;folder&gt;</entry>\r
 267             <entry>render thumbnails recursively</entry>\r
 268           </row>\r
 269           <row>\r
 270             <entry>-crs:&lt;folder&gt;</entry>\r
 271             <entry>--cache-render-shared:&lt;folder&gt;</entry>\r
 272             <entry>\r
 273               render thumbnails\r
 274               <footnote id='ref2'>\r
 275                 <para>If standard thumbnail cache is not enabled, this command will be ignored.</para>\r
 276               </footnote>\r
 277             </entry>\r
 278           </row>\r
 279           <row>\r
 280             <entry>-crsr:&lt;folder&gt;</entry>\r
 281             <entry>--cache-render-shared-recurse:&lt;folder&gt;</entry>\r
 282             <entry>render thumbnails recursively</entry>\r
 283           </row>\r
 284           <row>\r
 285             <entry />\r
 286             <entry>--lua:&lt;file&gt;,&lt;lua script&gt;</entry>\r
 287             <entry>run lua script on file</entry>\r
 288           </row>\r
 289         </tbody>\r
 290       </tgroup>\r
 291     </table>\r
 292     <para />\r
 293   </section>\r
 294 </section>\r