Krolyxon
Commit 61f61ca

Branches

Refs →

nsxivsxiv.1

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