da17bef3384f620857e707790340ef446e3006c2
[geeqie.git] / 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 />\r
81           <entry>--alternate</entry>\r
82           <entry>Use alternate similarity algorithm - experimental - requires re-compile.</entry>\r
83         </row>\r
84       </tbody>\r
85     </tgroup>\r
86   </table>\r
87   <para />\r
88   <section id="Remotecommands">\r
89     <title>Remote commands</title>\r
90     <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
91   <table frame="all">
92     <tgroup cols="3" rowsep="1" colsep="1">
93       <thead rowsep="1" colsep="1">\r
94 \r
95           <row>\r
96             <entry>Short Option</entry>\r
97             <entry>Long Option</entry>\r
98             <entry>Description</entry>\r
99           </row></thead>\r
100         <tbody>          <row>\r
101             <entry>-n</entry>\r
102             <entry>--next</entry>\r
103             <entry>Change main window to display next image.</entry>\r
104           </row>\r
105           <row>\r
106             <entry>-b</entry>\r
107             <entry>--back</entry>\r
108             <entry>Change main window to display previous image.</entry>\r
109           </row>\r
110           <row>\r
111             <entry />\r
112             <entry>--first</entry>\r
113             <entry>Change main window to display first image.</entry>\r
114           </row>\r
115           <row>\r
116             <entry />\r
117             <entry>--last</entry>\r
118             <entry>Change main window to display last image.</entry>\r
119           </row>\r
120           <row>\r
121             <entry>-f</entry>\r
122             <entry>--fullscreen</entry>\r
123             <entry>Toggle full screen mode of the main window.</entry>\r
124           </row>\r
125           <row>\r
126             <entry>-fs</entry>\r
127             <entry>--fullscreen-start</entry>\r
128             <entry>Start full screen mode for main window.</entry>\r
129           </row>\r
130           <row>\r
131             <entry>-fS</entry>\r
132             <entry>--fullscreen-stop</entry>\r
133             <entry>Stop full screen mode for main window.</entry>\r
134           </row>\r
135           <row>\r
136             <entry>-s</entry>\r
137             <entry>--slideshow</entry>\r
138             <entry>Toggle slide show for main window.</entry>\r
139           </row>\r
140           <row>\r
141             <entry>-ss</entry>\r
142             <entry>--slideshow-start</entry>\r
143             <entry>Start slide show for main window.</entry>\r
144           </row>\r
145           <row>\r
146             <entry>-sS</entry>\r
147             <entry>--slideshow-stop</entry>\r
148             <entry>Stop slide show for main window.</entry>\r
149           </row>\r
150           <row>\r
151             <entry />\r
152             <entry>--slideshow-recurse:&lt;folder&gt;</entry>\r
153             <entry>Start recursive slide show for &lt;folder&gt; in main window.</entry>\r
154           </row>\r
155           <row>\r
156             <entry>-d&lt;[n][.m]&gt;</entry>\r
157             <entry>--delay=&lt;[n][.m]&gt;</entry>\r
158             <entry>Set slide show delay to &lt;[n][.m]&gt; seconds, range is 0.1 to 3600</entry>\r
159           </row>\r
160           <row>\r
161             <entry>+t</entry>\r
162             <entry>--tools-show</entry>\r
163             <entry>Show tools for main window.</entry>\r
164           </row>\r
165           <row>\r
166             <entry>-t</entry>\r
167             <entry>--tools-hide</entry>\r
168             <entry>Hide tools for main window.</entry>\r
169           </row>\r
170           <row>\r
171             <entry>-q</entry>\r
172             <entry>--quit</entry>\r
173             <entry>Quit Geeqie.</entry>\r
174           </row>\r
175           <row>\r
176             <entry />\r
177             <entry>--config-load:&lt;file&gt;</entry>\r
178             <entry>Load configuration from &lt;file&gt;.</entry>\r
179           </row>\r
180           <row>\r
181             <entry />\r
182             <entry>--get-sidecars:&lt;file&gt;</entry>\r
183             <entry>Get list of sidecars of &lt;file&gt;.</entry>\r
184           </row>\r
185           <row>\r
186             <entry />\r
187             <entry>--get-destination:&lt;file&gt;</entry>\r
188             <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
189           </row>\r
190           <row>\r
191             <entry />\r
192             <entry>file:&lt;file&gt;</entry>\r
193             <entry>Change main window to display &lt;file&gt;</entry>\r
194           </row>\r
195           <row>\r
196             <entry />\r
197             <entry>--tell</entry>\r
198             <entry>Print filename of current image</entry>\r
199           </row>\r
200           <row>\r
201             <entry />\r
202             <entry>view:&lt;file&gt;</entry>\r
203             <entry>Open new window containing &lt;file&gt;</entry>\r
204           </row>\r
205           <row>\r
206             <entry />\r
207             <entry>--list-clear</entry>\r
208             <entry>Clear command line collection list</entry>\r
209           </row>\r
210           <row>\r
211             <entry />\r
212             <entry>--list-add:&lt;file&gt;</entry>\r
213             <entry>Add &lt;file&gt; to command line collection list</entry>\r
214           </row>\r
215           <row>\r
216             <entry />\r
217             <entry>raise</entry>\r
218             <entry>Bring the geeqie window to the top</entry>\r
219           </row>\r
220         </tbody>\r
221       </tgroup>\r
222     </table>\r
223     <para />\r
224   </section>\r
225 </section>