Krolyxon
Commit 1cdbeb9

Branches

Refs →

nsxivsxiv.1

317 lines · 5.9 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.TP
131.BR Ctrl-j ", " Ctrl-Down
132Scroll thumbnail grid one window height down.
133.TP
134.BR Ctrl-k ", " Ctrl-Up
135Scroll thumbnail grid one window height up.
136.SH IMAGE KEYBOARD COMMANDS
137The following keyboard commands are only available in image mode:
138.SS Navigate image list
139.TP
140.BR n ", " Space
141Go
142.I count
143images forward.
144.TP
145.BR p ", " Backspace
146Go
147.I count
148images backward.
149.TP
150.B [
151Go
152.I count
153* 10 images backward.
154.TP
155.B ]
156Go
157.I count
158* 10 images forward.
159.SS Handle multi-frame images
160.TP
161.B Ctrl-n
162Go to the next frame of a multi-frame image.
163.TP
164.B Ctrl-p
165Go to the previous frame of a multi-frame image.
166.TP
167.B Ctrl-Space
168Play/pause animation of a multi-frame image.
169.SS Zooming
170.TP
171.BR +
172Zoom in.
173.TP
174.B \-
175Zoom out.
176.TP
177.B =
178Set zoom level to 100%, or
179.IR count %.
180.TP
181.B w
182Set zoom level to fit image into window.
183.SS Panning
184.TP
185.BR h ", " Left
186Pan image 1/5 of window width or
187.I count
188pixel left.
189.TP
190.BR j ", " Down
191Pan image 1/5 of window height or
192.I count
193pixel down.
194.TP
195.BR k ", " Up
196Pan image 1/5 of window height or
197.I count
198pixel up.
199.TP
200.BR l ", " Right
201Pan image 1/5 of window width or
202.I count
203pixel right.
204.TP
205.B H
206Pan to left image edge.
207.TP
208.B J
209Pan to bottom image edge.
210.TP
211.B K
212Pan to top image edge.
213.TP
214.B L
215Pan to right image edge.
216.TP
217.BR Ctrl-h ", " Ctrl-Left
218Pan image one window width left.
219.TP
220.BR Ctrl-j ", " Ctrl-Down
221Pan image one window height down.
222.TP
223.BR Ctrl-k ", " Ctrl-Up
224Pan image one window height up.
225.TP
226.BR Ctrl-l ", " Ctrl-Right
227Pan image one window width right.
228.SS Rotation
229.TP
230.B <
231Rotate image counter-clockwise by 90 degrees.
232.TP
233.B >
234Rotate image clockwise by 90 degrees.
235.SS Slideshow
236.TP
237.B s
238Toggle slideshow.
239.TP
240.B Ctrl\-'\-'
241Decrease slideshow delay.
242.TP
243.B Ctrl-'+'
244Increase slideshow delay.
245.TP
246.B Ctrl-'='
247Reset slideshow delay to default value, or set it to
248.I count
249seconds.
250.SS Miscellaneous
251.TP
252.B a
253Toggle anti-aliasing.
254.TP
255.B W
256Resize window to fit image.
257.SH MOUSE COMMANDS
258The following mouse mappings are available in image mode:
259.SS Navigate image list
260.TP
261.B Button1
262Go to next image.
263.TP
264.B Button3
265Go to the previous image.
266.SS Zooming
267.TP
268.B Ctrl+ScrollUp
269Zoom in.
270.TP
271.B Ctrl+ScrollDown
272Zoom out.
273.SS Panning/Moving
274.TP
275.B Button2
276Drag the image with the mouse while keeping this button pressed down.
277.TP
278.B ScrollUp
279Pan image up.
280.TP
281.B ScrollDown
282Pan image down.
283.TP
284.B Shift+ScrollUp
285Pan image left.
286.TP
287.B Shift+ScrollDown
288Pan image right.
289.SH THUMBNAIL CACHING
290To enable thumbnail caching, please make sure to create the directory
291.I ~/.sxiv/
292with write permissions. sxiv will then store all thumbnails inside this
293directory, but it will not create this directory by itself. It rather uses the
294existance of this directory as an affirmation, that the user wants thumbnails
295to be cached.
296.P
297Use the command line option
298.I \-c
299to keep the cache directory clean by removing all orphaned cache files.
300Additionally, run the following command afterwards inside the cache directory
301to remove empty subdirectories:
302.P
303.RS
304find \-type d \-empty \-delete
305.RE
306.SH AUTHORS
307.EX
308Bert Muennich <ber.t at gmx.com>
309Dave Reisner <d at falconindy.com>
310Fung SzeTat <sthorde at gmail.com>
311.EE
312.SH HOMEPAGE
313.TP
314http://github.com/muennich/sxiv
315.SH SEE ALSO
316.BR feh (1),
317.BR qiv (1)