Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 318 lines (317 sloc) 6.083 kb
d3da0eb @muennich Added man page
authored
1 .TH SXIV 1 sxiv\-VERSION
2 .SH NAME
3 sxiv \- Simple (or small or suckless) X Image Viewer
4 .SH SYNOPSIS
5 .B sxiv
ecd5e71 @muennich Renamed option -C -> -c
authored
6 .RB [ \-cdFfhpqrstvZ ]
f0e9ec7 @muennich Replaced option -W with -q, seems more natural
authored
7 .RB [ \-g
8 .IR GEOMETRY ]
2252a01 @muennich New option: -n, start at given picture
authored
9 .RB [ \-n
10 .IR NUM ]
8123d63 @muennich Added plenty lots of options
authored
11 .RB [ \-z
12 .IR ZOOM ]
d2f9fb8 @muennich More standardish usage info in man page
authored
13 .IR FILE ...
d3da0eb @muennich Added man page
authored
14 .SH DESCRIPTION
15 sxiv is a simple image viewer for X. It only has the most basic features
16 required for fast image viewing.
17 .P
788db66 @muennich Updated man page
authored
18 sxiv opens all named
19 .IR FILE s,
20 or reads the names of the files to open from standard input, if only a single
21 hyphen\-minus
22 .RB ( \- )
23 is given.
24 .P
280fcf6 @muennich Updated doc
authored
25 sxiv has two modes of operation: image and thumbnail mode. The default is image
26 mode, in which only the current image is shown. In thumbnail mode a grid of
27 small previews is displayed, making it easy to choose an image to open.
28 .P
bb85d3d @muennich Updated doc for thumbnail cache
authored
29 sxiv can also cache its thumbnails. Please see the section THUMBNAIL CACHING
30 for information on how to enable this feature.
31 .P
d3da0eb @muennich Added man page
authored
32 Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
33 manager.
34 .SH OPTIONS
35 .TP
ecd5e71 @muennich Renamed option -C -> -c
authored
36 .B \-c
bb85d3d @muennich Updated doc for thumbnail cache
authored
37 Remove all orphaned cache files from the thumbnail cache directory and exit.
38 .TP
8123d63 @muennich Added plenty lots of options
authored
39 .B \-d
40 Scale all images to 100%, but fit large images into window.
41 .TP
5607349 @muennich Updated doc
authored
42 .B \-F
43 Make the window fixed/floating by setting the minimum and maximum width/height
44 size-hints to the window width/height.
45 .TP
8123d63 @muennich Added plenty lots of options
authored
46 .B \-f
47 Start in fullscreen mode.
48 .TP
3d8efb2 @muennich Updated doc: dragging with button2, -g option
authored
49 .BI "\-g " GEOMETRY
50 Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
51 more information on
52 .IR GEOMETRY .
53 .TP
2252a01 @muennich New option: -n, start at given picture
authored
54 .BI "\-n " NUM
55 Start at picture number NUM.
56 .TP
d3da0eb @muennich Added man page
authored
57 .B \-h
58 Print brief usage information to standard output and exit.
59 .TP
8123d63 @muennich Added plenty lots of options
authored
60 .B \-p
61 Pixelize images, i.e. turn off anti-aliasing.
62 .TP
f0e9ec7 @muennich Replaced option -W with -q, seems more natural
authored
63 .B \-q
64 Be quiet, disable warnings to standard error stream.
65 .TP
bbd7b7d @muennich New option: -r, open all images in directories
authored
66 .B \-r
67 Search the given directories recursively for images to view.
68 .TP
8123d63 @muennich Added plenty lots of options
authored
69 .B \-s
70 Scale all images to fit into window.
71 .TP
280fcf6 @muennich Updated doc
authored
72 .B \-t
73 Start in thumbnail mode.
74 .TP
d3da0eb @muennich Added man page
authored
75 .B \-v
76 Print version information to standard output and exit.
17e2a79 @muennich Added -w cmdline option
authored
77 .TP
8123d63 @muennich Added plenty lots of options
authored
78 .B \-Z
5c77e1a @muennich Fixed hyphen-used-as-minus-sign issues in man page
authored
79 The same as `\-z 100'.
8123d63 @muennich Added plenty lots of options
authored
80 .TP
81 .BI "\-z " ZOOM
82 Scale all images to the current zoom level, use a zoom level of
83 .I ZOOM
84 at startup.
55da6fb @muennich Updated doc
authored
85 .SH GENERAL KEYBOARD COMMANDS
86 The following keyboard commands are available in both image and thumbnail mode:
d3da0eb @muennich Added man page
authored
87 .TP
88 .B q
89 Quit sxiv.
90 .TP
280fcf6 @muennich Updated doc
authored
91 .B Return
55da6fb @muennich Updated doc
authored
92 Switch to thumbnail mode / open selected image in image mode.
d3da0eb @muennich Added man page
authored
93 .TP
55da6fb @muennich Updated doc
authored
94 .BR 0 \- 9
95 Prefix the next command with a number (denoted via
96 .IR count ).
d3da0eb @muennich Added man page
authored
97 .TP
98 .B g
55da6fb @muennich Updated doc
authored
99 Go to the first image.
d3da0eb @muennich Added man page
authored
100 .TP
101 .B G
55da6fb @muennich Updated doc
authored
102 Go to the last image, or image number
103 .IR count .
104 .TP
105 .B f
106 Toggle fullscreen mode.
107 .TP
108 .B A
109 Toggle visibility of alpha-channel, i.e. image transparency.
110 .TP
111 .B r
112 Reload image.
113 .TP
114 .B D
115 Remove current image from file list and go to next image.
116 .SH THUMBNAIL KEYBOARD COMMANDS
117 The following keyboard commands are only available in thumbnail mode:
118 .TP
119 .BR h ", " Left
120 Move selection left.
121 .TP
122 .BR j ", " Down
123 Move selection down.
124 .TP
125 .BR k ", " Up
126 Move selection up.
127 .TP
128 .BR l ", " Right
129 Move selection right.
1cdbeb9 @muennich Added screen-wise scrolling for thumbnail mode
authored
130 .TP
131 .BR Ctrl-j ", " Ctrl-Down
132 Scroll thumbnail grid one window height down.
133 .TP
134 .BR Ctrl-k ", " Ctrl-Up
135 Scroll thumbnail grid one window height up.
55da6fb @muennich Updated doc
authored
136 .SH IMAGE KEYBOARD COMMANDS
137 The following keyboard commands are only available in image mode:
138 .SS Navigate image list
139 .TP
140 .BR n ", " Space
141 Go
142 .I count
143 images forward.
144 .TP
145 .BR p ", " Backspace
146 Go
147 .I count
148 images backward.
d3da0eb @muennich Added man page
authored
149 .TP
150 .B [
55da6fb @muennich Updated doc
authored
151 Go
152 .I count
153 * 10 images backward.
d3da0eb @muennich Added man page
authored
154 .TP
155 .B ]
55da6fb @muennich Updated doc
authored
156 Go
157 .I count
158 * 10 images forward.
e2ea759 @muennich Updated docs
authored
159 .SS Handle multi-frame images
160 .TP
161 .B Ctrl-n
162 Go to the next frame of a multi-frame image.
163 .TP
164 .B Ctrl-p
165 Go to the previous frame of a multi-frame image.
166 .TP
167 .B Ctrl-Space
168 Play/pause animation of a multi-frame image.
d3da0eb @muennich Added man page
authored
169 .SS Zooming
170 .TP
55da6fb @muennich Updated doc
authored
171 .BR +
d3da0eb @muennich Added man page
authored
172 Zoom in.
173 .TP
174 .B \-
175 Zoom out.
f57954b @muennich Updated doc, 0/W/w key-mappings
authored
176 .TP
55da6fb @muennich Updated doc
authored
177 .B =
178 Set zoom level to 100%, or
179 .IR count %.
f57954b @muennich Updated doc, 0/W/w key-mappings
authored
180 .TP
181 .B w
182 Set zoom level to fit image into window.
55da6fb @muennich Updated doc
authored
183 .SS Panning
d3da0eb @muennich Added man page
authored
184 .TP
019e227 @muennich Map arrow keys to h/j/k/l
authored
185 .BR h ", " Left
55da6fb @muennich Updated doc
authored
186 Pan image 1/5 of window width or
187 .I count
188 pixel left.
d3da0eb @muennich Added man page
authored
189 .TP
019e227 @muennich Map arrow keys to h/j/k/l
authored
190 .BR j ", " Down
55da6fb @muennich Updated doc
authored
191 Pan image 1/5 of window height or
192 .I count
193 pixel down.
d3da0eb @muennich Added man page
authored
194 .TP
019e227 @muennich Map arrow keys to h/j/k/l
authored
195 .BR k ", " Up
55da6fb @muennich Updated doc
authored
196 Pan image 1/5 of window height or
197 .I count
198 pixel up.
d3da0eb @muennich Added man page
authored
199 .TP
019e227 @muennich Map arrow keys to h/j/k/l
authored
200 .BR l ", " Right
55da6fb @muennich Updated doc
authored
201 Pan image 1/5 of window width or
202 .I count
203 pixel right.
65a2c86 @muennich Updated doc
authored
204 .TP
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
205 .B H
65a2c86 @muennich Updated doc
authored
206 Pan to left image edge.
207 .TP
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
208 .B J
65a2c86 @muennich Updated doc
authored
209 Pan to bottom image edge.
210 .TP
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
211 .B K
65a2c86 @muennich Updated doc
authored
212 Pan to top image edge.
213 .TP
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
214 .B L
65a2c86 @muennich Updated doc
authored
215 Pan to right image edge.
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
216 .TP
2a3a965 @muennich Fixed keyboard mappings
authored
217 .BR Ctrl-h ", " Ctrl-Left
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
218 Pan image one window width left.
219 .TP
2a3a965 @muennich Fixed keyboard mappings
authored
220 .BR Ctrl-j ", " Ctrl-Down
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
221 Pan image one window height down.
222 .TP
2a3a965 @muennich Fixed keyboard mappings
authored
223 .BR Ctrl-k ", " Ctrl-Up
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
224 Pan image one window height up.
225 .TP
2a3a965 @muennich Fixed keyboard mappings
authored
226 .BR Ctrl-l ", " Ctrl-Right
a610037 @muennich New mappings: ctrl-[hjkl], pan image one window width/height
authored
227 Pan image one window width right.
64a5366 @muennich Added <,> mappings to rotate image
authored
228 .SS Rotation
229 .TP
230 .B <
231 Rotate image counter-clockwise by 90 degrees.
232 .TP
233 .B >
234 Rotate image clockwise by 90 degrees.
55da6fb @muennich Updated doc
authored
235 .SS Slideshow
d3da0eb @muennich Added man page
authored
236 .TP
55da6fb @muennich Updated doc
authored
237 .B s
238 Toggle slideshow.
f57954b @muennich Updated doc, 0/W/w key-mappings
authored
239 .TP
55da6fb @muennich Updated doc
authored
240 .B Ctrl\-'\-'
241 Decrease slideshow delay.
242 .TP
243 .B Ctrl-'+'
244 Increase slideshow delay.
245 .TP
246 .B Ctrl-'='
247 Reset slideshow delay to default value, or set it to
248 .I count
249 seconds.
7834dee @muennich Added a key-mapping for toggle anti-aliasing
authored
250 .SS Miscellaneous
251 .TP
252 .B a
253 Toggle anti-aliasing.
5a68242 @muennich New key command: r, reload image
authored
254 .TP
55da6fb @muennich Updated doc
authored
255 .B W
256 Resize window to fit image.
f47092c @muennich Complete mouse support
authored
257 .SH MOUSE COMMANDS
55da6fb @muennich Updated doc
authored
258 The following mouse mappings are available in image mode:
f47092c @muennich Complete mouse support
authored
259 .SS Navigate image list
260 .TP
261 .B Button1
55da6fb @muennich Updated doc
authored
262 Go to next image.
3d8efb2 @muennich Updated doc: dragging with button2, -g option
authored
263 .TP
f47092c @muennich Complete mouse support
authored
264 .B Button3
265 Go to the previous image.
266 .SS Zooming
267 .TP
268 .B Ctrl+ScrollUp
269 Zoom in.
270 .TP
271 .B Ctrl+ScrollDown
272 Zoom out.
280fcf6 @muennich Updated doc
authored
273 .SS Panning/Moving
274 .TP
275 .B Button2
276 Drag the image with the mouse while keeping this button pressed down.
f47092c @muennich Complete mouse support
authored
277 .TP
278 .B ScrollUp
55da6fb @muennich Updated doc
authored
279 Pan image up.
f47092c @muennich Complete mouse support
authored
280 .TP
281 .B ScrollDown
55da6fb @muennich Updated doc
authored
282 Pan image down.
f47092c @muennich Complete mouse support
authored
283 .TP
284 .B Shift+ScrollUp
280fcf6 @muennich Updated doc
authored
285 Pan image left.
f47092c @muennich Complete mouse support
authored
286 .TP
287 .B Shift+ScrollDown
280fcf6 @muennich Updated doc
authored
288 Pan image right.
bb85d3d @muennich Updated doc for thumbnail cache
authored
289 .SH THUMBNAIL CACHING
290 To enable thumbnail caching, please make sure to create the directory
291 .I ~/.sxiv/
292 with write permissions. sxiv will then store all thumbnails inside this
293 directory, but it will not create this directory by itself. It rather uses the
294 existance of this directory as an affirmation, that the user wants thumbnails
295 to be cached.
296 .P
297 Use the command line option
ecd5e71 @muennich Renamed option -C -> -c
authored
298 .I \-c
bb85d3d @muennich Updated doc for thumbnail cache
authored
299 to keep the cache directory clean by removing all orphaned cache files.
300 Additionally, run the following command afterwards inside the cache directory
301 to remove empty subdirectories:
302 .P
303 .RS
5c77e1a @muennich Fixed hyphen-used-as-minus-sign issues in man page
authored
304 find \-type d \-empty \-delete
bb85d3d @muennich Updated doc for thumbnail cache
authored
305 .RE
d3da0eb @muennich Added man page
authored
306 .SH AUTHORS
e8a503b @muennich Updated section AUTHORS of man page
authored
307 .EX
d3da0eb @muennich Added man page
authored
308 Bert Muennich <ber.t at gmx.com>
e8a503b @muennich Updated section AUTHORS of man page
authored
309 Dave Reisner <d at falconindy.com>
9be4734 @muennich New author in man page
authored
310 Fung SzeTat <sthorde at gmail.com>
e8a503b @muennich Updated section AUTHORS of man page
authored
311 .EE
c0dacea @muennich Nicer man page homepage section
authored
312 .SH HOMEPAGE
d3da0eb @muennich Added man page
authored
313 .TP
314 http://github.com/muennich/sxiv
315 .SH SEE ALSO
f47092c @muennich Complete mouse support
authored
316 .BR feh (1),
317 .BR qiv (1)
Something went wrong with that request. Please try again.