Whether to allow animation [on, off]. Defaults to on.
When off, will show a still frame from each animation.
Background color of display (color name or hex).
Partially transparent input will be blended with this color. Color names are
based on those provided with X.Org. Defaults to black.
-C bool, --center
Center images [on, off]. Defaults to off.
Clear screen before processing each file.
-c mode, --colors
Set output color mode; one of [none, 2, 8, 16/8 16, 240,
256, full]. Defaults to full (24-bit). The 240-color mode is recommended over
the 256-color one, since the lower 16 colors are unreliable and tend to differ
between terminals. 16-color mode will use aixterm extensions to produce 16
foreground and background colors. The 16/8 mode allows for 8 colors plus
another "bright" 8 colors in the foreground implemented with the
"bold" escape sequence. 2-color mode will only emit the ANSI codes
for reverse color and attribute reset, while "none" will emit no
escape sequences at all.
In sixel mode, "full" will dynamically generate a
256-color palette for each image or animation frame. The other modes refer
to built-in palettes. "none" and "2" are interchangeable
and will use the specified foreground/background colors (see --fg and
Method for extracting color from an area; one of
[average, median]. Median normally produces crisper output, while average may
perform better on noisy images. Defaults to average.
Color space used for quantization; one of [rgb, din99d].
Defaults to rgb, which is faster but less accurate.
Type of dithering to apply during quantization. One of
[none, ordered, diffusion]. "Bayer" is a synonym for
"ordered", and "fs" (Floyd-Steinberg) is a synonym for
Dimensions of grain used when dithering. Specified as
width x height, where each can be one of [1, 2, 4, 8] pixels. One character
cell is by definition 8 pixels across in both dimensions. Defaults to 4x4 in
symbol mode and 1x1 in sixel mode.
Intensity of dithering pattern. Ranges from 0.0 to
infinity, with 1.0 considered neutral. Lower values tend to reduce the amount
of dithering done, while higher values increase it. In practice, values higher
than 10.0 are unlikely to produce useful results.
-d, --duration seconds
Time to show each file, in seconds. Defaults to zero for
still images and for animations when multiple files are specified. If a single
animation is specified, defaults to infinite. Animations will always be played
through at least once, even if duration is e.g. zero.
Foreground color of display (color name or hex). Together
with the background color specified by --bg, this specifies the terminal's
palette in color modes 2 and none. Color names are based on those provided
with X.Org. Defaults to white.
Leave the background color untouched. This produces
character-cell output using foreground colors only, and will avoid resetting
or inverting the colors.
Specify character symbols to use for fill/gradients.
Defaults to none. Usage is similar to that of --symbols; see below.
Target font's width/height ratio. Can be specified as a
real number or a fraction. Defaults to 1/2.
-f, --format format
Set output format; one of [iterm, kitty, sixels,
symbols]. The default is iterm, kitty or sixels if the connected terminal
supports one of these, falling back to symbols ("ANSI art")
Load glyph information from file, which can be any font
file supported by FreeType (TTF, PCF, etc). The glyph outlines will replace
any existing outlines, including builtins. Useful in symbol mode for custom
font support or for improving quality with a specific font. Note that this
only makes sense if the output terminal is using a matching font. Can be
specified multiple times.
Show a brief help text.
Invert video. For display with bright backgrounds in
color modes 2 and none. Swaps --fg and --bg.
When terminal size is detected, reserve at least this
many rows at the bottom as a safety margin. Can be used to prevent images from
scrolling out. Defaults to 1.
When terminal size is detected, reserve at least this
many columns on the right-hand side as a safety margin. Defaults to 0.
-O num, --optimize
Compress the output by using control sequences
intelligently [0-9]. 0 disables, 9 enables every available optimization.
Defaults to 5, except for when used with "-c none", where it
defaults to 0.
Polite mode [on, off]. Defaults to on. Turning this off
may enhance presentation and prevent interference from other programs, but
risks leaving the terminal in an altered state (rude).
-p bool, --preprocess
Image preprocessing [on, off]. Defaults to on with 16
colors or lower, off otherwise. This enhances colors and contrast prior to
conversion, which can be useful in low-color modes.
Scale image, respecting terminal's maximum dimensions.
1.0 approximates original pixel dimensions. Specify "max" to use all
available space. Defaults to 1.0 for pixel graphics and 4.0 for symbols.
Set maximum output dimensions in columns and rows. By
default this will be the size of your terminal, or 80x25 if size detection
Set the speed animations will play at. This can be either
a unitless multiplier (fractions are allowed), or a real number followed by
"fps" to apply a specific framerate.
Stretch image to fit output dimensions; ignore aspect.
Implies --scale max.
Specify character symbols to employ in final output. See
below for full usage and a list of symbol classes.
Maximum number of CPU threads to use. If left unspecified
or negative, this will equal available CPU cores.
-t threshold, --threshold
Threshold above which full transparency will be used [0.0
- 1.0]. Setting this to 0.0 will render a blank image, while a value of 1.0
will replace any transparency with the background color (configurable with
Show version, feature and copyright information.
Watch a single input file, redisplaying it whenever its
contents change. Will run until manually interrupted or, if --duration is set,
until it expires.
-w num, --work num
How hard to work in terms of CPU and memory [1-9]. 1 is
the cheapest, 9 is the most accurate. Defaults to 5.