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