Krolyxon
Commit 53a72c7

Branches

Refs →

nsxivsxiv.1

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