nsxiv/README.md

96 lines
3.6 KiB
Markdown
Raw Normal View History

2011-01-21 14:27:06 +00:00
sxiv: Simple (or small or suckless) X Image Viewer
sxiv is a really simple alternative to feh and qiv. Its only dependency is
imlib2. The primary goal for writing sxiv is to create an image viewer, which
2011-01-23 17:55:25 +00:00
only implements the most basic features required for fast image viewing. It
works nicely with tiling window managers and its code base should be kept small
and clean to make it easy for you to dig into it and customize it for your
needs.
2011-01-21 14:27:06 +00:00
Installation
------------
sxiv is built using the commands:
$ make
# make install
Please note, that the latter one requires root privileges.
By default, sxiv is installed using the prefix "/usr/local", so the full path
of the executable will be "/usr/local/bin/sxiv".
2011-01-21 14:27:06 +00:00
You can install it into a directory of your choice by changing the second
command to:
# PREFIX="/your/dir" make install
All build-time specific settings can be found in the file "config.h". Please
check and change them, so that they fit your needs.
Usage
-----
2011-02-21 15:49:34 +00:00
sxiv has two modes of operation: image and thumbnail mode. The default is image
mode, in which only the current image is shown. In thumbnail mode a grid of
small previews is displayed, making it easy to choose an image to open.
2011-01-27 15:15:43 +00:00
sxiv supports the following command-line options:
2011-01-31 15:06:40 +00:00
-d Scale all images to 100%, but fit large images into window
2011-02-02 09:43:16 +00:00
-F Use size-hints to make the window fixed/floating
2011-01-31 15:06:40 +00:00
-f Start in fullscreen mode
-g GEOMETRY Set window position and size
(see section GEOMETRY SPECIFICATIONS of X(7))
2011-01-31 15:06:40 +00:00
-p Pixelize, i.e. turn off image anti-aliasing
-q Be quiet, disable warnings
-r Search given directories recursively for images
2011-01-31 15:06:40 +00:00
-s Scale all images to fit into window
2011-02-21 15:49:34 +00:00
-t Start in thumbnail mode
2011-01-31 15:06:40 +00:00
-v Print version information and exit
-Z Same as `-z 100'
-z ZOOM Scale all images to current zoom level, use ZOOM at startup
2011-01-21 14:27:06 +00:00
2011-02-21 15:49:34 +00:00
Use the following keys to control the basic behaviour of sxiv:
2011-01-21 14:27:06 +00:00
2011-01-22 22:30:30 +00:00
q Quit sxiv
Escape Quit sxiv and return an exit value of 2 (useful for scripting)
2011-02-21 15:49:34 +00:00
f Toggle fullscreen mode (requires an EWMH/NetWM compliant
window manager)
Inside image view mode, the following key mappings are available:
2011-01-28 12:42:39 +00:00
n,Space Go to the next image
p,Backspace Go to the previous image
2011-01-23 15:19:07 +00:00
g/G Go to first/last image
[/] Go 10 images backward/forward
2011-01-22 22:30:30 +00:00
+,= Zoom in
- Zoom out
2011-02-06 17:45:00 +00:00
0 Set zoom level to 100%
w Fit image into window
2011-01-28 12:42:39 +00:00
h,j,k,l Pan image left/down/up/right (also with arrow keys)
2011-01-26 13:43:20 +00:00
<,> Rotate image (counter-)clockwise by 90 degrees
2011-02-06 17:45:00 +00:00
W Resize window to fit image
a Toggle anti-aliasing
2011-01-31 15:06:40 +00:00
r Reload image
2011-02-21 16:06:32 +00:00
Return Switch to thumbnail mode
2011-01-26 17:38:54 +00:00
2011-02-21 15:49:34 +00:00
Additionally, the image view offers the following mouse commands:
2011-01-26 17:38:54 +00:00
Button1 Go to the next image
Button2 Drag image with mouse while keeping it pressed
2011-01-26 17:38:54 +00:00
Button3 Go to the previous image
ScrollUp Pan image up
ScrollDown Pan image down
Shift+ScrollUp Pan image left
Shift+ScrollDown Pan image right
Ctrl+ScrollUp Zoom in
Ctrl+ScrollDown Zoom out
2011-02-21 15:49:34 +00:00
In thumbnail mode, the following key and mouse mappings are available:
h,j,k,l Move selection left/down/up/right (also with arrow keys)
g/G Move selection to first/last image
2011-02-21 16:06:32 +00:00
Return Open selected image
2011-02-21 15:49:34 +00:00
Button1 Select image/open image if it is already selected
ScrollUp Scroll up one row
ScrollDown Scroll down one row