nsxiv6480a9d
Added README.md
+44 −0
2 files changed
| @@ -0,0 +1,43 @@ | |||
| 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 is | |
| 4 | + | imlib2. The primary goal for writing sxiv is to create an image viewer, which | |
| 5 | + | only implements the most basic features required for fast image viewing. Its | |
| 6 | + | code base should be kept small and clean making it easy for you to dig into it | |
| 7 | + | and customize it for your needs. | |
| 8 | + | ||
| 9 | + | Installation | |
| 10 | + | ------------ | |
| 11 | + | sxiv is built using the commands: | |
| 12 | + | ||
| 13 | + | $ make | |
| 14 | + | # make install | |
| 15 | + | ||
| 16 | + | Please note, that the latter one requires root privileges. | |
| 17 | + | By default, sxiv is installed using the prefix "/usr/local", so the full path | |
| 18 | + | of the executable will be "/usr/local/sbin/sxiv". | |
| 19 | + | ||
| 20 | + | You can install it into a directory of your choice by changing the second | |
| 21 | + | command to: | |
| 22 | + | ||
| 23 | + | # PREFIX="/your/dir" make install | |
| 24 | + | ||
| 25 | + | All build-time specific settings can be found in the file "config.h". Please | |
| 26 | + | check and change them, so that they fit your needs. | |
| 27 | + | ||
| 28 | + | Usage | |
| 29 | + | ----- | |
| 30 | + | sxiv has no useful command line options yet, but they will be added in the next | |
| 31 | + | releases. Right now, it simply displays all files given given on the | |
| 32 | + | command line. | |
| 33 | + | ||
| 34 | + | Use the following keys to control sxiv: | |
| 35 | + | ||
| 36 | + | q Quit sxiv | |
| 37 | + | Escape Quit sxiv and return an exit value of 2 (useful for scripting) | |
| 38 | + | Space,n Go to the next image | |
| 39 | + | Backspace,p | |
| 40 | + | Go to the previous image | |
| 41 | + | +,= Zoom in | |
| 42 | + | - Zoom out | |
| 43 | + | h,j,k,l Scroll left/up/down/right | |
| @@ -4,3 +4,4 @@ | |||
| 4 | 4 | - write man page | |
| 5 | 5 | - toggle aliasing | |
| 6 | 6 | - fullscreen mode | |
| 7 | + | - view all images in directories (recursive mode) | |