Krolyxon
Commit 5cfae63

Branches

Refs →

nsxivsxiv.1

398 lines · 7.5 KB · Groff/troff

Raw Blame History Download
1.TH SXIV 1 sxiv\-VERSION
2.SH NAME
3sxiv \- Simple X Image Viewer
4.SH SYNOPSIS
5.B sxiv
6.RB [ \-bcfhioqrtvZ ]
7.RB [ \-G
8.IR GAMMA ]
9.RB [ \-g
10.IR GEOMETRY ]
11.RB [ \-N
12.IR NAME ]
13.RB [ \-n
14.IR NUM ]
15.RB [ \-S
16.IR DELAY ]
17.RB [ \-s
18.IR MODE ]
19.RB [ \-z
20.IR ZOOM ]
21.IR FILE ...
22.SH DESCRIPTION
23sxiv is a simple image viewer for X. It only has the most basic features
24required for fast image viewing.
25.P
26sxiv has two modes of operation: image and thumbnail mode. The default is image
27mode, in which only the current image is shown. In thumbnail mode a grid of
28small previews is displayed, making it easy to choose an image to open.
29.P
30Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
31manager.
32.SH OPTIONS
33.TP
34.B \-b
35Do not show info bar on bottom of window.
36.TP
37.B \-c
38Remove all orphaned cache files from the thumbnail cache directory and exit.
39.TP
40.B \-f
41Start in fullscreen mode.
42.TP
43.BI "\-G " GAMMA
44Set image gamma to GAMMA (-32..32).
45.TP
46.BI "\-g " GEOMETRY
47Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
48more information on GEOMETRY argument.
49.TP
50.BI "\-N " NAME
51Set the resource name of sxiv's X window to NAME.
52.TP
53.BI "\-n " NUM
54Start at picture number NUM.
55.TP
56.B \-h
57Print brief usage information to standard output and exit.
58.TP
59.B \-i
60Read names of files to open from standard input.
61.TP
62.B \-o
63Write list of all marked files to standard output when quitting. In combination
64with
65.B \-i
66sxiv can be used as a visual filter/pipe.
67.TP
68.B \-q
69Be quiet, disable warnings to standard error stream.
70.TP
71.B \-r
72Search the given directories recursively for images to view.
73.TP
74.BI "\-S " DELAY
75Start in slideshow mode. Set the delay between images to DELAY seconds.
76.TP
77.BI "\-s " MODE
78Set scale mode according to MODE character. Supported modes are: [d]own,
79[f]it, [w]idth, [h]eight.
80.TP
81.B \-t
82Start in thumbnail mode.
83.TP
84.B \-v
85Print version information to standard output and exit.
86.TP
87.B \-Z
88The same as `\-z 100'.
89.TP
90.BI "\-z " ZOOM
91Set zoom level to ZOOM percent.
92.SH GENERAL KEYBOARD COMMANDS
93The following keyboard commands are available in both image and thumbnail mode:
94.TP
95.B q
96Quit sxiv.
97.TP
98.B Return
99Switch to thumbnail mode / open selected image in image mode.
100.TP
101.BR 0 \- 9
102Prefix the next command with a number (denoted via
103.IR count ).
104.TP
105.B g
106Go to the first image.
107.TP
108.B G
109Go to the last image, or image number
110.IR count .
111.TP
112.B f
113Toggle fullscreen mode.
114.TP
115.B b
116Toggle visibility of info bar on bottom of window.
117.TP
118.B Ctrl-x
119Send the next key to the external key-handler.
120.TP
121.B r
122Reload image.
123.TP
124.B R
125Reload all thumbnails.
126.TP
127.B D
128Remove current image from file list and go to next image.
129.TP
130.B m
131Mark/unmark the current image.
132.TP
133.B M
134Reverse all image marks.
135.TP
136.B N
137Go
138.I count
139marked images forward.
140.TP
141.B P
142Go
143.I count
144marked images backward.
145.SH THUMBNAIL KEYBOARD COMMANDS
146The following keyboard commands are only available in thumbnail mode:
147.TP
148.BR h ", " Left
149Move selection left
150.I count
151times.
152.TP
153.BR j ", " Down
154Move selection down
155.I count
156times.
157.TP
158.BR k ", " Up
159Move selection up
160.I count
161times.
162.TP
163.BR l ", " Right
164Move selection right
165.I count
166times.
167.TP
168.BR Ctrl-j ", " Ctrl-Down
169Scroll thumbnail grid one window height down.
170.TP
171.BR Ctrl-k ", " Ctrl-Up
172Scroll thumbnail grid one window height up.
173.SH IMAGE KEYBOARD COMMANDS
174The following keyboard commands are only available in image mode:
175.SS Navigate image list
176.TP
177.BR n ", " Space
178Go
179.I count
180images forward.
181.TP
182.BR p ", " Backspace
183Go
184.I count
185images backward.
186.TP
187.B [
188Go
189.I count
190* 10 images backward.
191.TP
192.B ]
193Go
194.I count
195* 10 images forward.
196.SS Handle multi-frame images
197.TP
198.B Ctrl-n
199Go to the next frame of a multi-frame image.
200.TP
201.B Ctrl-p
202Go to the previous frame of a multi-frame image.
203.TP
204.B Ctrl-Space
205Play/pause animation of a multi-frame image.
206.SS Zooming
207.TP
208.BR +
209Zoom in.
210.TP
211.B \-
212Zoom out.
213.TP
214.B =
215Set zoom level to 100%, or
216.IR count %.
217.TP
218.B w
219Set zoom level to 100%, but fit large images into window.
220.TP
221.B W
222Fit image to window.
223.TP
224.B e
225Fit image to window width.
226.TP
227.B E
228Fit image to window height.
229.SS Panning
230.TP
231.BR h ", " Left
232Pan image 1/5 of window width or
233.I count
234pixel left.
235.TP
236.BR j ", " Down
237Pan image 1/5 of window height or
238.I count
239pixel down.
240.TP
241.BR k ", " Up
242Pan image 1/5 of window height or
243.I count
244pixel up.
245.TP
246.BR l ", " Right
247Pan image 1/5 of window width or
248.I count
249pixel right.
250.TP
251.B H
252Pan to left image edge.
253.TP
254.B J
255Pan to bottom image edge.
256.TP
257.B K
258Pan to top image edge.
259.TP
260.B L
261Pan to right image edge.
262.TP
263.BR Ctrl-h ", " Ctrl-Left
264Pan image one window width left.
265.TP
266.BR Ctrl-j ", " Ctrl-Down
267Pan image one window height down.
268.TP
269.BR Ctrl-k ", " Ctrl-Up
270Pan image one window height up.
271.TP
272.BR Ctrl-l ", " Ctrl-Right
273Pan image one window width right.
274.SS Rotation
275.TP
276.B <
277Rotate image counter-clockwise by 90 degrees.
278.TP
279.B >
280Rotate image clockwise by 90 degrees.
281.TP
282.B ?
283Rotate image by 180 degrees.
284.SS Flip
285.TP
286.B |
287Flip image horizontally.
288.TP
289.B _
290Flip image vertically.
291.SS Gamma Correction
292.TP
293.B {
294Decrease gamma.
295.TP
296.B }
297Increase gamma.
298.TP
299.B Ctrl-g
300Reset gamma.
301.SS Miscellaneous
302.TP
303.B a
304Toggle anti-aliasing.
305.TP
306.B A
307Toggle visibility of alpha-channel, i.e. image transparency.
308.TP
309.B s
310Toggle slideshow mode and/or set the delay between images to
311.I count
312seconds.
313.SH MOUSE COMMANDS
314The following mouse mappings are available in image mode:
315.SS Navigate image list
316.TP
317.B Button1
318Go to next image.
319.TP
320.B Button3
321Go to the previous image.
322.SS Zooming
323.TP
324.B Ctrl+ScrollUp
325Zoom in.
326.TP
327.B Ctrl+ScrollDown
328Zoom out.
329.SS Panning/Moving
330.TP
331.B Button2
332Drag the image with the mouse while keeping this button pressed down.
333.TP
334.B ScrollUp
335Pan image up.
336.TP
337.B ScrollDown
338Pan image down.
339.TP
340.B Shift+ScrollUp
341Pan image left.
342.TP
343.B Shift+ScrollDown
344Pan image right.
345.SH STATUS BAR
346The information displayed on the left side of the status bar can be replaced
347with the output of a user-provided script, which is called by sxiv whenever an
348image gets loaded. The path of this script is
349.I $XDG_CONFIG_HOME/sxiv/exec/image-info
350and the first argument to this script is the path of the loaded image.
351.P
352There is also an example script installed together with sxiv as
353.IR PREFIX/share/sxiv/exec/image-info .
354.SH EXTERNAL KEY HANDLER
355Additional external keyboard commands can be defined using a handler program
356located in
357.IR $XDG_CONFIG_HOME/sxiv/exec/key-handler .
358The handler is invoked by pressing
359.BR Ctrl-x .
360The next key combo is then passed as its first argument and the path of the
361current image as its second argument. sxiv(1) will block until the handler
362terminates. It then checks if the image has been modified and reloads it.
363
364The key combo argument has the following form: "[C-][M-][S-]KEY",
365where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
366keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
367
368There is also an example script installed together with sxiv as
369.IR PREFIX/share/sxiv/exec/key-handler .
370.SH THUMBNAIL CACHING
371sxiv stores all thumbnails under
372.IR $XDG_CACHE_HOME/sxiv/ .
373.P
374Use the command line option
375.I \-c
376to remove all orphaned cache files. Additionally, run the following command
377afterwards inside the cache directory to remove empty subdirectories:
378.P
379.RS
380find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
381.RE
382.SH AUTHOR
383.EX
384Bert Muennich <ber.t at posteo.de>
385.EE
386.SH CONTRIBUTORS
387.EX
388Bastien Dejean <nihilhill at gmail.com>
389Dave Reisner <d at falconindy.com>
390Fung SzeTat <sthorde at gmail.com>
391.EE
392.SH HOMEPAGE
393.EX
394https://github.com/muennich/sxiv
395.EE
396.SH SEE ALSO
397.BR feh (1),
398.BR qiv (1)