Krolyxon
Commit 1b089bc

Branches

Refs →

nsxivsxiv.1

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