sxiv/sxiv.1

.TH SXIV 1 sxiv\-VERSION
.SH NAME
sxiv \- Simple (or small or suckless) X Image Viewer
.SH SYNOPSIS
.B sxiv
.RB [ \-cdFfhpqrstvZ ]
.RB [ \-g
.IR GEOMETRY ]
.RB [ \-n
.IR NUM ]
.RB [ \-z
.IR ZOOM ]
.IR FILE ...
.SH DESCRIPTION
sxiv is a simple image viewer for X. It only has the most basic features
required for fast image viewing.
.P
sxiv opens all named
.IR FILE s,
or reads the names of the files to open from standard input, if only a single
hyphen\-minus
.RB ( \- )
is given.
.P
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.
.P
sxiv can also cache its thumbnails. Please see the section THUMBNAIL CACHING
for information on how to enable this feature.
.P
Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
manager.
.SH OPTIONS
.TP
.B \-c
Remove all orphaned cache files from the thumbnail cache directory and exit.
.TP
.B \-d
Scale all images to 100%, but fit large images into window.
.TP
.B \-F
Make the window fixed/floating by setting the minimum and maximum width/height
size-hints to the window width/height.
.TP
.B \-f
Start in fullscreen mode.
.TP
.BI "\-g " GEOMETRY
Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for
more information on
.IR GEOMETRY .
.TP
.BI "\-n " NUM
Start at picture number NUM.
.TP
.B \-h
Print brief usage information to standard output and exit.
.TP
.B \-p
Pixelize images, i.e. turn off anti-aliasing.
.TP
.B \-q
Be quiet, disable warnings to standard error stream.
.TP
.B \-r
Search the given directories recursively for images to view.
.TP
.B \-s
Scale all images to fit into window.
.TP
.B \-t
Start in thumbnail mode.
.TP
.B \-v
Print version information to standard output and exit.
.TP
.B \-Z
The same as `\-z 100'.
.TP
.BI "\-z " ZOOM
Scale all images to the current zoom level, use a zoom level of
.I ZOOM
at startup.
.SH KEYBOARD COMMANDS
The differences of the following key mappings between image view and thumbnail
mode are denoted via brackets.
.SS General
.TP
.B q
Quit sxiv.
.TP
.B Return
Switch to thumbnail mode [open selected image].
.SS Navigate image list
.TP
.BR n ", " Space
Go to the next image.
.TP
.BR p ", " Backspace
Go to the previous image.
.TP
.B g
Go to [select] the first image.
.TP
.B G
Go to [select] the last image.
.TP
.B [
Go 10 images backward.
.TP
.B ]
Go 10 images forward.
.SS Handle multi-frame images
.TP
.B Ctrl-n
Go to the next frame of a multi-frame image.
.TP
.B Ctrl-p
Go to the previous frame of a multi-frame image.
.TP
.B Ctrl-Space
Play/pause animation of a multi-frame image.
.SS Zooming
.TP
.BR + ", " =
Zoom in.
.TP
.B \-
Zoom out.
.TP
.B 0
Set zoom level to 100%.
.TP
.B w
Set zoom level to fit image into window.
.SS Panning/Moving
.TP
.BR h ", " Left
Pan image [move selection] left.
.TP
.BR j ", " Down
Pan image [move selection] down.
.TP
.BR k ", " Up
Pan image [move selection] up.
.TP
.BR l ", " Right
Pan image [move selection] right.
.TP
.B H
Pan to left image edge.
.TP
.B J
Pan to bottom image edge.
.TP
.B K
Pan to top image edge.
.TP
.B L
Pan to right image edge.
.TP
.BR Ctrl-h ", " Ctrl-Left
Pan image one window width left.
.TP
.BR Ctrl-j ", " Ctrl-Down
Pan image one window height down.
.TP
.BR Ctrl-k ", " Ctrl-Up
Pan image one window height up.
.TP
.BR Ctrl-l ", " Ctrl-Right
Pan image one window width right.
.SS Rotation
.TP
.B <
Rotate image counter-clockwise by 90 degrees.
.TP
.B >
Rotate image clockwise by 90 degrees.
.SS Control window
.TP
.B W
Resize window to fit image.
.TP
.B f
Toggle fullscreen mode.
.SS Miscellaneous
.TP
.B a
Toggle anti-aliasing.
.TP
.B A
Toggle visibility of alpha-channel, i.e. image transparency.
.TP
.B D
Remove current [selected] image from file list and go to [select] next image.
.TP
.B r
Reload image.
.SH MOUSE COMMANDS
The differences of the following mouse mappings between image view and
thumbnail mode are denoted via brackets.
.SS Navigate image list
.TP
.B Button1
Go to [select/open] next image.
.TP
.B Button3
Go to the previous image.
.SS Zooming
.TP
.B Ctrl+ScrollUp
Zoom in.
.TP
.B Ctrl+ScrollDown
Zoom out.
.SS Panning/Moving
.TP
.B Button2
Drag the image with the mouse while keeping this button pressed down.
.TP
.B ScrollUp
Pan image up [scroll up one thumbnail row].
.TP
.B ScrollDown
Pan image down [scroll down one thumbnail row].
.TP
.B Shift+ScrollUp
Pan image left.
.TP
.B Shift+ScrollDown
Pan image right.
.SH THUMBNAIL CACHING
To enable thumbnail caching, please make sure to create the directory
.I ~/.sxiv/
with write permissions. sxiv will then store all thumbnails inside this
directory, but it will not create this directory by itself. It rather uses the
existance of this directory as an affirmation, that the user wants thumbnails
to be cached.
.P
Use the command line option
.I \-c
to keep the cache directory clean by removing all orphaned cache files.
Additionally, run the following command afterwards inside the cache directory
to remove empty subdirectories:
.P
.RS
find \-type d \-empty \-delete
.RE
.SH AUTHORS
.EX
Bert Muennich <ber.t at gmx.com>
Dave Reisner  <d at falconindy.com>
Fung SzeTat   <sthorde at gmail.com>
.EE
.SH HOMEPAGE
.TP
http://github.com/muennich/sxiv
.SH SEE ALSO
.BR feh (1),
.BR qiv (1)