Krolyxon
Commit ba0a5b8

Branches

Refs →

nsxivsxiv.1

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