Krolyxon
Commit 6d261b4

Branches

Refs →

nsxivREADME.md

215 lines · 6.8 KB · Markdown

Raw Blame History Download
1![sxiv](http://muennich.github.com/sxiv/img/logo.png "sxiv")
2
3**Simple X Image Viewer**
4
5The primary goal of sxiv is to create an image viewer, which only has the most
6basic features required for fast image viewing (the ones I want). It has vi key
7bindings and works nicely with tiling window managers. Its code base should be
8kept small and clean to make it easy for you to dig into it and customize it
9for your needs.
10
11
12Features
13--------
14
15* Basic image operations, e.g. zooming, panning, rotating
16* Customizable key and mouse button mappings (in *config.h*)
17* Thumbnail mode: grid of selectable previews of all images
18* Ability to cache thumbnails for fast re-loading
19* Basic support for multi-frame images
20* Load all frames from GIF files and play GIF animations
21* Display image information in status bar
22
23
24Screenshots
25-----------
26
27**Image mode:**
28
29![Image](http://muennich.github.com/sxiv/img/image.png "Image mode")
30
31**Thumbnail mode:**
32
33![Thumb](http://muennich.github.com/sxiv/img/thumb.png "Thumb mode")
34
35
36Installation
37------------
38
39sxiv is built using the commands:
40
41 $ make
42 # make install
43
44Please note, that the latter one requires root privileges.
45By default, sxiv is installed using the prefix "/usr/local", so the full path
46of the executable will be "/usr/local/bin/sxiv".
47
48You can install sxiv into a directory of your choice by changing the second
49command to:
50
51 # make PREFIX="/your/dir" install
52
53The build-time specific settings of sxiv can be found in the file *config.h*.
54Please check and change them, so that they fit your needs.
55If the file *config.h* does not already exist, then you have to create it with
56the following command:
57
58 $ make config.h
59
60
61Usage
62-----
63
64Please see the [man page](http://muennich.github.com/sxiv/sxiv.1.html) for
65information on how to use sxiv.
66
67
68Download & Changelog
69--------------------
70
71You can [browse](https://github.com/muennich/sxiv) the source code repository
72on GitHub or get a copy using git with the following command:
73
74 git clone https://github.com/muennich/sxiv.git
75
76**Stable releases**
77
78**[v24](https://github.com/muennich/sxiv/archive/v24.tar.gz)**
79*(October 27, 2017)*
80
81 * Automatically reload the current image whenever it changes
82 * Support embedding into other X windows with -e (e.g. tabbed)
83 * New option -p prevents sxiv from creating cache and temporary files
84 * Simpler mouse mappings, the most basic features are accessible with the
85 mouse only (navigate, zoom, pan)
86
87**[v1.3.2](https://github.com/muennich/sxiv/archive/v1.3.2.tar.gz)**
88*(December 20, 2015)*
89
90 * external key handler gets file paths on stdin, not as arguments
91 * Cache out-of-view thumbnails in the background
92 * Apply gamma correction to thumbnails
93
94**[v1.3.1](https://github.com/muennich/sxiv/archive/v1.3.1.tar.gz)**
95*(November 16, 2014)*
96
97 * Fixed build error, caused by delayed config.h creation
98 * Fixed segfault when run with -c
99
100**[v1.3](https://github.com/muennich/sxiv/archive/v1.3.tar.gz)**
101*(October 24, 2014)*
102
103 * Extract thumbnails from EXIF tags (requires libexif)
104 * Zoomable thumbnails, supported sizes defined in config.h
105 * Fixed build error with giflib version >= 5.1.0
106
107**[v1.2](https://github.com/muennich/sxiv/archive/v1.2.tar.gz)**
108*(April 24, 2014)*
109
110 * Added external key handler, called on keys prefixed with `Ctrl-x`
111 * New keybinding `{`/`}` to change gamma (by András Mohari)
112 * Support for slideshows, enabled with `-S` option & toggled with `s`
113 * Added application icon (created by 0ion9)
114 * Checkerboard background for alpha layer
115 * Option `-o` only prints files marked with `m` key
116 * Fixed rotation/flipping of multi-frame images (gifs)
117
118**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
119*(June 2, 2013)*
120
121 * Various bug fixes
122
123**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
124*(March 30, 2013)*
125
126 * Added status bar on bottom of window with customizable content
127 * New keyboard shortcuts `\`/`|`: flip image vertically/horizontally
128 * New keyboard shortcut `Ctrl-6`: go to last/alternate image
129 * Added own EXIF orientation handling, removed dependency on libexif
130 * Fixed various bugs
131
132**[v1.0](https://github.com/muennich/sxiv/archive/v1.0.tar.gz)**
133*(October 31, 2011)*
134
135 * Support for multi-frame images & GIF animations
136 * POSIX compliant (IEEE Std 1003.1-2001)
137
138**[v0.9](https://github.com/muennich/sxiv/archive/v0.9.tar.gz)**
139*(August 17, 2011)*
140
141 * Made key and mouse mappings fully configurable in config.h
142 * Complete code refactoring
143
144**[v0.8.2](https://github.com/muennich/sxiv/archive/v0.8.2.tar.gz)**
145*(June 29, 2011)*
146
147 * POSIX-compliant Makefile; compiles under NetBSD
148
149**[v0.8.1](https://github.com/muennich/sxiv/archive/v0.8.1.tar.gz)**
150*(May 8, 2011)*
151
152 * Fixed fullscreen under window managers, which are not fully EWMH-compliant
153
154**[v0.8](https://github.com/muennich/sxiv/archive/v0.8.tar.gz)**
155*(April 18, 2011)*
156
157 * Support for thumbnail caching
158 * Ability to run external commands (e.g. jpegtran, convert) on current image
159
160**[v0.7](https://github.com/muennich/sxiv/archive/v0.7.tar.gz)**
161*(February 26, 2011)*
162
163 * Sort directory entries when using `-r` command line option
164 * Hide cursor in image mode
165 * Full functional thumbnail mode, use Return key to switch between image and
166 thumbnail mode
167
168**[v0.6](https://github.com/muennich/sxiv/archive/v0.6.tar.gz)**
169*(February 16, 2011)*
170
171 * Bug fix: Correctly display filenames with umlauts in window title
172 * Basic support of thumbnails
173
174**[v0.5](https://github.com/muennich/sxiv/archive/v0.5.tar.gz)**
175*(February 6, 2011)*
176
177 * New command line option: `-r`: open all images in given directories
178 * New key shortcuts: `w`: resize image to fit into window; `W`: resize window
179 to fit to image
180
181**[v0.4](https://github.com/muennich/sxiv/archive/v0.4.tar.gz)**
182*(February 1, 2011)*
183
184 * New command line option: `-F`, `-g`: use fixed window dimensions and apply
185 a given window geometry
186 * New key shortcut: `r`: reload current image
187
188**[v0.3.1](https://github.com/muennich/sxiv/archive/v0.3.1.tar.gz)**
189*(January 30, 2011)*
190
191 * Bug fix: Do not set setuid bit on executable when using `make install`
192 * Pan image with mouse while pressing middle mouse button
193
194**[v0.3](https://github.com/muennich/sxiv/archive/v0.3.tar.gz)**
195*(January 29, 2011)*
196
197 * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z`
198 * More mouse mappings: Go to next/previous image with left/right click,
199 scroll image with mouse wheel (horizontally if Shift key is pressed),
200 zoom image with mouse wheel if Ctrl key is pressed
201
202**[v0.2](https://github.com/muennich/sxiv/archive/v0.2.tar.gz)**
203*(January 23, 2011)*
204
205 * Bug fix: Handle window resizes correctly
206 * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10
207 images back/forward
208 * Support for mouse wheel zooming (by Dave Reisner)
209 * Added fullscreen mode
210
211**[v0.1](https://github.com/muennich/sxiv/archive/v0.1.tar.gz)**
212*(January 21, 2011)*
213
214 * Initial release
215