Krolyxon
Commit c1ba841

Branches

Refs →

nsxivsxiv.1

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