Krolyxon
Commit 2c566c5

Branches

Refs →

nsxivsxiv.1

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