Krolyxon
Commit 06164c2

Branches

Refs →

nsxivsxiv.1

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