Krolyxon
Commit 2252a01

Branches

Refs →

nsxivsxiv.1

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