Krolyxon
Commit 5f82011

Branches

Refs →

nsxivsxiv.1

223 lines · 4.6 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 [ \-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 \-C
35Remove all orphaned cache files from the thumbnail cache directory and exit.
36.TP
37.B \-d
38Scale all images to 100%, but fit large images into window.
39.TP
40.B \-F
41Make the window fixed/floating by setting the minimum and maximum width/height
42size-hints to the window width/height.
43.TP
44.B \-f
45Start in fullscreen mode.
46.TP
47.BI "\-g " GEOMETRY
48Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
49more information on
50.IR GEOMETRY .
51.TP
52.B \-h
53Print brief usage information to standard output and exit.
54.TP
55.B \-p
56Pixelize images, i.e. turn off anti-aliasing.
57.TP
58.B \-q
59Be quiet, disable warnings to standard error stream.
60.TP
61.B \-r
62Search the given directories recursively for images to view.
63.TP
64.B \-s
65Scale all images to fit into window.
66.TP
67.B \-t
68Start in thumbnail mode.
69.TP
70.B \-v
71Print version information to standard output and exit.
72.TP
73.B \-Z
74The same as `-z 100'.
75.TP
76.BI "\-z " ZOOM
77Scale all images to the current zoom level, use a zoom level of
78.I ZOOM
79at startup.
80.SH KEYBOARD COMMANDS
81The differences of the following key mappings between image view and thumbnail
82mode are denoted via brackets.
83.SS General
84.TP
85.B q
86Quit sxiv.
87.TP
88.B Return
89Switch to thumbnail mode [open selected image].
90.SS Navigate image list
91.TP
92.BR n ", " Space
93Go to the next image.
94.TP
95.BR p ", " Backspace
96Go to the previous image.
97.TP
98.B g
99Go to [select] the first image.
100.TP
101.B G
102Go to [select] the last image.
103.TP
104.B [
105Go 10 images backward.
106.TP
107.B ]
108Go 10 images forward.
109.SS Zooming
110.TP
111.BR + ", " =
112Zoom in.
113.TP
114.B \-
115Zoom out.
116.TP
117.B 0
118Set zoom level to 100%.
119.TP
120.B w
121Set zoom level to fit image into window.
122.SS Panning/Moving
123.TP
124.BR h ", " Left
125Pan image [move selection] left.
126.TP
127.BR j ", " Down
128Pan image [move selection] down.
129.TP
130.BR k ", " Up
131Pan image [move selection] up.
132.TP
133.BR l ", " Right
134Pan image [move selection] right.
135.SS Rotation
136.TP
137.B <
138Rotate image counter-clockwise by 90 degrees.
139.TP
140.B >
141Rotate image clockwise by 90 degrees.
142.SS Control window
143.TP
144.B W
145Resize window to fit image.
146.TP
147.B f
148Toggle fullscreen mode.
149.SS Miscellaneous
150.TP
151.B a
152Toggle anti-aliasing.
153.TP
154.B A
155Toggle visibility of alpha-channel, i.e. image transparency.
156.TP
157.B D
158Remove current [selected] image from file list and go to [select] next image.
159.TP
160.B r
161Reload image.
162.SH MOUSE COMMANDS
163The differences of the following mouse mappings between image view and
164thumbnail mode are denoted via brackets.
165.SS Navigate image list
166.TP
167.B Button1
168Go to [select/open] next image.
169.TP
170.B Button3
171Go to the previous image.
172.SS Zooming
173.TP
174.B Ctrl+ScrollUp
175Zoom in.
176.TP
177.B Ctrl+ScrollDown
178Zoom out.
179.SS Panning/Moving
180.TP
181.B Button2
182Drag the image with the mouse while keeping this button pressed down.
183.TP
184.B ScrollUp
185Pan image up [scroll up one thumbnail row].
186.TP
187.B ScrollDown
188Pan image down [scroll down one thumbnail row].
189.TP
190.B Shift+ScrollUp
191Pan image left.
192.TP
193.B Shift+ScrollDown
194Pan image right.
195.SH THUMBNAIL CACHING
196To enable thumbnail caching, please make sure to create the directory
197.I ~/.sxiv/
198with write permissions. sxiv will then store all thumbnails inside this
199directory, but it will not create this directory by itself. It rather uses the
200existance of this directory as an affirmation, that the user wants thumbnails
201to be cached.
202.P
203Use the command line option
204.I \-C
205to keep the cache directory clean by removing all orphaned cache files.
206Additionally, run the following command afterwards inside the cache directory
207to remove empty subdirectories:
208.P
209.RS
210find -type d -empty -delete
211.RE
212.SH AUTHORS
213.EX
214Bert Muennich <ber.t at gmx.com>
215Dave Reisner <d at falconindy.com>
216Fung SzeTat <sthorde at gmail.com>
217.EE
218.SH HOMEPAGE
219.TP
220http://github.com/muennich/sxiv
221.SH SEE ALSO
222.BR feh (1),
223.BR qiv (1)