Krolyxon
Commit e267dc7

Branches

Refs →

nsxivREADME.md

272 lines · 9.4 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 m Mark/unmark current image
105 M Reverse all image marks
106 N Go [count] marked images forward
107 P Go [count] marked images backward
108
109*Thumbnail mode:*
110
111 h,j,k,l Move selection left/down/up/right [count] times (also with
112 arrow keys)
113 R Reload all thumbnails
114
115*Image mode:*
116
117 n,Space Go [count] images forward
118 p,Backspace Go [count] images backward
119 [,] Go [count] * 10 images backward/forward
120 Ctrl-n,p Go to the next/previous frame of a multi-frame image
121 Ctrl-Space Play/stop animations of multi-frame images
122 h,j,k,l Scroll image 1/5 of window width/height or [count] pixels
123 left/down/up/right (also with arrow keys)
124 H,J,K,L Scroll to left/bottom/top/right image edge
125 + Zoom in
126 - Zoom out
127 = Set zoom level to 100%, or [count]%
128 w Set zoom level to 100%, but fit large images into window
129 W Fit image to window
130 e Fit image to window width
131 E Fit image to window height
132 <,> Rotate image (counter-)clockwise by 90 degrees
133 ? Rotate image by 180 degrees
134 |,_ Flip image horizontally/vertically
135 {,} Decrease/increase gamma
136 Ctrl-g Reset gamma
137 a Toggle anti-aliasing
138 A Toggle visibility of alpha-channel, i.e. transparency
139 s Toggle slideshow or set delay to [count] seconds
140
141
142**Mouse button mappings:**
143
144*Image mode:*
145
146 Button1 Go to the next image
147 Button3 Go to the previous image
148 Button2 Drag image with mouse while keeping it pressed
149 Wheel Scroll image up/down
150 Shift+Wheel Scroll image left/right
151 Ctrl+Wheel Zoom in/out
152
153
154Download & Changelog
155--------------------
156
157You can [browse](https://github.com/muennich/sxiv) the source code repository
158on GitHub or get a copy using git with the following command:
159
160 git clone https://github.com/muennich/sxiv.git
161
162**Stable releases**
163
164**[v1.2](https://github.com/muennich/sxiv/archive/v1.2.tar.gz)**
165*(April 24, 2014)*
166
167 * Added external key handler, called on keys prefixed with `Ctrl-x`
168 * New keybinding `{`/`}` to change gamma (by András Mohari)
169 * Support for slideshows, enabled with `-S` option & toggled with `s`
170 * Added application icon (created by 0ion9)
171 * Checkerboard background for alpha layer
172 * Option `-o` only prints files marked with `m` key
173 * Fixed rotation/flipping of multi-frame images (gifs)
174
175**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
176*(June 2, 2013)*
177
178 * Various bug fixes
179
180**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
181*(March 30, 2013)*
182
183 * Added status bar on bottom of window with customizable content
184 * New keyboard shortcuts `\`/`|`: flip image vertically/horizontally
185 * New keyboard shortcut `Ctrl-6`: go to last/alternate image
186 * Added own EXIF orientation handling, removed dependency on libexif
187 * Fixed various bugs
188
189**[v1.0](https://github.com/muennich/sxiv/archive/v1.0.tar.gz)**
190*(October 31, 2011)*
191
192 * Support for multi-frame images & GIF animations
193 * POSIX compliant (IEEE Std 1003.1-2001)
194
195**[v0.9](https://github.com/muennich/sxiv/archive/v0.9.tar.gz)**
196*(August 17, 2011)*
197
198 * Made key and mouse mappings fully configurable in config.h
199 * Complete code refactoring
200
201**[v0.8.2](https://github.com/muennich/sxiv/archive/v0.8.2.tar.gz)**
202*(June 29, 2011)*
203
204 * POSIX-compliant Makefile; compiles under NetBSD
205
206**[v0.8.1](https://github.com/muennich/sxiv/archive/v0.8.1.tar.gz)**
207*(May 8, 2011)*
208
209 * Fixed fullscreen under window managers, which are not fully EWMH-compliant
210
211**[v0.8](https://github.com/muennich/sxiv/archive/v0.8.tar.gz)**
212*(April 18, 2011)*
213
214 * Support for thumbnail caching
215 * Ability to run external commands (e.g. jpegtran, convert) on current image
216
217**[v0.7](https://github.com/muennich/sxiv/archive/v0.7.tar.gz)**
218*(February 26, 2011)*
219
220 * Sort directory entries when using `-r` command line option
221 * Hide cursor in image mode
222 * Full functional thumbnail mode, use Return key to switch between image and
223 thumbnail mode
224
225**[v0.6](https://github.com/muennich/sxiv/archive/v0.6.tar.gz)**
226*(February 16, 2011)*
227
228 * Bug fix: Correctly display filenames with umlauts in window title
229 * Basic support of thumbnails
230
231**[v0.5](https://github.com/muennich/sxiv/archive/v0.5.tar.gz)**
232*(February 6, 2011)*
233
234 * New command line option: `-r`: open all images in given directories
235 * New key shortcuts: `w`: resize image to fit into window; `W`: resize window
236 to fit to image
237
238**[v0.4](https://github.com/muennich/sxiv/archive/v0.4.tar.gz)**
239*(February 1, 2011)*
240
241 * New command line option: `-F`, `-g`: use fixed window dimensions and apply
242 a given window geometry
243 * New key shortcut: `r`: reload current image
244
245**[v0.3.1](https://github.com/muennich/sxiv/archive/v0.3.1.tar.gz)**
246*(January 30, 2011)*
247
248 * Bug fix: Do not set setuid bit on executable when using `make install`
249 * Pan image with mouse while pressing middle mouse button
250
251**[v0.3](https://github.com/muennich/sxiv/archive/v0.3.tar.gz)**
252*(January 29, 2011)*
253
254 * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z`
255 * More mouse mappings: Go to next/previous image with left/right click,
256 scroll image with mouse wheel (horizontally if Shift key is pressed),
257 zoom image with mouse wheel if Ctrl key is pressed
258
259**[v0.2](https://github.com/muennich/sxiv/archive/v0.2.tar.gz)**
260*(January 23, 2011)*
261
262 * Bug fix: Handle window resizes correctly
263 * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10
264 images back/forward
265 * Support for mouse wheel zooming (by Dave Reisner)
266 * Added fullscreen mode
267
268**[v0.1](https://github.com/muennich/sxiv/archive/v0.1.tar.gz)**
269*(January 21, 2011)*
270
271 * Initial release
272