Krolyxon
Commit ecc363e

Branches

Refs →

nsxivsxiv.1

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