Krolyxon
Commit 9d74a57

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.TP
131.BR j ", " Down
132Move selection down.
133.TP
134.BR k ", " Up
135Move selection up.
136.TP
137.BR l ", " Right
138Move selection right.
139.TP
140.BR Ctrl-j ", " Ctrl-Down
141Scroll thumbnail grid one window height down.
142.TP
143.BR Ctrl-k ", " Ctrl-Up
144Scroll thumbnail grid one window height up.
145.SH IMAGE KEYBOARD COMMANDS
146The following keyboard commands are only available in image mode:
147.SS Navigate image list
148.TP
149.BR n ", " Space
150Go
151.I count
152images forward.
153.TP
154.BR p ", " Backspace
155Go
156.I count
157images backward.
158.TP
159.B [
160Go
161.I count
162* 10 images backward.
163.TP
164.B ]
165Go
166.I count
167* 10 images forward.
168.SS Handle multi-frame images
169.TP
170.B Ctrl-n
171Go to the next frame of a multi-frame image.
172.TP
173.B Ctrl-p
174Go to the previous frame of a multi-frame image.
175.TP
176.B Ctrl-Space
177Play/pause animation of a multi-frame image.
178.SS Zooming
179.TP
180.BR +
181Zoom in.
182.TP
183.B \-
184Zoom out.
185.TP
186.B =
187Set zoom level to 100%, or
188.IR count %.
189.TP
190.B w
191Set zoom level to fit image into window.
192.SS Panning
193.TP
194.BR h ", " Left
195Pan image 1/5 of window width or
196.I count
197pixel left.
198.TP
199.BR j ", " Down
200Pan image 1/5 of window height or
201.I count
202pixel down.
203.TP
204.BR k ", " Up
205Pan image 1/5 of window height or
206.I count
207pixel up.
208.TP
209.BR l ", " Right
210Pan image 1/5 of window width or
211.I count
212pixel right.
213.TP
214.B H
215Pan to left image edge.
216.TP
217.B J
218Pan to bottom image edge.
219.TP
220.B K
221Pan to top image edge.
222.TP
223.B L
224Pan to right image edge.
225.TP
226.BR Ctrl-h ", " Ctrl-Left
227Pan image one window width left.
228.TP
229.BR Ctrl-j ", " Ctrl-Down
230Pan image one window height down.
231.TP
232.BR Ctrl-k ", " Ctrl-Up
233Pan image one window height up.
234.TP
235.BR Ctrl-l ", " Ctrl-Right
236Pan image one window width right.
237.SS Rotation
238.TP
239.B <
240Rotate image counter-clockwise by 90 degrees.
241.TP
242.B >
243Rotate image clockwise by 90 degrees.
244.SS Flip
245.TP
246.B \\\\
247Flip image horizontally.
248.TP
249.B |
250Flip image vertically.
251.SS Slideshow
252.TP
253.B s
254Toggle slideshow.
255.TP
256.B Ctrl\-'\-'
257Decrease slideshow delay.
258.TP
259.B Ctrl-'+'
260Increase slideshow delay.
261.TP
262.B Ctrl-'='
263Reset slideshow delay to default value, or set it to
264.I count
265seconds.
266.SS Miscellaneous
267.TP
268.B a
269Toggle anti-aliasing.
270.TP
271.B W
272Resize window to fit image.
273.SH MOUSE COMMANDS
274The following mouse mappings are available in image mode:
275.SS Navigate image list
276.TP
277.B Button1
278Go to next image.
279.TP
280.B Button3
281Go to the previous image.
282.SS Zooming
283.TP
284.B Ctrl+ScrollUp
285Zoom in.
286.TP
287.B Ctrl+ScrollDown
288Zoom out.
289.SS Panning/Moving
290.TP
291.B Button2
292Drag the image with the mouse while keeping this button pressed down.
293.TP
294.B ScrollUp
295Pan image up.
296.TP
297.B ScrollDown
298Pan image down.
299.TP
300.B Shift+ScrollUp
301Pan image left.
302.TP
303.B Shift+ScrollDown
304Pan image right.
305.SH THUMBNAIL CACHING
306To enable thumbnail caching, please make sure to create the directory
307.I ~/.sxiv/
308with write permissions. sxiv will then store all thumbnails inside this
309directory, but it will not create this directory by itself. It rather uses the
310existance of this directory as an affirmation, that the user wants thumbnails
311to be cached.
312.P
313Use the command line option
314.I \-c
315to keep the cache directory clean by removing all orphaned cache files.
316Additionally, run the following command afterwards inside the cache directory
317to remove empty subdirectories:
318.P
319.RS
320find \-type d \-empty \-delete
321.RE
322.P
323If the version of
324.I find
325installed on your local system does not support the \-delete option, then you
326can also try the following command:
327.P
328.RS
329find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
330.RE
331.SH AUTHOR
332.EX
333Bert Muennich <ber.t at gmx.com>
334.EE
335.SH CONTRIBUTORS
336.EX
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)