Krolyxon
Commit 160dd62

Branches

Refs →

nsxivsxiv.1

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