Krolyxon
Commit eb5feb4

Branches

Refs →

nsxivsxiv.1

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