Krolyxon
Commit d5b8242

Branches

Refs →

nsxivREADME.md

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