Update command line options documentation
[geeqie.git] / doc / docbook / GuideReferenceCommandLine.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideReferenceCommandLine">
3     <title>
4       Command Line Options
5     </title>
6     <para>
7       These are the command line options available to Geeqie:
8     </para>
9     <informaltable><tgroup cols="3"><tbody><row><entry>
10           Short Option
11         </entry><entry>
12           Long Option
13         </entry><entry>
14           Description
15         </entry></row>
16 <row><entry>
17           +t
18         </entry><entry>
19           --with-tools
20         </entry><entry>
21           Show file list, menu, and statusbar.
22         </entry></row>
23 <row><entry>
24           -t
25         </entry><entry>
26           --without-tools
27         </entry><entry>
28           Hide file list, menu, and statusbar. Window contains image only.
29         </entry></row>
30 <row><entry>
31           -f
32         </entry><entry>
33           --fullscreen
34         </entry><entry>
35           Start up in fullscreen.
36         </entry></row>
37 <row><entry>
38           -s
39         </entry><entry>
40           --slideshow
41         </entry><entry>
42           Start up in slideshow mode.
43         </entry></row>
44 <row><entry>
45           -l [filelist] [collectionlist]
46         </entry><entry>
47           --list [filelist] [collectionlist]
48         </entry><entry>
49           Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection.
50         </entry></row>
51 <row><entry/><entry>
52           --blank
53         </entry><entry>
54           Start with file list blank.
55         </entry></row>
56 <row><entry/><entry>
57           --geometry=&lt;w&gt;x&lt;h&gt;+&lt;x&gt;+&lt;y&gt;
58           </entry><entry>
59           Set the &lt;width&gt; &lt;height&gt; &lt;xoffset&gt; &lt;yoffset&gt; of the window. The parameters are in pixels.
60           </entry></row>
61 <row><entry>
62           -r
63         </entry><entry>
64           --remote
65         </entry><entry>
66           Send command line options to existing Geeqie process.
67         </entry></row>
68 <row><entry>
69           -rh
70         </entry><entry>
71           --remote-help
72         </entry><entry>
73           List command line options available to --remote.
74         </entry></row>
75 <row><entry>
76           -h
77         </entry><entry>
78           --help
79         </entry><entry>
80           Display brief command line option list.
81         </entry></row>
82 <row><entry>
83           -v
84         </entry><entry>
85           --version
86         </entry><entry>
87           Display version of Geeqie.
88         </entry></row>
89 <row><entry/><entry>
90           --debug[=&lt;level&gt;]
91         </entry><entry>
92           Turn on debugging output (when compiled with Debug enabled). &lt;level&gt; is 0 to 4.
93         </entry></row>
94 <row><entry/><entry>
95           --alternate
96         </entry><entry>
97           Use alternate similarity algorithm - experimental - requires re-compile.
98         </entry></row>
99 </tbody></tgroup></informaltable>
100     <para/><section id="Remotecommands"><title>
101       Remote commands
102     </title>
103     <para>
104       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:
105     </para>
106     <informaltable><tgroup cols="3"><tbody><row><entry>
107           Short Option
108         </entry><entry>
109           Long Option
110         </entry><entry>
111           Description
112         </entry></row>
113 <row><entry>
114           -n
115         </entry><entry>
116           --next
117         </entry><entry>
118           Change main window to display next image.
119         </entry></row>
120 <row><entry>
121           -b
122         </entry><entry>
123           --back
124         </entry><entry>
125           Change main window to display previous image.
126         </entry></row>
127 <row><entry/><entry>
128           --first
129         </entry><entry>
130           Change main window to display first image.
131         </entry></row>
132 <row><entry/><entry>
133           --last
134         </entry><entry>
135           Change main window to display last image.
136         </entry></row>
137 <row><entry>
138           -f
139         </entry><entry>
140           --fullscreen
141         </entry><entry>
142           Toggle full screen mode of the main window.
143         </entry></row>
144 <row><entry>
145           -fs
146         </entry><entry>
147           --fullscreen-start
148         </entry><entry>
149           Start full screen mode for main window.
150         </entry></row>
151 <row><entry>
152           -fS
153         </entry><entry>
154           --fullscreen-stop
155         </entry><entry>
156           Stop full screen mode for main window.
157         </entry></row>
158 <row><entry>
159           -s
160         </entry><entry>
161           --slideshow
162         </entry><entry>
163           Toggle slide show for main window.
164         </entry></row>
165 <row><entry>
166           -ss
167         </entry><entry>
168           --slideshow-start
169         </entry><entry>
170           Start slide show for main window.
171         </entry></row>
172 <row><entry>
173           -sS
174         </entry><entry>
175           --slideshow-stop
176         </entry><entry>
177           Stop slide show for main window.
178         </entry></row>
179 <row><entry/><entry>
180           --slideshow-recurse:&lt;folder&gt;
181         </entry><entry>
182           Start recursive slide show for &lt;folder&gt; in main window.
183         </entry></row>
184 <row><entry>
185           -d&lt;[n][.m]&gt;
186         </entry><entry>
187           --delay=&lt;[n][.m]&gt;
188         </entry><entry>
189           Set slide show delay to &lt;[n][.m]&gt; seconds, range is 0.1 to 3600
190         </entry></row>
191 <row><entry>
192           +t
193         </entry><entry>
194           --tools-show
195         </entry><entry>
196           Show tools for main window.
197         </entry></row>
198 <row><entry>
199           -t
200         </entry><entry>
201           --tools-hide
202         </entry><entry>
203           Hide tools for main window.
204         </entry></row>
205 <row><entry>
206           -q
207         </entry><entry>
208           --quit
209         </entry><entry>
210           Quit Geeqie.
211         </entry></row>
212 <row><entry/><entry>
213           --config-load:&lt;file&gt;
214         </entry><entry>
215           Load configuration from &lt;file&gt;.
216         </entry></row>
217 <row><entry/><entry>
218           --get-sidecars:&lt;file&gt;
219         </entry><entry>
220           Get list of sidecars of &lt;file&gt;.
221         </entry></row>
222 <row><entry/><entry>
223           --get-destination:&lt;file&gt;
224         </entry><entry>
225           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.
226         </entry></row>
227 <row><entry/><entry>
228           file:&lt;file&gt;
229         </entry><entry>
230           Change main window to display &lt;file&gt;
231         </entry></row>
232 <row><entry/><entry>
233           view:&lt;file&gt;
234         </entry><entry>
235           Open new window containing &lt;file&gt;
236         </entry></row>
237 <row><entry/><entry>
238           --list-clear
239         </entry><entry>
240           Clear command line collection list
241         </entry></row>
242 <row><entry/><entry>
243           --list-add:&lt;file&gt;
244         </entry><entry>
245           Add &lt;file&gt; to command line collection list
246         </entry></row>
247 <row><entry/><entry>
248           raise
249         </entry><entry>
250           Bring the geeqie window to the top
251         </entry></row>
252 </tbody></tgroup></informaltable>
253   <para/></section></section>