| 1 | sxiv |
| 2 | ==== |
| 3 | |
| 4 | **Simple X Image Viewer** |
| 5 | |
| 6 | sxiv is an alternative to feh and qiv. Its only dependencies besides xlib are |
| 7 | imlib2 and giflib. The primary goal for writing sxiv is to create an image |
| 8 | viewer, which only has the most basic features required for fast image viewing |
| 9 | (the ones I want). It has vi key bindings and works nicely with tiling window |
| 10 | managers. Its code base should be kept small and clean to make it easy for you |
| 11 | to dig into it and customize it for your needs. |
| 12 | |
| 13 | |
| 14 | Features |
| 15 | -------- |
| 16 | |
| 17 | * Basic image operations, e.g. zooming, panning, rotating |
| 18 | * Customizable key and mouse button mappings (in *config.h*) |
| 19 | * Thumbnail mode: grid of selectable previews of all images |
| 20 | * Ability to cache thumbnails for fast re-loading |
| 21 | * Basic support for multi-frame images |
| 22 | * Load all frames from GIF files and play GIF animations |
| 23 | * Display image information in status bar |
| 24 | |
| 25 | |
| 26 | Screenshots |
| 27 | ----------- |
| 28 | |
| 29 | **Image mode:** |
| 30 | |
| 31 |  |
| 32 | |
| 33 | **Thumbnail mode:** |
| 34 | |
| 35 |  |
| 36 | |
| 37 | |
| 38 | Installation |
| 39 | ------------ |
| 40 | |
| 41 | sxiv is built using the commands: |
| 42 | |
| 43 | $ make |
| 44 | # make install |
| 45 | |
| 46 | Please note, that the latter one requires root privileges. |
| 47 | By default, sxiv is installed using the prefix "/usr/local", so the full path |
| 48 | of the executable will be "/usr/local/bin/sxiv". |
| 49 | |
| 50 | You can install sxiv into a directory of your choice by changing the second |
| 51 | command to: |
| 52 | |
| 53 | # make PREFIX="/your/dir" install |
| 54 | |
| 55 | The build-time specific settings of sxiv can be found in the file *config.h*. |
| 56 | Please check and change them, so that they fit your needs. |
| 57 | If the file *config.h* does not already exist, then you have to create it with |
| 58 | the following command: |
| 59 | |
| 60 | $ make config.h |
| 61 | |
| 62 | |
| 63 | Usage |
| 64 | ----- |
| 65 | sxiv has two modes of operation: image and thumbnail mode. The default is |
| 66 | image mode, in which only the current image is shown. In thumbnail mode a grid |
| 67 | of 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 | -d Scale all images to 100%, but fit large images into window |
| 74 | -F Use size-hints to make the window fixed/floating |
| 75 | -f Start in fullscreen mode |
| 76 | -g GEOMETRY Set window position and size |
| 77 | (see section GEOMETRY SPECIFICATIONS of X(7)) |
| 78 | -i Read file list from stdin |
| 79 | -n NUM Start at picture NUM |
| 80 | -N NAME Set X window resource name to NAME |
| 81 | -o Write file list to stdout when quitting |
| 82 | -p Pixelize, i.e. turn off image anti-aliasing |
| 83 | -q Be quiet, disable warnings |
| 84 | -r Search given directories recursively for images |
| 85 | -s Scale all images to fit into window |
| 86 | -t Start in thumbnail mode |
| 87 | -v Print version information and exit |
| 88 | -Z Same as `-z 100' |
| 89 | -z ZOOM Scale all images to current zoom level, use ZOOM at startup |
| 90 | |
| 91 | **Key mappings:** |
| 92 | |
| 93 | q Quit sxiv |
| 94 | Return Switch to thumbnail mode / open selected image |
| 95 | |
| 96 | 0-9 Prefix the next command with a number (denoted via [count]) |
| 97 | |
| 98 | g Go to first image |
| 99 | G Go to the last image, or image number [count] |
| 100 | |
| 101 | f Toggle fullscreen mode (requires an EWMH/NetWM compliant |
| 102 | window manager) |
| 103 | b Toggle visibility of info bar on bottom of window |
| 104 | A Toggle visibility of alpha-channel, i.e. transparency |
| 105 | |
| 106 | r Reload image |
| 107 | R Reload all thumbnails |
| 108 | D Remove image from file list and go to next image |
| 109 | |
| 110 | *Thumbnail mode:* |
| 111 | |
| 112 | h,j,k,l Move selection left/down/up/right [count] times |
| 113 | Ctrl-j,k Scroll thumbnail grid one window height down/up |
| 114 | |
| 115 | *Image mode:* |
| 116 | |
| 117 | n,Space Go [count] images forward |
| 118 | p,Backspace Go [count] images backward |
| 119 | [,] Go [count] * 10 images backward/forward |
| 120 | |
| 121 | Ctrl-n,p Go to the next/previous frame of a multi-frame image |
| 122 | Ctrl-Space Play/pause animation of a multi-frame image |
| 123 | |
| 124 | + Zoom in |
| 125 | - Zoom out |
| 126 | = Set zoom level to 100%, or [count]% |
| 127 | w Fit image into window |
| 128 | e Fit image width to window width |
| 129 | E Fit image height to window height |
| 130 | |
| 131 | h,j,k,l Pan image 1/5 of window width/height or [count] pixels |
| 132 | left/down/up/right (also with arrow keys) |
| 133 | H,J,K,L Pan to left/bottom/top/right image edge |
| 134 | Ctrl-h,j,k,l Pan image one window width/height left/down/up/right |
| 135 | (also with Ctrl-arrow keys) |
| 136 | |
| 137 | <,> Rotate image (counter-)clockwise by 90 degrees |
| 138 | \,| Flip image horizontally/vertically |
| 139 | |
| 140 | a Toggle anti-aliasing |
| 141 | W Resize window to fit image |
| 142 | |
| 143 | **Mouse button mappings:** |
| 144 | |
| 145 | *Image mode:* |
| 146 | |
| 147 | Button1 Go to the next image |
| 148 | Button2 Drag image with mouse while keeping it pressed |
| 149 | Button3 Go to the previous image |
| 150 | Scroll Pan image up/down |
| 151 | Shift+Scroll Pan image left/right |
| 152 | Ctrl+Scroll Zoom in/out |
| 153 | |
| 154 | |
| 155 | Download & Changelog |
| 156 | -------------------- |
| 157 | |
| 158 | You can [browse](https://github.com/muennich/sxiv) the source code repository |
| 159 | on GitHub or get a copy using git with the following command: |
| 160 | |
| 161 | git clone https://github.com/muennich/sxiv.git |
| 162 | |
| 163 | **Stable releases** |
| 164 | |
| 165 | **[v1.1](http://muennich.github.com/sxiv/release/sxiv-1.1.tar.gz)** |
| 166 | *(March 30, 2013)* |
| 167 | |
| 168 | * Added status bar on bottom of window with customizable content |
| 169 | * New keyboard shortcuts `\`/`|`: flip image vertically/horizontally |
| 170 | * New keyboard shortcut `Ctrl-6`: go to last/alternate image |
| 171 | * Added own EXIF orientation handling, removed dependency on libexif |
| 172 | * Fixed various bugs |
| 173 | |
| 174 | **[v1.0](http://muennich.github.com/sxiv/release/sxiv-1.0.tar.gz)** |
| 175 | *(October 31, 2011)* |
| 176 | |
| 177 | * Support for multi-frame images & GIF animations |
| 178 | * POSIX compliant (IEEE Std 1003.1-2001) |
| 179 | |
| 180 | **[v0.9](http://muennich.github.com/sxiv/release/sxiv-0.9.tar.gz)** |
| 181 | *(August 17, 2011)* |
| 182 | |
| 183 | * Made key and mouse mappings fully configurable in config.h |
| 184 | * Complete code refactoring |
| 185 | |
| 186 | **[v0.8.2](http://muennich.github.com/sxiv/release/sxiv-0.8.2.tar.gz)** |
| 187 | *(June 29, 2011)* |
| 188 | |
| 189 | * POSIX-compliant Makefile; compiles under NetBSD |
| 190 | |
| 191 | **[v0.8.1](http://muennich.github.com/sxiv/release/sxiv-0.8.1.tar.gz)** |
| 192 | *(May 8, 2011)* |
| 193 | |
| 194 | * Fixed fullscreen under window managers, which are not fully EWMH-compliant |
| 195 | |
| 196 | **[v0.8](http://muennich.github.com/sxiv/release/sxiv-0.8.tar.gz)** |
| 197 | *(April 18, 2011)* |
| 198 | |
| 199 | * Support for thumbnail caching, only enabled if directory `~/.sxiv/` exists |
| 200 | * Ability to run external commands (e.g. jpegtran, convert) on current image |
| 201 | |
| 202 | **[v0.7](http://muennich.github.com/sxiv/release/sxiv-0.7.tar.gz)** |
| 203 | *(February 26, 2011)* |
| 204 | |
| 205 | * Sort directory entries when using `-r` command line option |
| 206 | * Hide cursor in image mode |
| 207 | * Full functional thumbnail mode, use Return key to switch between image and |
| 208 | thumbnail mode |
| 209 | |
| 210 | **[v0.6](http://muennich.github.com/sxiv/release/sxiv-0.6.tar.gz)** |
| 211 | *(February 16, 2011)* |
| 212 | |
| 213 | * Bug fix: Correctly display filenames with umlauts in window title |
| 214 | * Basic support of thumbnails |
| 215 | |
| 216 | **[v0.5](http://muennich.github.com/sxiv/release/sxiv-0.5.tar.gz)** |
| 217 | *(February 6, 2011)* |
| 218 | |
| 219 | * New command line option: `-r`: open all images in given directories |
| 220 | * New key shortcuts: `w`: resize image to fit into window; `W`: resize window |
| 221 | to fit to image |
| 222 | |
| 223 | **[v0.4](http://muennich.github.com/sxiv/release/sxiv-0.4.tar.gz)** |
| 224 | *(February 1, 2011)* |
| 225 | |
| 226 | * New command line option: `-F`, `-g`: use fixed window dimensions and apply |
| 227 | a given window geometry |
| 228 | * New key shortcut: `r`: reload current image |
| 229 | |
| 230 | **[v0.3.1](http://muennich.github.com/sxiv/release/sxiv-0.3.1.tar.gz)** |
| 231 | *(January 30, 2011)* |
| 232 | |
| 233 | * Bug fix: Do not set setuid bit on executable when using `make install` |
| 234 | * Pan image with mouse while pressing middle mouse button |
| 235 | |
| 236 | **[v0.3](http://muennich.github.com/sxiv/release/sxiv-0.3.tar.gz)** |
| 237 | *(January 29, 2011)* |
| 238 | |
| 239 | * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z` |
| 240 | * More mouse mappings: Go to next/previous image with left/right click, |
| 241 | scroll image with mouse wheel (horizontally if Shift key is pressed), |
| 242 | zoom image with mouse wheel if Ctrl key is pressed |
| 243 | |
| 244 | **[v0.2](http://muennich.github.com/sxiv/release/sxiv-0.2.tar.gz)** |
| 245 | *(January 23, 2011)* |
| 246 | |
| 247 | * Bug fix: Handle window resizes correctly |
| 248 | * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10 |
| 249 | images back/forward |
| 250 | * Support for mouse wheel zooming (by Dave Reisner) |
| 251 | * Added fullscreen mode |
| 252 | |
| 253 | **[v0.1](http://muennich.github.com/sxiv/release/sxiv-0.1.tar.gz)** |
| 254 | *(January 21, 2011)* |
| 255 | |
| 256 | * Initial release |
| 257 | |