Krolyxon
Commit fd519ff

Branches

Refs →

nsxivsxiv.1

345 lines · 6.4 KB · Groff/troff

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