Krolyxon
Commit d15264e

Branches

Refs →

nsxivsxiv.1

228 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 [ \-aCdFfhpqrstvZ ]
7.RB [ \-g
8.IR GEOMETRY ]
9.RB [ \-z
10.IR ZOOM ]
11.IR FILE ...
12.SH DESCRIPTION
13sxiv is a simple image viewer for X. It only has the most basic features
14required for fast image viewing.
15.P
16sxiv opens all named
17.IR FILE s,
18or reads the names of the files to open from standard input, if only a single
19hyphen\-minus
20.RB ( \- )
21is given.
22.P
23sxiv has two modes of operation: image and thumbnail mode. The default is image
24mode, in which only the current image is shown. In thumbnail mode a grid of
25small previews is displayed, making it easy to choose an image to open.
26.P
27sxiv can also cache its thumbnails. Please see the section THUMBNAIL CACHING
28for information on how to enable this feature.
29.P
30Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
31manager.
32.SH OPTIONS
33.TP
34.B \-a
35Display all given files, do not filter out unsupported files. This might result
36in a much shorter startup time, when the file list is very long or contains
37large files of slow loadable types, e.g. gif and progressive jpg.
38.TP
39.B \-C
40Remove all orphaned cache files from the thumbnail cache directory and exit.
41.TP
42.B \-d
43Scale all images to 100%, but fit large images into window.
44.TP
45.B \-F
46Make the window fixed/floating by setting the minimum and maximum width/height
47size-hints to the window width/height.
48.TP
49.B \-f
50Start in fullscreen mode.
51.TP
52.BI "\-g " GEOMETRY
53Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
54more information on
55.IR GEOMETRY .
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.SS Rotation
141.TP
142.B <
143Rotate image counter-clockwise by 90 degrees.
144.TP
145.B >
146Rotate image clockwise by 90 degrees.
147.SS Control window
148.TP
149.B W
150Resize window to fit image.
151.TP
152.B f
153Toggle fullscreen mode.
154.SS Miscellaneous
155.TP
156.B a
157Toggle anti-aliasing.
158.TP
159.B A
160Toggle visibility of alpha-channel, i.e. image transparency.
161.TP
162.B D
163Remove current [selected] image from file list and go to [select] next image.
164.TP
165.B r
166Reload image.
167.SH MOUSE COMMANDS
168The differences of the following mouse mappings between image view and
169thumbnail mode are denoted via brackets.
170.SS Navigate image list
171.TP
172.B Button1
173Go to [select/open] next image.
174.TP
175.B Button3
176Go to the previous image.
177.SS Zooming
178.TP
179.B Ctrl+ScrollUp
180Zoom in.
181.TP
182.B Ctrl+ScrollDown
183Zoom out.
184.SS Panning/Moving
185.TP
186.B Button2
187Drag the image with the mouse while keeping this button pressed down.
188.TP
189.B ScrollUp
190Pan image up [scroll up one thumbnail row].
191.TP
192.B ScrollDown
193Pan image down [scroll down one thumbnail row].
194.TP
195.B Shift+ScrollUp
196Pan image left.
197.TP
198.B Shift+ScrollDown
199Pan image right.
200.SH THUMBNAIL CACHING
201To enable thumbnail caching, please make sure to create the directory
202.I ~/.sxiv/
203with write permissions. sxiv will then store all thumbnails inside this
204directory, but it will not create this directory by itself. It rather uses the
205existance of this directory as an affirmation, that the user wants thumbnails
206to be cached.
207.P
208Use the command line option
209.I \-C
210to keep the cache directory clean by removing all orphaned cache files.
211Additionally, run the following command afterwards inside the cache directory
212to remove empty subdirectories:
213.P
214.RS
215find -type d -empty -delete
216.RE
217.SH AUTHORS
218.EX
219Bert Muennich <ber.t at gmx.com>
220Dave Reisner <d at falconindy.com>
221Fung SzeTat <sthorde at gmail.com>
222.EE
223.SH HOMEPAGE
224.TP
225http://github.com/muennich/sxiv
226.SH SEE ALSO
227.BR feh (1),
228.BR qiv (1)