Krolyxon
Commit 997c851

Branches

Refs →

nsxivsxiv.1

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