Krolyxon
Commit 32a6520

Branches

Refs →

nsxivsxiv.1

262 lines · 5.2 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 KEYBOARD COMMANDS
86The differences of the following key mappings between image view and thumbnail
87mode are denoted via brackets.
88.SS General
89.TP
90.B q
91Quit sxiv.
92.TP
93.B Return
94Switch to thumbnail mode [open selected image].
95.SS Navigate image list
96.TP
97.BR n ", " Space
98Go to the next image.
99.TP
100.BR p ", " Backspace
101Go to the previous image.
102.TP
103.B g
104Go to [select] the first image.
105.TP
106.B G
107Go to [select] the last image.
108.TP
109.B [
110Go 10 images backward.
111.TP
112.B ]
113Go 10 images forward.
114.SS Handle multi-frame images
115.TP
116.B Ctrl-n
117Go to the next frame of a multi-frame image.
118.TP
119.B Ctrl-p
120Go to the previous frame of a multi-frame image.
121.TP
122.B Ctrl-Space
123Play/pause animation of a multi-frame image.
124.SS Zooming
125.TP
126.BR + ", " =
127Zoom in.
128.TP
129.B \-
130Zoom out.
131.TP
132.B 0
133Set zoom level to 100%.
134.TP
135.B w
136Set zoom level to fit image into window.
137.SS Panning/Moving
138.TP
139.BR h ", " Left
140Pan image [move selection] left.
141.TP
142.BR j ", " Down
143Pan image [move selection] down.
144.TP
145.BR k ", " Up
146Pan image [move selection] up.
147.TP
148.BR l ", " Right
149Pan image [move selection] right.
150.TP
151.B H
152Pan to left image edge.
153.TP
154.B J
155Pan to bottom image edge.
156.TP
157.B K
158Pan to top image edge.
159.TP
160.B L
161Pan to right image edge.
162.TP
163.BR Ctrl-h ", " Ctrl-Left
164Pan image one window width left.
165.TP
166.BR Ctrl-j ", " Ctrl-Down
167Pan image one window height down.
168.TP
169.BR Ctrl-k ", " Ctrl-Up
170Pan image one window height up.
171.TP
172.BR Ctrl-l ", " Ctrl-Right
173Pan image one window width right.
174.SS Rotation
175.TP
176.B <
177Rotate image counter-clockwise by 90 degrees.
178.TP
179.B >
180Rotate image clockwise by 90 degrees.
181.SS Control window
182.TP
183.B W
184Resize window to fit image.
185.TP
186.B f
187Toggle fullscreen mode.
188.SS Miscellaneous
189.TP
190.B a
191Toggle anti-aliasing.
192.TP
193.B A
194Toggle visibility of alpha-channel, i.e. image transparency.
195.TP
196.B D
197Remove current [selected] image from file list and go to [select] next image.
198.TP
199.B r
200Reload image.
201.SH MOUSE COMMANDS
202The differences of the following mouse mappings between image view and
203thumbnail mode are denoted via brackets.
204.SS Navigate image list
205.TP
206.B Button1
207Go to [select/open] next image.
208.TP
209.B Button3
210Go to the previous image.
211.SS Zooming
212.TP
213.B Ctrl+ScrollUp
214Zoom in.
215.TP
216.B Ctrl+ScrollDown
217Zoom out.
218.SS Panning/Moving
219.TP
220.B Button2
221Drag the image with the mouse while keeping this button pressed down.
222.TP
223.B ScrollUp
224Pan image up [scroll up one thumbnail row].
225.TP
226.B ScrollDown
227Pan image down [scroll down one thumbnail row].
228.TP
229.B Shift+ScrollUp
230Pan image left.
231.TP
232.B Shift+ScrollDown
233Pan image right.
234.SH THUMBNAIL CACHING
235To enable thumbnail caching, please make sure to create the directory
236.I ~/.sxiv/
237with write permissions. sxiv will then store all thumbnails inside this
238directory, but it will not create this directory by itself. It rather uses the
239existance of this directory as an affirmation, that the user wants thumbnails
240to be cached.
241.P
242Use the command line option
243.I \-c
244to keep the cache directory clean by removing all orphaned cache files.
245Additionally, run the following command afterwards inside the cache directory
246to remove empty subdirectories:
247.P
248.RS
249find \-type d \-empty \-delete
250.RE
251.SH AUTHORS
252.EX
253Bert Muennich <ber.t at gmx.com>
254Dave Reisner <d at falconindy.com>
255Fung SzeTat <sthorde at gmail.com>
256.EE
257.SH HOMEPAGE
258.TP
259http://github.com/muennich/sxiv
260.SH SEE ALSO
261.BR feh (1),
262.BR qiv (1)