Krolyxon
Commit ac2a6ff

Branches

Refs →

nsxivsxiv.1

382 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 N
139Go
140.I count
141marked images forward.
142.TP
143.B P
144Go
145.I count
146marked images backward.
147.SH THUMBNAIL KEYBOARD COMMANDS
148The following keyboard commands are only available in thumbnail mode:
149.TP
150.BR h ", " Left
151Move selection left
152.I count
153times.
154.TP
155.BR j ", " Down
156Move selection down
157.I count
158times.
159.TP
160.BR k ", " Up
161Move selection up
162.I count
163times.
164.TP
165.BR l ", " Right
166Move selection right
167.I count
168times.
169.TP
170.BR Ctrl-j ", " Ctrl-Down
171Scroll thumbnail grid one window height down.
172.TP
173.BR Ctrl-k ", " Ctrl-Up
174Scroll thumbnail grid one window height up.
175.SH IMAGE KEYBOARD COMMANDS
176The following keyboard commands are only available in image mode:
177.SS Navigate image list
178.TP
179.BR n ", " Space
180Go
181.I count
182images forward.
183.TP
184.BR p ", " Backspace
185Go
186.I count
187images backward.
188.TP
189.B [
190Go
191.I count
192* 10 images backward.
193.TP
194.B ]
195Go
196.I count
197* 10 images forward.
198.SS Handle multi-frame images
199.TP
200.B Ctrl-n
201Go to the next frame of a multi-frame image.
202.TP
203.B Ctrl-p
204Go to the previous frame of a multi-frame image.
205.TP
206.B Ctrl-Space
207Play/pause animation of a multi-frame image.
208.SS Zooming
209.TP
210.BR +
211Zoom in.
212.TP
213.B \-
214Zoom out.
215.TP
216.B =
217Set zoom level to 100%, or
218.IR count %.
219.TP
220.B w
221Set zoom level to fit image into window.
222.TP
223.B e
224Set zoom level to fit image width to window width.
225.TP
226.B E
227Set zoom level to fit image height to window height.
228.SS Panning
229.TP
230.BR h ", " Left
231Pan image 1/5 of window width or
232.I count
233pixel left.
234.TP
235.BR j ", " Down
236Pan image 1/5 of window height or
237.I count
238pixel down.
239.TP
240.BR k ", " Up
241Pan image 1/5 of window height or
242.I count
243pixel up.
244.TP
245.BR l ", " Right
246Pan image 1/5 of window width or
247.I count
248pixel right.
249.TP
250.B H
251Pan to left image edge.
252.TP
253.B J
254Pan to bottom image edge.
255.TP
256.B K
257Pan to top image edge.
258.TP
259.B L
260Pan to right image edge.
261.TP
262.BR Ctrl-h ", " Ctrl-Left
263Pan image one window width left.
264.TP
265.BR Ctrl-j ", " Ctrl-Down
266Pan image one window height down.
267.TP
268.BR Ctrl-k ", " Ctrl-Up
269Pan image one window height up.
270.TP
271.BR Ctrl-l ", " Ctrl-Right
272Pan image one window width right.
273.SS Rotation
274.TP
275.B <
276Rotate image counter-clockwise by 90 degrees.
277.TP
278.B >
279Rotate image clockwise by 90 degrees.
280.TP
281.B ?
282Rotate image by 180 degrees.
283.SS Flip
284.TP
285.B |
286Flip image horizontally.
287.TP
288.B _
289Flip image vertically.
290.SS Gamma Correction
291.TP
292.B {
293Decrease gamma.
294.TP
295.B }
296Increase gamma.
297.TP
298.B Ctrl-G
299Reset gamma.
300.SS Miscellaneous
301.TP
302.B a
303Toggle anti-aliasing.
304.TP
305.B W
306Resize window to fit image.
307.SH MOUSE COMMANDS
308The following mouse mappings are available in image mode:
309.SS Navigate image list
310.TP
311.B Button1
312Go to next image.
313.TP
314.B Button3
315Go to the previous image.
316.SS Zooming
317.TP
318.B Ctrl+ScrollUp
319Zoom in.
320.TP
321.B Ctrl+ScrollDown
322Zoom out.
323.SS Panning/Moving
324.TP
325.B Button2
326Drag the image with the mouse while keeping this button pressed down.
327.TP
328.B ScrollUp
329Pan image up.
330.TP
331.B ScrollDown
332Pan image down.
333.TP
334.B Shift+ScrollUp
335Pan image left.
336.TP
337.B Shift+ScrollDown
338Pan image right.
339.SH STATUS BAR
340The information displayed on the left side of the status bar can be replaced
341with the output of a user-provided script, which is called by sxiv whenever an
342image gets loaded. The path of this script is
343.I ~/.sxiv/exec/image-info
344and the first argument to this script is the path of the loaded image.
345.P
346There is also an example script installed together with sxiv as
347.IR PREFIX/share/sxiv/exec/image-info .
348.SH THUMBNAIL CACHING
349To enable thumbnail caching, please make sure to create the directory
350.I ~/.sxiv/cache/
351with write permissions. sxiv will then store all thumbnails inside this
352directory, but it will not create this directory by itself. It rather uses the
353existance of this directory as an affirmation, that the user wants thumbnails
354to be cached.
355.P
356Use the command line option
357.I \-c
358to keep the cache directory clean by removing all orphaned cache files.
359Additionally, run the following command afterwards inside the cache directory
360to remove empty subdirectories:
361.P
362.RS
363find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
364.RE
365.SH AUTHOR
366.EX
367Bert Muennich <be.muennich @ gmail.com>
368.EE
369.SH CONTRIBUTORS
370.EX
371Bastien Dejean <nihilhill at gmail.com>
372Dave Reisner <d at falconindy.com>
373Fung SzeTat <sthorde at gmail.com>
374.EE
375.SH HOMEPAGE
376.EX
377http://muennich.github.com/sxiv
378https://github.com/muennich/sxiv
379.EE
380.SH SEE ALSO
381.BR feh (1),
382.BR qiv (1)