scripts for converting wiki documentation to docbook
[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
46         </entry><entry>
47           --list
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>
52           -r
53         </entry><entry>
54           --remote
55         </entry><entry>
56           Send command line options to existing Geeqie process.
57         </entry></row>
58 <row><entry>
59           -rh
60         </entry><entry>
61           --remote-help
62         </entry><entry>
63           List command line options available to --remote.
64         </entry></row>
65 <row><entry>
66           -h
67         </entry><entry>
68           --help
69         </entry><entry>
70           Display brief command line option list.
71         </entry></row>
72 <row><entry>
73           -v
74         </entry><entry>
75           --version
76         </entry><entry>
77           Display version of Geeqie.
78         </entry></row>
79 <row><entry/><entry>
80           --debug
81         </entry><entry>
82           Enable Debug output to console.
83         </entry></row>
84 </tbody></tgroup></informaltable>
85     <para/><section id="Remotecommands"><title>
86       Remote commands
87     </title>
88     <para>
89       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:
90     </para>
91     <informaltable><tgroup cols="3"><tbody><row><entry>
92           Short Option
93         </entry><entry>
94           Long Option
95         </entry><entry>
96           Description
97         </entry></row>
98 <row><entry>
99           -n
100         </entry><entry>
101           --next
102         </entry><entry>
103           Change main window to display next image.
104         </entry></row>
105 <row><entry>
106           -b
107         </entry><entry>
108           --back
109         </entry><entry>
110           Change main window to display previous image.
111         </entry></row>
112 <row><entry/><entry>
113           --first
114         </entry><entry>
115           Change main window to display first image.
116         </entry></row>
117 <row><entry/><entry>
118           --last
119         </entry><entry>
120           Change main window to display last image.
121         </entry></row>
122 <row><entry>
123           -f
124         </entry><entry>
125           --fullscreen
126         </entry><entry>
127           Toggle full screen mode of the main window.
128         </entry></row>
129 <row><entry>
130           -fs
131         </entry><entry>
132           --fullscreen-start
133         </entry><entry>
134           Start full screen mode for main window.
135         </entry></row>
136 <row><entry>
137           -fS
138         </entry><entry>
139           --fullscreen-stop
140         </entry><entry>
141           Stop full screen mode for main window.
142         </entry></row>
143 <row><entry>
144           -s
145         </entry><entry>
146           --slideshow
147         </entry><entry>
148           Toggle slide show for main window.
149         </entry></row>
150 <row><entry>
151           -ss
152         </entry><entry>
153           --slideshow-start
154         </entry><entry>
155           Start slide show for main window.
156         </entry></row>
157 <row><entry>
158           -sS
159         </entry><entry>
160           --slideshow-stop
161         </entry><entry>
162           Stop slide show for main window.
163         </entry></row>
164 <row><entry>
165           -sr&amp;lt;folder&amp;gt;
166         </entry><entry>
167           --slideshow-recurse&amp;lt;folder&amp;gt;
168         </entry><entry>
169           Start recursive slide show for &amp;lt;folder&amp;gt; in main window.
170         </entry></row>
171 <row><entry>
172           -d&amp;lt;n&amp;gt;
173         </entry><entry>
174           --delay=&amp;lt;n&amp;gt;
175         </entry><entry>
176           Set slide show delay to &amp;lt;n&amp;gt; seconds, range is 0.1 to 3600
177         </entry></row>
178 <row><entry>
179           +t
180         </entry><entry>
181           --tools-show
182         </entry><entry>
183           Show tools for main window.
184         </entry></row>
185 <row><entry>
186           -t
187         </entry><entry>
188           --tools-hide
189         </entry><entry>
190           Hide tools for main window.
191         </entry></row>
192 <row><entry>
193           -q
194         </entry><entry>
195           --quit
196         </entry><entry>
197           Quit Geeqie.
198         </entry></row>
199 <row><entry/><entry>
200           file:&amp;lt;filename&amp;gt;
201         </entry><entry>
202           Change main window to display &amp;lt;filename&amp;gt;
203         </entry></row>
204 <row><entry/><entry>
205           view:&amp;lt;filename&amp;gt;
206         </entry><entry>
207           Open new window containing &amp;lt;filename&amp;gt;
208         </entry></row>
209 </tbody></tgroup></informaltable>
210   <para/></section></section>