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