sxiv - Man Page

• Open an image: sxiv path/to/image
• Open an image in fullscreen mode: sxiv -f path/to/file
• Open a newline-separated list of images, reading filenames from stdin: echo path/to/file | sxiv -i
• Open one or more images as a slideshow: sxiv -S seconds path/to/image1 path/to/image2
• Open one or more images in thumbnail mode: sxiv -t path/to/image1 path/to/image2

tldr.sh

sxiv [-abcfhiopqrtvZ] [-A FRAMERATE] [-e WID] [-G GAMMA] [-g GEOMETRY] [-N NAME] [-n NUM] [-S DELAY] [-s MODE] [-z ZOOM] FILE...

sxiv is a simple image viewer for X.

It 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.

-A FRAMERATE

Play animations with a constant frame rate set to FRAMERATE.

-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.

-e WID

Embed sxiv's window into window whose ID is WID.

-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. Also done if FILE is `-'.

-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.

-p

Enable private mode, in which sxiv does not write any cache or temporary files.

-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. DELAY may be a floating point number.

-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.

The following mouse mappings are available in image mode:

General:

Button3

Switch to thumbnail mode.

Navigate image list:

Button1

Go to the next image if the mouse cursor is in the right part of the window or to the previous image if it is in the left part.

Panning:

Button2

Pan the image according to the mouse cursor position in the window while keeping this button pressed down.

Zooming:

ScrollUp

Zoom in.

ScrollDown

Zoom out.

The following X resources are supported:

background

Color of the window background and bar foreground

foreground

Color of the window foreground and bar background

font

Name of Xft bar font

Please see xrdb(1) on how to change them.

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 arguments given to it are: 1) path to image file, 2) image width, 3) image height.

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

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.

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:

Bert Muennich   <ber.t at posteo.de>

Bastien Dejean  <nihilhill at gmail.com>
Dave Reisner    <d at falconindy.com>
Fung SzeTat     <sthorde at gmail.com>
Max Voit        <mvdev at with-eyes.net>

https://github.com/muennich/sxiv

X(7), xrdb(1)