Krolyxon
Commit ec47ecb

Branches

Refs →

nsxivsxiv.1

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