Krolyxon
Commit a3838c1

Branches

Refs →

nsxivsxiv.1

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