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