Krolyxon
Commit 43a04c4

Branches

Refs →

nsxivsxiv.1

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