Krolyxon
Commit e267dc7

Branches

Refs →

nsxivsxiv.1

397 lines · 7.5 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 [ \-abcfhioqrtvZ ]
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
30Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
31manager.
32.SH OPTIONS
33.TP
34.B \-a
35Play animations of multi-frame images.
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.BR 0 \- 9
99Prefix the next command with a number (denoted via
100.IR count ).
101.TP
102.B q
103Quit sxiv.
104.TP
105.B Return
106Switch to thumbnail mode / open selected image in image mode.
107.TP
108.B f
109Toggle fullscreen mode.
110.TP
111.B b
112Toggle visibility of info bar on bottom of window.
113.TP
114.B Ctrl-x
115Send the next key to the external key-handler. See section EXTERNAL KEY HANDLER
116for more information.
117.TP
118.B g
119Go to the first image.
120.TP
121.B G
122Go to the last image, or image number
123.IR count .
124.TP
125.B r
126Reload image.
127.TP
128.B D
129Remove current image from file list and go to next image.
130.TP
131.BR Ctrl-h ", " Ctrl-Left
132Scroll left one screen width.
133.TP
134.BR Ctrl-j ", " Ctrl-Down
135Scroll down one screen height.
136.TP
137.BR Ctrl-k ", " Ctrl-Up
138Scroll up one screen height.
139.TP
140.BR Ctrl-l ", " Ctrl-Right
141Scroll right one screen width.
142.TP
143.B m
144Mark/unmark the current image.
145.TP
146.B M
147Reverse all image marks.
148.TP
149.B N
150Go
151.I count
152marked images forward.
153.TP
154.B P
155Go
156.I count
157marked images backward.
158.SH THUMBNAIL KEYBOARD COMMANDS
159The following keyboard commands are only available in thumbnail mode:
160.TP
161.BR h ", " Left
162Move selection left
163.I count
164times.
165.TP
166.BR j ", " Down
167Move selection down
168.I count
169times.
170.TP
171.BR k ", " Up
172Move selection up
173.I count
174times.
175.TP
176.BR l ", " Right
177Move selection right
178.I count
179times.
180.TP
181.B R
182Reload all thumbnails.
183.SH IMAGE KEYBOARD COMMANDS
184The following keyboard commands are only available in image mode:
185.SS Navigate image list
186.TP
187.BR n ", " Space
188Go
189.I count
190images forward.
191.TP
192.BR p ", " Backspace
193Go
194.I count
195images backward.
196.TP
197.B [
198Go
199.I count
200* 10 images backward.
201.TP
202.B ]
203Go
204.I count
205* 10 images forward.
206.SS Handle multi-frame images
207.TP
208.B Ctrl-n
209Go to the next frame of a multi-frame image.
210.TP
211.B Ctrl-p
212Go to the previous frame of a multi-frame image.
213.TP
214.B Ctrl-Space
215Play/stop animations of multi-frame images.
216.SS Panning
217.TP
218.BR h ", " Left
219Scroll image 1/5 of window width or
220.I count
221pixel left.
222.TP
223.BR j ", " Down
224Scroll image 1/5 of window height or
225.I count
226pixel down.
227.TP
228.BR k ", " Up
229Scroll image 1/5 of window height or
230.I count
231pixel up.
232.TP
233.BR l ", " Right
234Scroll image 1/5 of window width or
235.I count
236pixel right.
237.TP
238.B H
239Scroll to left image edge.
240.TP
241.B J
242Scroll to bottom image edge.
243.TP
244.B K
245Scroll to top image edge.
246.TP
247.B L
248Scroll to right image edge.
249.SS Zooming
250.TP
251.BR +
252Zoom in.
253.TP
254.B \-
255Zoom out.
256.TP
257.B =
258Set zoom level to 100%, or
259.IR count %.
260.TP
261.B w
262Set zoom level to 100%, but fit large images into window.
263.TP
264.B W
265Fit image to window.
266.TP
267.B e
268Fit image to window width.
269.TP
270.B E
271Fit image to window height.
272.SS Rotation
273.TP
274.B <
275Rotate image counter-clockwise by 90 degrees.
276.TP
277.B >
278Rotate image clockwise by 90 degrees.
279.TP
280.B ?
281Rotate image by 180 degrees.
282.SS Flipping
283.TP
284.B |
285Flip image horizontally.
286.TP
287.B _
288Flip image vertically.
289.SS Gamma Correction
290.TP
291.B {
292Decrease gamma.
293.TP
294.B }
295Increase gamma.
296.TP
297.B Ctrl-g
298Reset gamma.
299.SS Miscellaneous
300.TP
301.B a
302Toggle anti-aliasing.
303.TP
304.B A
305Toggle visibility of alpha-channel, i.e. image transparency.
306.TP
307.B s
308Toggle slideshow mode and/or set the delay between images to
309.I count
310seconds.
311.SH MOUSE COMMANDS
312The following mouse mappings are available in image mode:
313.SS Navigate image list
314.TP
315.B Button1
316Go to next image.
317.TP
318.B Button3
319Go to the previous image.
320.SS Panning
321.TP
322.B Button2
323Drag the image with the mouse while keeping this button pressed down.
324.TP
325.B ScrollUp
326Scroll image up.
327.TP
328.B ScrollDown
329Scroll image down.
330.TP
331.B Shift+ScrollUp
332Scroll image left.
333.TP
334.B Shift+ScrollDown
335Scroll image right.
336.SS Zooming
337.TP
338.B Ctrl+ScrollUp
339Zoom in.
340.TP
341.B Ctrl+ScrollDown
342Zoom out.
343.SH STATUS BAR
344The information displayed on the left side of the status bar can be replaced
345with the output of a user-provided script, which is called by sxiv whenever an
346image gets loaded. The path of this script is
347.I $XDG_CONFIG_HOME/sxiv/exec/image-info
348and the first argument to this script is the path of the loaded image.
349.P
350There is also an example script installed together with sxiv as
351.IR PREFIX/share/sxiv/exec/image-info .
352.SH EXTERNAL KEY HANDLER
353Additional external keyboard commands can be defined using a handler program
354located in
355.IR $XDG_CONFIG_HOME/sxiv/exec/key-handler .
356The handler is invoked by pressing
357.BR Ctrl-x .
358The next key combo is then passed as its first argument, followed by the paths
359of all marked images or the path of the current image, if no image is marked.
360sxiv(1) will block until the handler terminates. It then checks which images
361have been modified and reloads them.
362
363The key combo argument has the following form: "[C-][M-][S-]KEY",
364where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
365keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
366
367There is also an example script installed together with sxiv as
368.IR PREFIX/share/sxiv/exec/key-handler .
369.SH THUMBNAIL CACHING
370sxiv stores all thumbnails under
371.IR $XDG_CACHE_HOME/sxiv/ .
372.P
373Use the command line option
374.I \-c
375to remove all orphaned cache files. Additionally, run the following command
376afterwards inside the cache directory to remove empty subdirectories:
377.P
378.RS
379find . \-depth \-type d \-empty ! \-name '.' \-exec rmdir {} \\;
380.RE
381.SH AUTHOR
382.EX
383Bert Muennich <ber.t at posteo.de>
384.EE
385.SH CONTRIBUTORS
386.EX
387Bastien Dejean <nihilhill at gmail.com>
388Dave Reisner <d at falconindy.com>
389Fung SzeTat <sthorde at gmail.com>
390.EE
391.SH HOMEPAGE
392.EX
393https://github.com/muennich/sxiv
394.EE
395.SH SEE ALSO
396.BR feh (1),
397.BR qiv (1)