1 <?xml version="1.0" encoding="utf-8"?>
\r
2 <section id="GuideReferenceCommandLine">
\r
3 <title>Command Line Options</title>
\r
5 Geeqie is called by the command:
\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
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
14 <tgroup cols="3" rowsep="1" colsep="1">
\r
15 <thead rowsep="1" colsep="1">
\r
17 <entry>Short Option</entry>
\r
18 <entry>Long Option</entry>
\r
19 <entry>Description</entry>
\r
22 <tbody rowsep="1" colsep="1">
\r
25 <entry>--with-tools</entry>
\r
26 <entry>Show file list, menu, and statusbar.</entry>
\r
30 <entry>--without-tools</entry>
\r
31 <entry>Hide file list, menu, and statusbar. Window contains image only.</entry>
\r
35 <entry>--fullscreen</entry>
\r
36 <entry>Start up in fullscreen.</entry>
\r
40 <entry>--slideshow</entry>
\r
41 <entry>Start up in slideshow mode.</entry>
\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
50 <entry>--blank</entry>
\r
51 <entry>Start with file list blank.</entry>
\r
55 <entry>--geometry=<w>x<h>+<x>+<y></entry>
\r
56 <entry>Set the <width> <height> <xoffset> <yoffset> of the window. The parameters are in pixels.</entry>
\r
60 <entry>--new-instance</entry>
\r
61 <entry>Open a new instance of Geeqie.</entry>
\r
65 <entry>--remote</entry>
\r
66 <entry>Send command line options to existing Geeqie process.</entry>
\r
70 <entry>--remote-help</entry>
\r
71 <entry>List command line options available to --remote.</entry>
\r
75 <entry>--help</entry>
\r
76 <entry>Display brief command line option list.</entry>
\r
80 <entry>--version</entry>
\r
81 <entry>Display version of Geeqie.</entry>
\r
85 <entry>--debug[=<level>]</entry>
\r
86 <entry>Turn on debugging output (when compiled with Debug enabled). <level> is 0 to 4.</entry>
\r
89 <entry>-g:<regexp></entry>
\r
90 <entry>--grep:<regexp></entry>
\r
91 <entry>Filter debug output with regular expression</entry>
\r
95 <entry>--show-log-window</entry>
\r
96 <entry>Display log window</entry>
\r
99 <entry>-o:<file></entry>
\r
100 <entry>--log-file:<file></entry>
\r
101 <entry>Save log data to file</entry>
\r
105 <entry>--alternate</entry>
\r
106 <entry>Use alternate similarity algorithm - experimental - requires re-compile.</entry>
\r
112 <section id="Remotecommands">
\r
113 <title>Remote commands</title>
\r
114 <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
115 <table frame="all">
\r
116 <tgroup cols="3" rowsep="1" colsep="1">
\r
117 <thead rowsep="1" colsep="1">
\r
119 <entry>Short Option</entry>
\r
120 <entry>Long Option</entry>
\r
121 <entry>Description</entry>
\r
127 <entry>--next</entry>
\r
128 <entry>Change main window to display next image.</entry>
\r
132 <entry>--back</entry>
\r
133 <entry>Change main window to display previous image.</entry>
\r
137 <entry>--first</entry>
\r
138 <entry>Change main window to display first image.</entry>
\r
142 <entry>--last</entry>
\r
143 <entry>Change main window to display last image.</entry>
\r
147 <entry>--fullscreen</entry>
\r
148 <entry>Toggle full screen mode of the main window.</entry>
\r
152 <entry>--fullscreen-start</entry>
\r
153 <entry>Start full screen mode for main window.</entry>
\r
157 <entry>--fullscreen-stop</entry>
\r
158 <entry>Stop full screen mode for main window.</entry>
\r
162 <entry>--slideshow</entry>
\r
163 <entry>Toggle slide show for main window.</entry>
\r
167 <entry>--slideshow-start</entry>
\r
168 <entry>Start slide show for main window.</entry>
\r
172 <entry>--slideshow-stop</entry>
\r
173 <entry>Stop slide show for main window.</entry>
\r
177 <entry>--slideshow-recurse:<folder></entry>
\r
178 <entry>Start recursive slide show for <folder> in main window.</entry>
\r
181 <entry>-d<[h:][m:][n][.m]></entry>
\r
182 <entry>--delay=<[h:][m:][n][.m]></entry>
\r
183 <entry>Set slide show delay to <[hrs:][mins:][n][.m]> seconds, range is 0.1 secs to 24 hours</entry>
\r
187 <entry>--tools-show</entry>
\r
188 <entry>Show tools for main window.</entry>
\r
192 <entry>--tools-hide</entry>
\r
193 <entry>Hide tools for main window.</entry>
\r
197 <entry>--quit</entry>
\r
198 <entry>Quit Geeqie.</entry>
\r
202 <entry>--config-load:<file>|layout ID</entry>
\r
203 <entry>Load configuration from <file>. Use either a full path, or a saved window layout ID.</entry>
\r
207 <entry>--get-sidecars:<file></entry>
\r
208 <entry>Get list of sidecars of <file>.</entry>
\r
212 <entry>--get-destination:<file></entry>
\r
213 <entry>Get destination path of <file>. This is used by the symlink desktop file to implement the symbolic link operation. There is no useful function for the user.</entry>
\r
217 <entry>file:<file>|<URL></entry>
\r
218 <entry>Open <file> or <URL> and bring Geeqie window to the top</entry>
\r
222 <entry>--file:<file>|<URL></entry>
\r
223 <entry>Open <file> or <URL> and bring Geeqie window to the top</entry>
\r
227 <entry>File:<file>|<URL></entry>
\r
228 <entry>Open <file> or <URL> and do not bring Geeqie window to the top</entry>
\r
232 <entry>--File:<file>|<URL></entry>
\r
233 <entry>Open <file> or <URL> and do not bring Geeqie window to the top</entry>
\r
237 <entry>--tell</entry>
\r
238 <entry>Print filename [and Collection] of current image</entry>
\r
242 <entry>--pixel-info</entry>
\r
243 <entry>Print X, Y and RGB of mouse pointer on current image</entry>
\r
247 <entry>--get-rectangle</entry>
\r
248 <entry>Get rectangle coordinates</entry>
\r
252 <entry>--get-render-intent</entry>
\r
253 <entry>Get render intent</entry>
\r
257 <entry>--get-filelist:[<FOLDER>]</entry>
\r
258 <entry>Get list of files and class</entry>
\r
262 <entry>--get-filelist-recurse:[<FOLDER>]</entry>
\r
263 <entry>Get list of files and class recursive</entry>
\r
267 <entry>--get-collection:<COLLECTION></entry>
\r
268 <entry>Get collection content</entry>
\r
272 <entry>--get-collection-list</entry>
\r
273 <entry>Get collection list</entry>
\r
277 <entry>--get-file-info</entry>
\r
280 <footnote id='fileinfo'>
\r
281 <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 <entry>view:<file></entry>
\r
288 <entry>Open new window containing <file></entry>
\r
292 <entry>--view:<file></entry>
\r
293 <entry>Open new window containing <file></entry>
\r
297 <entry>--list-clear</entry>
\r
298 <entry>Clear command line collection list</entry>
\r
302 <entry>--list-add:<file></entry>
\r
303 <entry>Add <file> to command line collection list</entry>
\r
307 <entry>raise</entry>
\r
308 <entry>Bring the geeqie window to the top</entry>
\r
312 <entry>--raise</entry>
\r
313 <entry>Bring the geeqie window to the top</entry>
\r
317 <entry>--id:<ID></entry>
\r
319 Window ID for following commands
\r
320 <footnote id='ref3'>
\r
321 <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 <entry>--new-window</entry>
\r
328 <entry>Open new window</entry>
\r
332 <entry>--close-window</entry>
\r
333 <entry>Close window</entry>
\r
337 <entry>--geometry=<w>x<h>+<x>+<y></entry>
\r
338 <entry>Set the <width> <height> <xoffset> <yoffset> of the window. The parameters are in pixels.</entry>
\r
341 <entry>-ct:clear|clean</entry>
\r
342 <entry>--cache-thumbs:clear|clean</entry>
\r
343 <entry>clear or clean thumbnail cache</entry>
\r
346 <entry>-cs:clear|clean</entry>
\r
347 <entry>--cache-shared:clear|clean</entry>
\r
348 <entry>clear or clean shared thumbnail cache</entry>
\r
352 <entry>--cache-metadata</entry>
\r
353 <entry>clean the metadata cache</entry>
\r
356 <entry>-cr:<folder></entry>
\r
357 <entry>--cache-render:<folder></entry>
\r
358 <entry>render thumbnails</entry>
\r
361 <entry>-crr:<folder></entry>
\r
362 <entry>--cache-render-recurse:<folder></entry>
\r
363 <entry>render thumbnails recursively</entry>
\r
366 <entry>-crs:<folder></entry>
\r
367 <entry>--cache-render-shared:<folder></entry>
\r
370 <footnote id='ref2'>
\r
371 <para>If standard thumbnail cache is not enabled, this command will be ignored.</para>
\r
376 <entry>-crsr:<folder></entry>
\r
377 <entry>--cache-render-shared-recurse:<folder></entry>
\r
378 <entry>render thumbnails recursively</entry>
\r
382 <entry>--lua:<file>,<lua script></entry>
\r
383 <entry>run lua script on file</entry>
\r
387 <entry>--PWD:<PWD></entry>
\r
388 <entry>Use PWD as working directory for following commands</entry>
\r
392 <entry>--print0</entry>
\r
393 <entry>Terminate returned data with null character instead of newline</entry>
\r