Krolyxon
Commit 98972e9

Branches

Refs →

nsxivsxiv.1

353 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 [ \-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 opened files to standard output when quitting. If combined with
66.IR \-i ,
67then sxiv acts as a visual filter/pipe.
68.TP
69.B \-p
70Pixelize images, i.e. turn off anti-aliasing.
71.TP
72.B \-q
73Be quiet, disable warnings to standard error stream.
74.TP
75.B \-r
76Search the given directories recursively for images to view.
77.TP
78.B \-s
79Scale all images to fit into window.
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
91Scale all images to the current zoom level, use a zoom level of
92.I ZOOM
93at startup.
94.SH GENERAL KEYBOARD COMMANDS
95The following keyboard commands are available in both image and thumbnail mode:
96.TP
97.B q
98Quit sxiv.
99.TP
100.B Return
101Switch to thumbnail mode / open selected image in image mode.
102.TP
103.BR 0 \- 9
104Prefix the next command with a number (denoted via
105.IR count ).
106.TP
107.B g
108Go to the first image.
109.TP
110.B G
111Go to the last image, or image number
112.IR count .
113.TP
114.B f
115Toggle fullscreen mode.
116.TP
117.B b
118Toggle visibility of info bar on bottom of window.
119.TP
120.B A
121Toggle visibility of alpha-channel, i.e. image transparency.
122.TP
123.B r
124Reload image.
125.TP
126.B R
127Reload all thumbnails.
128.TP
129.B D
130Remove current image from file list and go to next image.
131.SH THUMBNAIL KEYBOARD COMMANDS
132The following keyboard commands are only available in thumbnail mode:
133.TP
134.BR h ", " Left
135Move selection left
136.I count
137times.
138.TP
139.BR j ", " Down
140Move selection down
141.I count
142times.
143.TP
144.BR k ", " Up
145Move selection up
146.I count
147times.
148.TP
149.BR l ", " Right
150Move selection right
151.I count
152times.
153.TP
154.BR Ctrl-j ", " Ctrl-Down
155Scroll thumbnail grid one window height down.
156.TP
157.BR Ctrl-k ", " Ctrl-Up
158Scroll thumbnail grid one window height up.
159.SH IMAGE KEYBOARD COMMANDS
160The following keyboard commands are only available in image mode:
161.SS Navigate image list
162.TP
163.BR n ", " Space
164Go
165.I count
166images forward.
167.TP
168.BR p ", " Backspace
169Go
170.I count
171images backward.
172.TP
173.B [
174Go
175.I count
176* 10 images backward.
177.TP
178.B ]
179Go
180.I count
181* 10 images forward.
182.SS Handle multi-frame images
183.TP
184.B Ctrl-n
185Go to the next frame of a multi-frame image.
186.TP
187.B Ctrl-p
188Go to the previous frame of a multi-frame image.
189.TP
190.B Ctrl-Space
191Play/pause animation of a multi-frame image.
192.SS Zooming
193.TP
194.BR +
195Zoom in.
196.TP
197.B \-
198Zoom out.
199.TP
200.B =
201Set zoom level to 100%, or
202.IR count %.
203.TP
204.B w
205Set zoom level to fit image into window.
206.TP
207.B e
208Set zoom level to fit image width to window width.
209.TP
210.B E
211Set zoom level to fit image height to window height.
212.SS Panning
213.TP
214.BR h ", " Left
215Pan image 1/5 of window width or
216.I count
217pixel left.
218.TP
219.BR j ", " Down
220Pan image 1/5 of window height or
221.I count
222pixel down.
223.TP
224.BR k ", " Up
225Pan image 1/5 of window height or
226.I count
227pixel up.
228.TP
229.BR l ", " Right
230Pan image 1/5 of window width or
231.I count
232pixel right.
233.TP
234.B H
235Pan to left image edge.
236.TP
237.B J
238Pan to bottom image edge.
239.TP
240.B K
241Pan to top image edge.
242.TP
243.B L
244Pan to right image edge.
245.TP
246.BR Ctrl-h ", " Ctrl-Left
247Pan image one window width left.
248.TP
249.BR Ctrl-j ", " Ctrl-Down
250Pan image one window height down.
251.TP
252.BR Ctrl-k ", " Ctrl-Up
253Pan image one window height up.
254.TP
255.BR Ctrl-l ", " Ctrl-Right
256Pan image one window width right.
257.SS Rotation
258.TP
259.B <
260Rotate image counter-clockwise by 90 degrees.
261.TP
262.B >
263Rotate image clockwise by 90 degrees.
264.SS Flip
265.TP
266.B \\\\
267Flip image horizontally.
268.TP
269.B |
270Flip image vertically.
271.SS Miscellaneous
272.TP
273.B a
274Toggle anti-aliasing.
275.TP
276.B W
277Resize window to fit image.
278.SH MOUSE COMMANDS
279The following mouse mappings are available in image mode:
280.SS Navigate image list
281.TP
282.B Button1
283Go to next image.
284.TP
285.B Button3
286Go to the previous image.
287.SS Zooming
288.TP
289.B Ctrl+ScrollUp
290Zoom in.
291.TP
292.B Ctrl+ScrollDown
293Zoom out.
294.SS Panning/Moving
295.TP
296.B Button2
297Drag the image with the mouse while keeping this button pressed down.
298.TP
299.B ScrollUp
300Pan image up.
301.TP
302.B ScrollDown
303Pan image down.
304.TP
305.B Shift+ScrollUp
306Pan image left.
307.TP
308.B Shift+ScrollDown
309Pan image right.
310.SH STATUS BAR
311The information displayed on the left side of the status bar can be replaced
312with the output of a user-provided script, which is called by sxiv whenever an
313image gets loaded. The path of this script is
314.I ~/.sxiv/exec/image-info
315and the first argument to this script is the path of the loaded image.
316.P
317There is also an example script installed together with sxiv as
318.IR PREFIX/share/sxiv/exec/image-info .
319.SH THUMBNAIL CACHING
320To enable thumbnail caching, please make sure to create the directory
321.I ~/.sxiv/cache/
322with write permissions. sxiv will then store all thumbnails inside this
323directory, but it will not create this directory by itself. It rather uses the
324existance of this directory as an affirmation, that the user wants thumbnails
325to be cached.
326.P
327Use the command line option
328.I \-c
329to keep the cache directory clean by removing all orphaned cache files.
330Additionally, run the following command afterwards inside the cache directory
331to remove empty subdirectories:
332.P
333.RS
334find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
335.RE
336.SH AUTHOR
337.EX
338Bert Muennich <be.muennich @ gmail.com>
339.EE
340.SH CONTRIBUTORS
341.EX
342Bastien Dejean <nihilhill at gmail.com>
343Dave Reisner <d at falconindy.com>
344Fung SzeTat <sthorde at gmail.com>
345.EE
346.SH HOMEPAGE
347.EX
348http://muennich.github.com/sxiv
349https://github.com/muennich/sxiv
350.EE
351.SH SEE ALSO
352.BR feh (1),
353.BR qiv (1)