Krolyxon
Commit 653a6ee

Branches

Refs →

nsxivsxiv.1

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