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