nsxiv/README.md

141 lines
5.1 KiB
Markdown
Raw Normal View History

2011-01-21 15:27:06 +01:00
sxiv: Simple (or small or suckless) X Image Viewer
sxiv is an alternative to feh and qiv. Its only dependencies besides xlib are
imlib2 and giflib. The primary goal for writing sxiv is to create an image
viewer, which only has the most basic features required for fast image viewing
(the ones I want). It has vi key bindings and works nicely with tiling window
managers. 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 15:27:06 +01:00
2011-09-08 16:48:55 +02:00
Features
--------
2011-09-08 16:48:55 +02:00
* Basic image operations, e.g. zooming, panning, rotating
* Customizable key and mouse button mappings (in *config.h*)
* Thumbnail mode: grid of selectable previews of all images
* Ability to cache thumbnails for fast re-loading
* Basic support for multi-frame images
* Load all frames from GIF files and play GIF animations
2011-09-08 17:31:37 +02:00
* Display image information in window title
2011-09-08 16:48:55 +02:00
2011-09-08 17:31:37 +02:00
Screenshots
-----------
2011-09-08 17:31:37 +02:00
Image mode:
<img src="http://github.com/muennich/sxiv/raw/master/sample/image.png">
Thumbnail mode:
<img src="http://github.com/muennich/sxiv/raw/master/sample/thumb.png">
2011-01-21 15:27:06 +01:00
Installation
------------
2011-01-21 15:27:06 +01:00
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 15:27:06 +01:00
You can install sxiv into a directory of your choice by changing the second
2011-01-21 15:27:06 +01:00
command to:
# make PREFIX="/your/dir" install
2011-01-21 15:27:06 +01:00
The build-time specific settings of sxiv can be found in the file *config.h*.
Please check and change them, so that they fit your needs.
2011-09-13 10:08:55 +02:00
If the file *config.h* does not already exist, then you have to create it with
the following command:
$ make config.h
2011-01-21 15:27:06 +01:00
Usage
-----
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-02-21 16:49:34 +01:00
2011-01-27 16:15:43 +01:00
sxiv supports the following command-line options:
2012-02-16 23:20:27 +01:00
-b Do not show info bar on bottom of window
2011-04-11 21:27:20 +02:00
-c Remove all orphaned cache files from thumbnail cache and exit
2011-01-31 16:06:40 +01:00
-d Scale all images to 100%, but fit large images into window
2011-02-02 10:43:16 +01:00
-F Use size-hints to make the window fixed/floating
2011-01-31 16:06:40 +01:00
-f Start in fullscreen mode
-g GEOMETRY Set window position and size
(see section GEOMETRY SPECIFICATIONS of X(7))
2011-05-25 09:23:23 +02:00
-n NUM Start at picture NUM
2011-01-31 16:06:40 +01: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 16:06:40 +01:00
-s Scale all images to fit into window
2011-02-21 16:49:34 +01:00
-t Start in thumbnail mode
2011-01-31 16:06:40 +01: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 15:27:06 +01:00
2011-10-16 20:33:23 +02:00
The following general key commands are available:
2011-01-21 15:27:06 +01:00
2011-01-22 23:30:30 +01:00
q Quit sxiv
2011-10-16 20:33:23 +02:00
Return Switch to thumbnail mode / open selected image
2011-02-21 16:49:34 +01:00
2011-10-16 20:33:23 +02:00
0-9 Prefix the next command with a number (denoted via [count])
g Go to first image
G Go to the last image, or image number [count]
f Toggle fullscreen mode (requires an EWMH/NetWM compliant
window manager)
b Toggle visibility of info bar on bottom of window
2011-10-16 20:33:23 +02:00
A Toggle visibility of alpha-channel, i.e. transparency
r Reload image
R Reload all thumbnails
2011-10-16 20:33:23 +02:00
D Remove image from file list and go to next image
The following additional key commands are available in *thumbnail mode*:
h,j,k,l Move selection left/down/up/right [count] times
Ctrl-j,k Scroll thumbnail grid one window height down/up
2011-10-16 20:33:23 +02:00
The following additional key commands are available in *image mode*:
n,Space Go [count] images forward
p,Backspace Go [count] images backward
[,] Go [count] * 10 images backward/forward
2011-09-02 18:54:52 +02:00
Ctrl-n,p Go to the next/previous frame of a multi-frame image
Ctrl-Space Play/pause animation of a multi-frame image
2011-10-16 20:33:23 +02:00
+ Zoom in
2011-01-22 23:30:30 +01:00
- Zoom out
2011-10-16 20:33:23 +02:00
= Set zoom level to 100%, or [count]%
2011-02-06 18:45:00 +01:00
w Fit image into window
e Fit image width to window width
E Fit image height to window height
2011-10-16 20:33:23 +02:00
h,j,k,l Pan image 1/5 of window width/height or [count] pixels
left/down/up/right (also with arrow keys)
2011-05-16 15:58:19 +02:00
H,J,K,L Pan to left/bottom/top/right image edge
Ctrl-h,j,k,l Pan image one window width/height left/down/up/right
(also with Ctrl-arrow keys)
2011-01-26 14:43:20 +01:00
<,> Rotate image (counter-)clockwise by 90 degrees
\,| Flip image horizontally/vertically
a Toggle anti-aliasing
2011-10-16 20:33:23 +02:00
W Resize window to fit image
2011-01-26 18:38:54 +01:00
2011-10-16 20:33:23 +02:00
Additionally, the following mouse commands are available in *image mode*:
2011-01-26 18:38:54 +01:00
2011-09-13 10:08:55 +02:00
Button1 Go to the next image
Button2 Drag image with mouse while keeping it pressed
Button3 Go to the previous image
2011-10-16 20:33:23 +02:00
Scroll Pan image up/down
2011-09-13 10:08:55 +02:00
Shift+Scroll Pan image left/right
Ctrl+Scroll Zoom in/out