Krolyxon
Commit fb6e4bd

Branches

Refs →

nsxivsxiv.1

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