Krolyxon
Commit 1de5f06

Branches

Refs →

nsxivsxiv.1

436 lines · 8.1 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
176Repeat last mark action on all images from the last marked/unmarked up to the
177current one.
178.TP
179.B Ctrl-m
180Remove all image marks.
181.TP
182.B N
183Go
184.I count
185marked images forward.
186.TP
187.B P
188Go
189.I count
190marked images backward.
191.TP
192.B {
193Decrease gamma correction by
194.I count
195steps.
196.TP
197.B }
198Increase gamma correction by
199.I count
200steps.
201.TP
202.B Ctrl-g
203Reset gamma correction.
204.SS Thumbnail mode
205The following keyboard commands are only available in thumbnail mode:
206.TP
207.BR h ", " Left
208Move selection left
209.I count
210times.
211.TP
212.BR j ", " Down
213Move selection down
214.I count
215times.
216.TP
217.BR k ", " Up
218Move selection up
219.I count
220times.
221.TP
222.BR l ", " Right
223Move selection right
224.I count
225times.
226.TP
227.B R
228Reload all thumbnails.
229.SS Image mode
230The following keyboard commands are only available in image mode:
231.TP
232Navigate image list:
233.TP
234.BR n ", " Space
235Go
236.I count
237images forward.
238.TP
239.BR p ", " Backspace
240Go
241.I count
242images backward.
243.TP
244.B [
245Go
246.I count
247* 10 images backward.
248.TP
249.B ]
250Go
251.I count
252* 10 images forward.
253.TP
254Handle multi-frame images:
255.TP
256.B Ctrl-n
257Go
258.I count
259frames of a multi-frame image forward.
260.TP
261.B Ctrl-p
262Go
263.I count
264frames of a multi-frame image backward.
265.TP
266.B Ctrl-Space
267Play/stop animations of multi-frame images.
268.TP
269Panning:
270.TP
271.BR h ", " Left
272Scroll image 1/5 of window width or
273.I count
274pixel left.
275.TP
276.BR j ", " Down
277Scroll image 1/5 of window height or
278.I count
279pixel down.
280.TP
281.BR k ", " Up
282Scroll image 1/5 of window height or
283.I count
284pixel up.
285.TP
286.BR l ", " Right
287Scroll image 1/5 of window width or
288.I count
289pixel right.
290.TP
291.B H
292Scroll to left image edge.
293.TP
294.B J
295Scroll to bottom image edge.
296.TP
297.B K
298Scroll to top image edge.
299.TP
300.B L
301Scroll to right image edge.
302.TP
303Zooming:
304.TP
305.B =
306Set zoom level to 100%, or
307.IR count %.
308.TP
309.B w
310Set zoom level to 100%, but fit large images into window.
311.TP
312.B W
313Fit image to window.
314.TP
315.B e
316Fit image to window width.
317.TP
318.B E
319Fit image to window height.
320.TP
321Rotation:
322.TP
323.B <
324Rotate image counter-clockwise by 90 degrees.
325.TP
326.B >
327Rotate image clockwise by 90 degrees.
328.TP
329.B ?
330Rotate image by 180 degrees.
331.TP
332Flipping:
333.TP
334.B |
335Flip image horizontally.
336.TP
337.B _
338Flip image vertically.
339.TP
340Miscellaneous:
341.TP
342.B a
343Toggle anti-aliasing.
344.TP
345.B A
346Toggle visibility of alpha-channel, i.e. image transparency.
347.TP
348.B s
349Toggle slideshow mode and/or set the delay between images to
350.I count
351seconds.
352.SH MOUSE COMMANDS
353The following mouse mappings are available in image mode:
354.TP
355General:
356.TP
357.B Button3
358Switch to thumbnail mode.
359.TP
360Navigate image list:
361.TP
362.B Button1
363Go to the next image if the mouse cursor is in the right part of the window or
364to the previous image if it is in the left part.
365.TP
366Panning:
367.TP
368.B Button2
369Pan the image according to the mouse cursor position in the window while
370keeping this button pressed down.
371.TP
372Zooming:
373.TP
374.B ScrollUp
375Zoom in.
376.TP
377.B ScrollDown
378Zoom out.
379.SH STATUS BAR
380The information displayed on the left side of the status bar can be replaced
381with the output of a user-provided script, which is called by sxiv whenever an
382image gets loaded. The path of this script is
383.I $XDG_CONFIG_HOME/sxiv/exec/image-info
384and the arguments given to it are: 1) path to image file, 2) image width,
3853) image height.
386.P
387There is also an example script installed together with sxiv as
388.IR PREFIX/share/sxiv/exec/image-info .
389.SH EXTERNAL KEY HANDLER
390Additional external keyboard commands can be defined using a handler program
391located in
392.IR $XDG_CONFIG_HOME/sxiv/exec/key-handler .
393The handler is invoked by pressing
394.BR Ctrl-x .
395The next key combo is passed as its first argument. Passed via stdin are the
396images to act upon, one path per line: all marked images, if in thumbnail mode
397and at least one image has been marked, otherwise the current image.
398sxiv(1) will block until the handler terminates. It then checks which images
399have been modified and reloads them.
400
401The key combo argument has the following form: "[C-][M-][S-]KEY",
402where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
403keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
404
405There is also an example script installed together with sxiv as
406.IR PREFIX/share/sxiv/exec/key-handler .
407.SH THUMBNAIL CACHING
408sxiv stores all thumbnails under
409.IR $XDG_CACHE_HOME/sxiv/ .
410.P
411Use the command line option
412.I \-c
413to remove all orphaned cache files. Additionally, run the following command
414afterwards inside the cache directory to remove empty subdirectories:
415.P
416.RS
417find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
418.RE
419.SH AUTHOR
420.EX
421Bert Muennich <ber.t at posteo.de>
422.EE
423.SH CONTRIBUTORS
424.EX
425Bastien Dejean <nihilhill at gmail.com>
426Dave Reisner <d at falconindy.com>
427Fung SzeTat <sthorde at gmail.com>
428Max Voit <mvdev at with-eyes.net>
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)