Krolyxon
Commit a20173a

Branches

Refs →

nsxivsxiv.1

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