sxiv man page

sxiv — Simple X Image Viewer

Synopsis

sxiv [-abcfhioqrtvZ] [-G GAMMA] [-g GEOMETRY] [-N NAME] [-n NUM] [-S DELAY] [-s MODE] [-z ZOOM] FILE...

Description

sxiv is a simple image viewer for X. It only has the most basic features required for fast image viewing.

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.

Please note, that the fullscreen mode requires an EWMH/NetWM compliant window manager.

Options

-a
Play animations of multi-frame images.
-b
Do not show info bar on bottom of window.
-c
Remove all orphaned cache files from the thumbnail cache directory and exit.
-f
Start in fullscreen mode.
-G GAMMA
Set image gamma to GAMMA (-32..32).
-g GEOMETRY
Set window position and size. See section GEOMETRY SPECIFICATIONS of X(7) for more information on GEOMETRY argument.
-N NAME
Set the resource name of sxiv's X window to NAME.
-n NUM
Start at picture number NUM.
-h
Print brief usage information to standard output and exit.
-i
Read names of files to open from standard input.
-o
Write list of all marked files to standard output when quitting. In combination with -i sxiv can be used as a visual filter/pipe.
-q
Be quiet, disable warnings to standard error stream.
-r
Search the given directories recursively for images to view.
-S DELAY
Start in slideshow mode. Set the delay between images to DELAY seconds.
-s MODE
Set scale mode according to MODE character. Supported modes are: [d]own, [f]it, [w]idth, [h]eight.
-t
Start in thumbnail mode.
-v
Print version information to standard output and exit.
-Z
The same as `-z 100'.
-z ZOOM
Set zoom level to ZOOM percent.

General Keyboard Commands

The following keyboard commands are available in both image and thumbnail mode:

0-9
Prefix the next command with a number (denoted via count).
q
Quit sxiv.
Return
Switch to thumbnail mode / open selected image in image mode.
f
Toggle fullscreen mode.
b
Toggle visibility of info bar on bottom of window.
Ctrl-x
Send the next key to the external key-handler. See section External Key Handler for more information.
g
Go to the first image.
G
Go to the last image, or image number count.
r
Reload image.
D
Remove current image from file list and go to next image.
Ctrl-h, Ctrl-Left
Scroll left one screen width.
Ctrl-j, Ctrl-Down
Scroll down one screen height.
Ctrl-k, Ctrl-Up
Scroll up one screen height.
Ctrl-l, Ctrl-Right
Scroll right one screen width.
+
Zoom in.
-
Zoom out.
m
Mark/unmark the current image.
M
Reverse all image marks.
Ctrl-m
Remove all image marks.
N
Go count marked images forward.
P
Go count marked images backward.
{
Decrease gamma correction by count steps.
}
Increase gamma correction by count steps.
Ctrl-g
Reset gamma correction.

Thumbnail Keyboard Commands

The following keyboard commands are only available in thumbnail mode:

h, Left
Move selection left count times.
j, Down
Move selection down count times.
k, Up
Move selection up count times.
l, Right
Move selection right count times.
R
Reload all thumbnails.

Image Keyboard Commands

The following keyboard commands are only available in image mode:

Navigate image list

n, Space
Go count images forward.
p, Backspace
Go count images backward.
[
Go count * 10 images backward.
]
Go count * 10 images forward.

Handle multi-frame images

Ctrl-n
Go to the next frame of a multi-frame image.
Ctrl-p
Go to the previous frame of a multi-frame image.
Ctrl-Space
Play/stop animations of multi-frame images.

Panning

h, Left
Scroll image 1/5 of window width or count pixel left.
j, Down
Scroll image 1/5 of window height or count pixel down.
k, Up
Scroll image 1/5 of window height or count pixel up.
l, Right
Scroll image 1/5 of window width or count pixel right.
H
Scroll to left image edge.
J
Scroll to bottom image edge.
K
Scroll to top image edge.
L
Scroll to right image edge.

Zooming

=
Set zoom level to 100%, or count%.
w
Set zoom level to 100%, but fit large images into window.
W
Fit image to window.
e
Fit image to window width.
E
Fit image to window height.

Rotation

<
Rotate image counter-clockwise by 90 degrees.
>
Rotate image clockwise by 90 degrees.
?
Rotate image by 180 degrees.

Flipping

|
Flip image horizontally.
_
Flip image vertically.

Miscellaneous

a
Toggle anti-aliasing.
A
Toggle visibility of alpha-channel, i.e. image transparency.
s
Toggle slideshow mode and/or set the delay between images to count seconds.

Mouse Commands

The following mouse mappings are available in image mode:

Navigate image list

Button1
Go to next image.
Button3
Go to the previous image.

Panning

Button2
Drag the image with the mouse while keeping this button pressed down.
ScrollUp
Scroll image up.
ScrollDown
Scroll image down.
Shift+ScrollUp
Scroll image left.
Shift+ScrollDown
Scroll image right.

Zooming

Ctrl+ScrollUp
Zoom in.
Ctrl+ScrollDown
Zoom out.

Status Bar

The information displayed on the left side of the status bar can be replaced with the output of a user-provided script, which is called by sxiv whenever an image gets loaded. The path of this script is $XDG_CONFIG_HOME/sxiv/exec/image-info and the first argument to this script is the path of the loaded image.

There is also an example script installed together with sxiv as /usr/share/sxiv/exec/image-info.

External Key Handler

Additional external keyboard commands can be defined using a handler program located in $XDG_CONFIG_HOME/sxiv/exec/key-handler. The handler is invoked by pressing Ctrl-x. The next key combo is passed as its first argument. Passed via stdin are the images to act upon, one path per line: all marked images, if in thumbnail mode and at least one image has been marked, otherwise the current image. sxiv(1) will block until the handler terminates. It then checks which images have been modified and reloads them.

The key combo argument has the following form: "[C-][M-][S-]KEY", where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.

There is also an example script installed together with sxiv as /usr/share/sxiv/exec/key-handler.

Thumbnail Caching

sxiv stores all thumbnails under $XDG_CACHE_HOME/sxiv/.

Use the command line option -c to remove all orphaned cache files. Additionally, run the following command afterwards inside the cache directory to remove empty subdirectories:

find . -depth -type d -empty ! -name '.' -exec rmdir {} \;

Author

Bert Muennich   <ber.t at posteo.de>

Contributors

Bastien Dejean  <nihilhill at gmail.com>
Dave Reisner    <d at falconindy.com>
Fung SzeTat     <sthorde at gmail.com>

Homepage

https://github.com/muennich/sxiv

See Also

feh(1), qiv(1)

Info

sxiv-1.3.2