Krolyxon
Commit 06164c2

Branches

Refs →

nsxivREADME.md

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