Krolyxon
Commit 5dc7993

Branches

Refs →

nsxivREADME.md

286 lines · 9.9 KB · Markdown

Raw Blame History Download
1![sxiv](http://muennich.github.com/sxiv/img/logo.png "sxiv")
2
3**Simple X Image Viewer**
4
5sxiv is an alternative to feh and qiv. Its only dependencies besides xlib are
6imlib2, libexif and giflib. The primary goal for writing sxiv is to create an
7image viewer, which only has the most basic features required for fast image
8viewing (the ones I want). It has vi key bindings and works nicely with tiling
9window managers. Its code base should be kept small and clean to make it easy
10for you to dig into it and customize it for your needs.
11
12
13Features
14--------
15
16* Basic image operations, e.g. zooming, panning, rotating
17* Customizable key and mouse button mappings (in *config.h*)
18* Thumbnail mode: grid of selectable previews of all images
19* Ability to cache thumbnails for fast re-loading
20* Basic support for multi-frame images
21* Load all frames from GIF files and play GIF animations
22* Display image information in status bar
23
24
25Screenshots
26-----------
27
28**Image mode:**
29
30![Image](http://muennich.github.com/sxiv/img/image.png "Image mode")
31
32**Thumbnail mode:**
33
34![Thumb](http://muennich.github.com/sxiv/img/thumb.png "Thumb mode")
35
36
37Installation
38------------
39
40sxiv is built using the commands:
41
42 $ make
43 # make install
44
45Please note, that the latter one requires root privileges.
46By default, sxiv is installed using the prefix "/usr/local", so the full path
47of the executable will be "/usr/local/bin/sxiv".
48
49You can install sxiv into a directory of your choice by changing the second
50command to:
51
52 # make PREFIX="/your/dir" install
53
54The build-time specific settings of sxiv can be found in the file *config.h*.
55Please check and change them, so that they fit your needs.
56If the file *config.h* does not already exist, then you have to create it with
57the following command:
58
59 $ make config.h
60
61
62Usage
63-----
64
65sxiv has two modes of operation: image and thumbnail mode. The default is
66image mode, in which only the current image is shown. In thumbnail mode a grid
67of small previews is displayed, making it easy to choose an image to open.
68
69**Command line options:**
70
71 -a Play animations of multi-frame images
72 -b Do not show info bar on bottom of window
73 -c Remove all orphaned cache files from thumbnail cache and exit
74 -f Start in fullscreen mode
75 -G GAMMA Set image gamma to GAMMA (-32..32)
76 -g GEOMETRY Set window position and size
77 (see section GEOMETRY SPECIFICATIONS of X(7))
78 -i Read file list from stdin
79 -N NAME Set X window resource name to NAME
80 -n NUM Start at picture NUM
81 -o Write list of marked files to stdout when quitting
82 -q Be quiet, disable warnings
83 -r Search given directories recursively for images
84 -S DELAY Enable slideshow and set slideshow delay to DELAY seconds
85 -s MODE Set scale mode to MODE ([d]own, [f]it, [w]idth, [h]eight)
86 -t Start in thumbnail mode
87 -v Print version information and exit
88 -Z Same as `-z 100'
89 -z ZOOM Set zoom level to ZOOM percent
90
91**Key mappings:**
92
93 0-9 Prefix the next command with a number (denoted via [count])
94 q Quit sxiv
95 Return Switch to thumbnail mode / open selected image
96 f Toggle fullscreen mode
97 b Toggle visibility of info bar on bottom of window
98 Ctrl-x Send the next key to the external key-handler
99 g Go to first image
100 G Go to the last image, or image number [count]
101 r Reload image
102 D Remove image from file list and go to next image
103 Ctrl-h,j,k,l Scroll one window width/height left/down/up/right
104 + Zoom in
105 - Zoom out
106 m Mark/unmark current image
107 M Reverse all image marks
108 Ctrl-m Remove all image marks
109 N Go [count] marked images forward
110 P Go [count] marked images backward
111 {,} Decrease/increase gamma correction by [count] steps
112 Ctrl-g Reset gamma correction
113
114*Thumbnail mode:*
115
116 h,j,k,l Move selection left/down/up/right [count] times (also with
117 arrow keys)
118 R Reload all thumbnails
119
120*Image mode:*
121
122 n,Space Go [count] images forward
123 p,Backspace Go [count] images backward
124 [,] Go [count] * 10 images backward/forward
125 Ctrl-n,p Go to the next/previous frame of a multi-frame image
126 Ctrl-Space Play/stop animations of multi-frame images
127 h,j,k,l Scroll image 1/5 of window width/height or [count] pixels
128 left/down/up/right (also with arrow keys)
129 H,J,K,L Scroll to left/bottom/top/right image edge
130 = Set zoom level to 100%, or [count]%
131 w Set zoom level to 100%, but fit large images into window
132 W Fit image to window
133 e Fit image to window width
134 E Fit image to window height
135 <,> Rotate image (counter-)clockwise by 90 degrees
136 ? Rotate image by 180 degrees
137 |,_ Flip image horizontally/vertically
138 a Toggle anti-aliasing
139 A Toggle visibility of alpha-channel, i.e. transparency
140 s Toggle slideshow or set delay to [count] seconds
141
142
143**Mouse button mappings:**
144
145*Image mode:*
146
147 Button1 Go to the next image
148 Button3 Go to the previous image
149 Button2 Drag image with mouse while keeping it pressed
150 Wheel Scroll image up/down
151 Shift+Wheel Scroll image left/right
152 Ctrl+Wheel Zoom in/out
153
154
155Download & Changelog
156--------------------
157
158You can [browse](https://github.com/muennich/sxiv) the source code repository
159on GitHub or get a copy using git with the following command:
160
161 git clone https://github.com/muennich/sxiv.git
162
163**Stable releases**
164
165**[v1.3.1](https://github.com/muennich/sxiv/archive/v1.3.1.tar.gz)**
166*(November 16, 2014)*
167
168 * Fixed build error, caused by delayed config.h creation
169 * Fixed segfault when run with -c
170
171**[v1.3](https://github.com/muennich/sxiv/archive/v1.3.tar.gz)**
172*(October 24, 2014)*
173
174 * Extract thumbnails from EXIF tags (requires libexif)
175 * Zoomable thumbnails, supported sizes defined in config.h
176 * Fixed build error with giflib version >= 5.1.0
177
178**[v1.2](https://github.com/muennich/sxiv/archive/v1.2.tar.gz)**
179*(April 24, 2014)*
180
181 * Added external key handler, called on keys prefixed with `Ctrl-x`
182 * New keybinding `{`/`}` to change gamma (by András Mohari)
183 * Support for slideshows, enabled with `-S` option & toggled with `s`
184 * Added application icon (created by 0ion9)
185 * Checkerboard background for alpha layer
186 * Option `-o` only prints files marked with `m` key
187 * Fixed rotation/flipping of multi-frame images (gifs)
188
189**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
190*(June 2, 2013)*
191
192 * Various bug fixes
193
194**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
195*(March 30, 2013)*
196
197 * Added status bar on bottom of window with customizable content
198 * New keyboard shortcuts `\`/`|`: flip image vertically/horizontally
199 * New keyboard shortcut `Ctrl-6`: go to last/alternate image
200 * Added own EXIF orientation handling, removed dependency on libexif
201 * Fixed various bugs
202
203**[v1.0](https://github.com/muennich/sxiv/archive/v1.0.tar.gz)**
204*(October 31, 2011)*
205
206 * Support for multi-frame images & GIF animations
207 * POSIX compliant (IEEE Std 1003.1-2001)
208
209**[v0.9](https://github.com/muennich/sxiv/archive/v0.9.tar.gz)**
210*(August 17, 2011)*
211
212 * Made key and mouse mappings fully configurable in config.h
213 * Complete code refactoring
214
215**[v0.8.2](https://github.com/muennich/sxiv/archive/v0.8.2.tar.gz)**
216*(June 29, 2011)*
217
218 * POSIX-compliant Makefile; compiles under NetBSD
219
220**[v0.8.1](https://github.com/muennich/sxiv/archive/v0.8.1.tar.gz)**
221*(May 8, 2011)*
222
223 * Fixed fullscreen under window managers, which are not fully EWMH-compliant
224
225**[v0.8](https://github.com/muennich/sxiv/archive/v0.8.tar.gz)**
226*(April 18, 2011)*
227
228 * Support for thumbnail caching
229 * Ability to run external commands (e.g. jpegtran, convert) on current image
230
231**[v0.7](https://github.com/muennich/sxiv/archive/v0.7.tar.gz)**
232*(February 26, 2011)*
233
234 * Sort directory entries when using `-r` command line option
235 * Hide cursor in image mode
236 * Full functional thumbnail mode, use Return key to switch between image and
237 thumbnail mode
238
239**[v0.6](https://github.com/muennich/sxiv/archive/v0.6.tar.gz)**
240*(February 16, 2011)*
241
242 * Bug fix: Correctly display filenames with umlauts in window title
243 * Basic support of thumbnails
244
245**[v0.5](https://github.com/muennich/sxiv/archive/v0.5.tar.gz)**
246*(February 6, 2011)*
247
248 * New command line option: `-r`: open all images in given directories
249 * New key shortcuts: `w`: resize image to fit into window; `W`: resize window
250 to fit to image
251
252**[v0.4](https://github.com/muennich/sxiv/archive/v0.4.tar.gz)**
253*(February 1, 2011)*
254
255 * New command line option: `-F`, `-g`: use fixed window dimensions and apply
256 a given window geometry
257 * New key shortcut: `r`: reload current image
258
259**[v0.3.1](https://github.com/muennich/sxiv/archive/v0.3.1.tar.gz)**
260*(January 30, 2011)*
261
262 * Bug fix: Do not set setuid bit on executable when using `make install`
263 * Pan image with mouse while pressing middle mouse button
264
265**[v0.3](https://github.com/muennich/sxiv/archive/v0.3.tar.gz)**
266*(January 29, 2011)*
267
268 * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z`
269 * More mouse mappings: Go to next/previous image with left/right click,
270 scroll image with mouse wheel (horizontally if Shift key is pressed),
271 zoom image with mouse wheel if Ctrl key is pressed
272
273**[v0.2](https://github.com/muennich/sxiv/archive/v0.2.tar.gz)**
274*(January 23, 2011)*
275
276 * Bug fix: Handle window resizes correctly
277 * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10
278 images back/forward
279 * Support for mouse wheel zooming (by Dave Reisner)
280 * Added fullscreen mode
281
282**[v0.1](https://github.com/muennich/sxiv/archive/v0.1.tar.gz)**
283*(January 21, 2011)*
284
285 * Initial release
286