Krolyxon
Commit b418df7

Branches

Refs →

nsxivsxiv.1

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