Krolyxon
Commit cc479ca

Branches

Refs →

nsxivsxiv.1

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