Krolyxon
Commit 524d9de

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 [ \-bcdFfhiopqrstvZ ]
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 [ \-z
18.IR ZOOM ]
19.IR FILE ...
20.SH DESCRIPTION
21sxiv is a simple image viewer for X. It only has the most basic features
22required for fast image viewing.
23.P
24sxiv has two modes of operation: image and thumbnail mode. The default is image
25mode, in which only the current image is shown. In thumbnail mode a grid of
26small previews is displayed, making it easy to choose an image to open.
27.P
28sxiv can also cache its thumbnails. Please see the section THUMBNAIL CACHING
29for information on how to enable this feature.
30.P
31Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
32manager.
33.SH OPTIONS
34.TP
35.B \-b
36Do not show info bar on bottom of window.
37.TP
38.B \-c
39Remove all orphaned cache files from the thumbnail cache directory and exit.
40.TP
41.B \-d
42Scale all images to 100%, but fit large images into window.
43.TP
44.B \-F
45Make the window fixed/floating by setting the minimum and maximum width/height
46size-hints to the window width/height.
47.TP
48.B \-f
49Start in fullscreen mode.
50.TP
51.BI "\-G " GAMMA
52Set image gamma to GAMMA (-32..32).
53.TP
54.BI "\-g " GEOMETRY
55Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
56more information on
57.IR GEOMETRY .
58.TP
59.BI "\-N " NAME
60Set the resource name of sxiv's X window to NAME.
61.TP
62.BI "\-n " NUM
63Start at picture number NUM.
64.TP
65.B \-h
66Print brief usage information to standard output and exit.
67.TP
68.B \-i
69Read names of files to open from standard input.
70.TP
71.B \-o
72Write list of all marked files to standard output when quitting. In combination
73with
74.I \-i
75sxiv can be used as a visual filter/pipe.
76.TP
77.B \-q
78Be quiet, disable warnings to standard error stream.
79.TP
80.B \-r
81Search the given directories recursively for images to view.
82.TP
83.BI "\-S " DELAY
84Start in slideshow mode. Set the delay between images to DELAY seconds.
85.TP
86.B \-s
87Scale all images to fit into window.
88.TP
89.B \-t
90Start in thumbnail mode.
91.TP
92.B \-v
93Print version information to standard output and exit.
94.TP
95.B \-Z
96The same as `\-z 100'.
97.TP
98.BI "\-z " ZOOM
99Scale all images to the current zoom level, use a zoom level of
100.I ZOOM
101at startup.
102.SH GENERAL KEYBOARD COMMANDS
103The following keyboard commands are available in both image and thumbnail mode:
104.TP
105.B q
106Quit sxiv.
107.TP
108.B Return
109Switch to thumbnail mode / open selected image in image mode.
110.TP
111.BR 0 \- 9
112Prefix the next command with a number (denoted via
113.IR count ).
114.TP
115.B g
116Go to the first image.
117.TP
118.B G
119Go to the last image, or image number
120.IR count .
121.TP
122.B f
123Toggle fullscreen mode.
124.TP
125.B b
126Toggle visibility of info bar on bottom of window.
127.TP
128.B Ctrl-x
129Send the next key to the external key-handler.
130.TP
131.B A
132Toggle visibility of alpha-channel, i.e. image transparency.
133.TP
134.B r
135Reload image.
136.TP
137.B R
138Reload all thumbnails.
139.TP
140.B D
141Remove current image from file list and go to next image.
142.TP
143.B m
144Mark/unmark the current image.
145.TP
146.B M
147Reverse all image marks.
148.TP
149.B N
150Go
151.I count
152marked images forward.
153.TP
154.B P
155Go
156.I count
157marked images backward.
158.SH THUMBNAIL KEYBOARD COMMANDS
159The following keyboard commands are only available in thumbnail mode:
160.TP
161.BR h ", " Left
162Move selection left
163.I count
164times.
165.TP
166.BR j ", " Down
167Move selection down
168.I count
169times.
170.TP
171.BR k ", " Up
172Move selection up
173.I count
174times.
175.TP
176.BR l ", " Right
177Move selection right
178.I count
179times.
180.TP
181.BR Ctrl-j ", " Ctrl-Down
182Scroll thumbnail grid one window height down.
183.TP
184.BR Ctrl-k ", " Ctrl-Up
185Scroll thumbnail grid one window height up.
186.SH IMAGE KEYBOARD COMMANDS
187The following keyboard commands are only available in image mode:
188.SS Navigate image list
189.TP
190.BR n ", " Space
191Go
192.I count
193images forward.
194.TP
195.BR p ", " Backspace
196Go
197.I count
198images backward.
199.TP
200.B [
201Go
202.I count
203* 10 images backward.
204.TP
205.B ]
206Go
207.I count
208* 10 images forward.
209.SS Handle multi-frame images
210.TP
211.B Ctrl-n
212Go to the next frame of a multi-frame image.
213.TP
214.B Ctrl-p
215Go to the previous frame of a multi-frame image.
216.TP
217.B Ctrl-Space
218Play/pause animation of a multi-frame image.
219.SS Zooming
220.TP
221.BR +
222Zoom in.
223.TP
224.B \-
225Zoom out.
226.TP
227.B =
228Set zoom level to 100%, or
229.IR count %.
230.TP
231.B w
232Set zoom level to fit image into window.
233.TP
234.B e
235Set zoom level to fit image width to window width.
236.TP
237.B E
238Set zoom level to fit image height 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)