Krolyxon
Commit 3e25238

Branches

Refs →

nsxivsxiv.1

311 lines · 5.8 KB · Groff/troff

Raw Blame History Download
1.TH SXIV 1 sxiv\-VERSION
2.SH NAME
3sxiv \- Simple (or small or suckless) X Image Viewer
4.SH SYNOPSIS
5.B sxiv
6.RB [ \-cdFfhpqrstvZ ]
7.RB [ \-g
8.IR GEOMETRY ]
9.RB [ \-n
10.IR NUM ]
11.RB [ \-z
12.IR ZOOM ]
13.IR FILE ...
14.SH DESCRIPTION
15sxiv is a simple image viewer for X. It only has the most basic features
16required for fast image viewing.
17.P
18sxiv opens all named
19.IR FILE s,
20or reads the names of the files to open from standard input, if only a single
21hyphen\-minus
22.RB ( \- )
23is given.
24.P
25sxiv has two modes of operation: image and thumbnail mode. The default is image
26mode, in which only the current image is shown. In thumbnail mode a grid of
27small previews is displayed, making it easy to choose an image to open.
28.P
29sxiv can also cache its thumbnails. Please see the section THUMBNAIL CACHING
30for information on how to enable this feature.
31.P
32Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
33manager.
34.SH OPTIONS
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 " GEOMETRY
50Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
51more information on
52.IR GEOMETRY .
53.TP
54.BI "\-n " NUM
55Start at picture number NUM.
56.TP
57.B \-h
58Print brief usage information to standard output and exit.
59.TP
60.B \-p
61Pixelize images, i.e. turn off anti-aliasing.
62.TP
63.B \-q
64Be quiet, disable warnings to standard error stream.
65.TP
66.B \-r
67Search the given directories recursively for images to view.
68.TP
69.B \-s
70Scale all images to fit into window.
71.TP
72.B \-t
73Start in thumbnail mode.
74.TP
75.B \-v
76Print version information to standard output and exit.
77.TP
78.B \-Z
79The same as `\-z 100'.
80.TP
81.BI "\-z " ZOOM
82Scale all images to the current zoom level, use a zoom level of
83.I ZOOM
84at startup.
85.SH GENERAL KEYBOARD COMMANDS
86The following keyboard commands are available in both image and thumbnail mode:
87.TP
88.B q
89Quit sxiv.
90.TP
91.B Return
92Switch to thumbnail mode / open selected image in image mode.
93.TP
94.BR 0 \- 9
95Prefix the next command with a number (denoted via
96.IR count ).
97.TP
98.B g
99Go to the first image.
100.TP
101.B G
102Go to the last image, or image number
103.IR count .
104.TP
105.B f
106Toggle fullscreen mode.
107.TP
108.B A
109Toggle visibility of alpha-channel, i.e. image transparency.
110.TP
111.B r
112Reload image.
113.TP
114.B D
115Remove current image from file list and go to next image.
116.SH THUMBNAIL KEYBOARD COMMANDS
117The following keyboard commands are only available in thumbnail mode:
118.TP
119.BR h ", " Left
120Move selection left.
121.TP
122.BR j ", " Down
123Move selection down.
124.TP
125.BR k ", " Up
126Move selection up.
127.TP
128.BR l ", " Right
129Move selection right.
130.SH IMAGE KEYBOARD COMMANDS
131The following keyboard commands are only available in image mode:
132.SS Navigate image list
133.TP
134.BR n ", " Space
135Go
136.I count
137images forward.
138.TP
139.BR p ", " Backspace
140Go
141.I count
142images backward.
143.TP
144.B [
145Go
146.I count
147* 10 images backward.
148.TP
149.B ]
150Go
151.I count
152* 10 images forward.
153.SS Handle multi-frame images
154.TP
155.B Ctrl-n
156Go to the next frame of a multi-frame image.
157.TP
158.B Ctrl-p
159Go to the previous frame of a multi-frame image.
160.TP
161.B Ctrl-Space
162Play/pause animation of a multi-frame image.
163.SS Zooming
164.TP
165.BR +
166Zoom in.
167.TP
168.B \-
169Zoom out.
170.TP
171.B =
172Set zoom level to 100%, or
173.IR count %.
174.TP
175.B w
176Set zoom level to fit image into window.
177.SS Panning
178.TP
179.BR h ", " Left
180Pan image 1/5 of window width or
181.I count
182pixel left.
183.TP
184.BR j ", " Down
185Pan image 1/5 of window height or
186.I count
187pixel down.
188.TP
189.BR k ", " Up
190Pan image 1/5 of window height or
191.I count
192pixel up.
193.TP
194.BR l ", " Right
195Pan image 1/5 of window width or
196.I count
197pixel right.
198.TP
199.B H
200Pan to left image edge.
201.TP
202.B J
203Pan to bottom image edge.
204.TP
205.B K
206Pan to top image edge.
207.TP
208.B L
209Pan to right image edge.
210.TP
211.BR Ctrl-h ", " Ctrl-Left
212Pan image one window width left.
213.TP
214.BR Ctrl-j ", " Ctrl-Down
215Pan image one window height down.
216.TP
217.BR Ctrl-k ", " Ctrl-Up
218Pan image one window height up.
219.TP
220.BR Ctrl-l ", " Ctrl-Right
221Pan image one window width right.
222.SS Rotation
223.TP
224.B <
225Rotate image counter-clockwise by 90 degrees.
226.TP
227.B >
228Rotate image clockwise by 90 degrees.
229.SS Slideshow
230.TP
231.B s
232Toggle slideshow.
233.TP
234.B Ctrl\-'\-'
235Decrease slideshow delay.
236.TP
237.B Ctrl-'+'
238Increase slideshow delay.
239.TP
240.B Ctrl-'='
241Reset slideshow delay to default value, or set it to
242.I count
243seconds.
244.SS Miscellaneous
245.TP
246.B a
247Toggle anti-aliasing.
248.TP
249.B W
250Resize window to fit image.
251.SH MOUSE COMMANDS
252The following mouse mappings are available in image mode:
253.SS Navigate image list
254.TP
255.B Button1
256Go to next image.
257.TP
258.B Button3
259Go to the previous image.
260.SS Zooming
261.TP
262.B Ctrl+ScrollUp
263Zoom in.
264.TP
265.B Ctrl+ScrollDown
266Zoom out.
267.SS Panning/Moving
268.TP
269.B Button2
270Drag the image with the mouse while keeping this button pressed down.
271.TP
272.B ScrollUp
273Pan image up.
274.TP
275.B ScrollDown
276Pan image down.
277.TP
278.B Shift+ScrollUp
279Pan image left.
280.TP
281.B Shift+ScrollDown
282Pan image right.
283.SH THUMBNAIL CACHING
284To enable thumbnail caching, please make sure to create the directory
285.I ~/.sxiv/
286with write permissions. sxiv will then store all thumbnails inside this
287directory, but it will not create this directory by itself. It rather uses the
288existance of this directory as an affirmation, that the user wants thumbnails
289to be cached.
290.P
291Use the command line option
292.I \-c
293to keep the cache directory clean by removing all orphaned cache files.
294Additionally, run the following command afterwards inside the cache directory
295to remove empty subdirectories:
296.P
297.RS
298find \-type d \-empty \-delete
299.RE
300.SH AUTHORS
301.EX
302Bert Muennich <ber.t at gmx.com>
303Dave Reisner <d at falconindy.com>
304Fung SzeTat <sthorde at gmail.com>
305.EE
306.SH HOMEPAGE
307.TP
308http://github.com/muennich/sxiv
309.SH SEE ALSO
310.BR feh (1),
311.BR qiv (1)