| 1 | sxiv: Simple (or small or suckless) X Image Viewer |
| 2 | |
| 3 | sxiv is a really simple alternative to feh and qiv. Its only dependency besides |
| 4 | xlib is imlib2. The primary goal for writing sxiv is to create an image viewer, |
| 5 | which only implements the most basic features required for fast image viewing. |
| 6 | It works nicely with tiling window managers and its code base should be kept |
| 7 | small and clean to make it easy for you to dig into it and customize it for |
| 8 | your needs. |
| 9 | |
| 10 | Installation |
| 11 | ------------ |
| 12 | sxiv is built using the commands: |
| 13 | |
| 14 | $ make |
| 15 | # make install |
| 16 | |
| 17 | Please note, that the latter one requires root privileges. |
| 18 | By default, sxiv is installed using the prefix "/usr/local", so the full path |
| 19 | of the executable will be "/usr/local/bin/sxiv". |
| 20 | |
| 21 | You can install it into a directory of your choice by changing the second |
| 22 | command to: |
| 23 | |
| 24 | # PREFIX="/your/dir" make install |
| 25 | |
| 26 | All build-time specific settings can be found in the file "config.h". Please |
| 27 | check and change them, so that they fit your needs. |
| 28 | |
| 29 | Usage |
| 30 | ----- |
| 31 | sxiv has two modes of operation: image and thumbnail mode. The default is image |
| 32 | mode, in which only the current image is shown. In thumbnail mode a grid of |
| 33 | small previews is displayed, making it easy to choose an image to open. |
| 34 | |
| 35 | sxiv supports the following command-line options: |
| 36 | |
| 37 | -a Display all given files, do not filter out unsupported files |
| 38 | (shorter startup time for long file list or slow file types) |
| 39 | -d Scale all images to 100%, but fit large images into window |
| 40 | -F Use size-hints to make the window fixed/floating |
| 41 | -f Start in fullscreen mode |
| 42 | -g GEOMETRY Set window position and size |
| 43 | (see section GEOMETRY SPECIFICATIONS of X(7)) |
| 44 | -p Pixelize, i.e. turn off image anti-aliasing |
| 45 | -q Be quiet, disable warnings |
| 46 | -r Search given directories recursively for images |
| 47 | -s Scale all images to fit into window |
| 48 | -t Start in thumbnail mode |
| 49 | -v Print version information and exit |
| 50 | -Z Same as `-z 100' |
| 51 | -z ZOOM Scale all images to current zoom level, use ZOOM at startup |
| 52 | |
| 53 | Use the following keys to control the basic behaviour of sxiv: |
| 54 | |
| 55 | q Quit sxiv |
| 56 | Escape Quit sxiv and return an exit value of 2 (useful for scripting) |
| 57 | f Toggle fullscreen mode (requires an EWMH/NetWM compliant |
| 58 | window manager) |
| 59 | |
| 60 | Inside image view mode, the following key mappings are available: |
| 61 | |
| 62 | n,Space Go to the next image |
| 63 | p,Backspace Go to the previous image |
| 64 | g/G Go to first/last image |
| 65 | [/] Go 10 images backward/forward |
| 66 | +,= Zoom in |
| 67 | - Zoom out |
| 68 | 0 Set zoom level to 100% |
| 69 | w Fit image into window |
| 70 | h,j,k,l Pan image left/down/up/right (also with arrow keys) |
| 71 | <,> Rotate image (counter-)clockwise by 90 degrees |
| 72 | W Resize window to fit image |
| 73 | a Toggle anti-aliasing |
| 74 | A Toggle visibility of alpha-channel, i.e. transparency |
| 75 | r Reload image |
| 76 | Return Switch to thumbnail mode |
| 77 | |
| 78 | Additionally, the image view offers the following mouse commands: |
| 79 | |
| 80 | Button1 Go to the next image |
| 81 | Button2 Drag image with mouse while keeping it pressed |
| 82 | Button3 Go to the previous image |
| 83 | ScrollUp Pan image up |
| 84 | ScrollDown Pan image down |
| 85 | Shift+ScrollUp Pan image left |
| 86 | Shift+ScrollDown Pan image right |
| 87 | Ctrl+ScrollUp Zoom in |
| 88 | Ctrl+ScrollDown Zoom out |
| 89 | |
| 90 | In thumbnail mode, the following key and mouse mappings are available: |
| 91 | |
| 92 | h,j,k,l Move selection left/down/up/right (also with arrow keys) |
| 93 | g/G Move selection to first/last image |
| 94 | Return Open selected image |
| 95 | |
| 96 | Button1 Select image/open image if it is already selected |
| 97 | ScrollUp Scroll up one row |
| 98 | ScrollDown Scroll down one row |