Krolyxon
Commit 0f7b26d

Branches

Refs →

nsxivsxiv.1

406 lines · 7.9 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 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 M
137Reverse all image marks.
138.TP
139.B N
140Go
141.I count
142marked images forward.
143.TP
144.B P
145Go
146.I count
147marked images backward.
148.SH THUMBNAIL KEYBOARD COMMANDS
149The following keyboard commands are only available in thumbnail mode:
150.TP
151.BR h ", " Left
152Move selection left
153.I count
154times.
155.TP
156.BR j ", " Down
157Move selection down
158.I count
159times.
160.TP
161.BR k ", " Up
162Move selection up
163.I count
164times.
165.TP
166.BR l ", " Right
167Move selection right
168.I count
169times.
170.TP
171.BR Ctrl-j ", " Ctrl-Down
172Scroll thumbnail grid one window height down.
173.TP
174.BR Ctrl-k ", " Ctrl-Up
175Scroll thumbnail grid one window height up.
176.SH IMAGE KEYBOARD COMMANDS
177The following keyboard commands are only available in image mode:
178.SS Navigate image list
179.TP
180.BR n ", " Space
181Go
182.I count
183images forward.
184.TP
185.BR p ", " Backspace
186Go
187.I count
188images backward.
189.TP
190.B [
191Go
192.I count
193* 10 images backward.
194.TP
195.B ]
196Go
197.I count
198* 10 images forward.
199.SS Handle multi-frame images
200.TP
201.B Ctrl-n
202Go to the next frame of a multi-frame image.
203.TP
204.B Ctrl-p
205Go to the previous frame of a multi-frame image.
206.TP
207.B Ctrl-Space
208Play/pause animation of a multi-frame image.
209.SS Zooming
210.TP
211.BR +
212Zoom in.
213.TP
214.B \-
215Zoom out.
216.TP
217.B =
218Set zoom level to 100%, or
219.IR count %.
220.TP
221.B w
222Set zoom level to 100%, but fit large images into window.
223.TP
224.B W
225Fit image to window.
226.TP
227.B e
228Fit image to window width.
229.TP
230.B E
231Fit image to window height.
232.SS Panning
233.TP
234.BR h ", " Left
235Pan image 1/5 of window width or
236.I count
237pixel left.
238.TP
239.BR j ", " Down
240Pan image 1/5 of window height or
241.I count
242pixel down.
243.TP
244.BR k ", " Up
245Pan image 1/5 of window height or
246.I count
247pixel up.
248.TP
249.BR l ", " Right
250Pan image 1/5 of window width or
251.I count
252pixel right.
253.TP
254.B H
255Pan to left image edge.
256.TP
257.B J
258Pan to bottom image edge.
259.TP
260.B K
261Pan to top image edge.
262.TP
263.B L
264Pan to right image edge.
265.TP
266.BR Ctrl-h ", " Ctrl-Left
267Pan image one window width left.
268.TP
269.BR Ctrl-j ", " Ctrl-Down
270Pan image one window height down.
271.TP
272.BR Ctrl-k ", " Ctrl-Up
273Pan image one window height up.
274.TP
275.BR Ctrl-l ", " Ctrl-Right
276Pan image one window width right.
277.SS Rotation
278.TP
279.B <
280Rotate image counter-clockwise by 90 degrees.
281.TP
282.B >
283Rotate image clockwise by 90 degrees.
284.TP
285.B ?
286Rotate image by 180 degrees.
287.SS Flip
288.TP
289.B |
290Flip image horizontally.
291.TP
292.B _
293Flip image vertically.
294.SS Gamma Correction
295.TP
296.B {
297Decrease gamma.
298.TP
299.B }
300Increase gamma.
301.TP
302.B Ctrl-g
303Reset gamma.
304.SS Miscellaneous
305.TP
306.B a
307Toggle anti-aliasing.
308.TP
309.B A
310Toggle visibility of alpha-channel, i.e. image transparency.
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 EXTERNAL KEY HANDLER
358Additional external keyboard commands can be defined using a handler program
359located in
360.IR $XDG_CONFIG_HOME/sxiv/exec/key-handler .
361The handler is invoked by pressing
362.BR Ctrl-x .
363The next key combo is then passed as its first argument and the path of the
364current image as its second argument. sxiv(1) will block until the handler
365terminates. It then checks if the image has been modified and reloads it.
366
367The key combo argument has the following form: "[C-][M-][S-]KEY",
368where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
369keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
370
371There is also an example script installed together with sxiv as
372.IR PREFIX/share/sxiv/exec/key-handler .
373.SH THUMBNAIL CACHING
374To enable thumbnail caching, please make sure to create the directory
375.I $XDG_CACHE_HOME/sxiv/
376with write permissions. sxiv will then store all thumbnails inside this
377directory, but it will not create this directory by itself. It rather uses the
378existance of this directory as an affirmation, that the user wants thumbnails
379to be cached.
380.P
381Use the command line option
382.I \-c
383to keep the cache directory clean by removing all orphaned cache files.
384Additionally, run the following command afterwards inside the cache directory
385to remove empty subdirectories:
386.P
387.RS
388find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
389.RE
390.SH AUTHOR
391.EX
392Bert Muennich <ber.t at posteo.de>
393.EE
394.SH CONTRIBUTORS
395.EX
396Bastien Dejean <nihilhill at gmail.com>
397Dave Reisner <d at falconindy.com>
398Fung SzeTat <sthorde at gmail.com>
399.EE
400.SH HOMEPAGE
401.EX
402https://github.com/muennich/sxiv
403.EE
404.SH SEE ALSO
405.BR feh (1),
406.BR qiv (1)