Krolyxon
Commit 447bc1c

Branches

Refs →

nsxivsxiv.1

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