.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "notcurses-view" "1" "v2.0.4" "" ""
.hy
.SH NAME
.PP
notcurses-view - Render images and video to a terminal
.SH SYNOPSIS
.PP
\f[B]notcurses-view\f[R]\ [\f[B]-h\f[R]]\ [\f[B]-q\f[R]]
[\f[B]-d\ delaymult\f[R]]\ [\f[B]-l\ loglevel\f[R]] [\f[B]-s
scalemode\f[R]] [\f[B]-k\f[R]] [\f[B]-L\f[R]] files
.SH DESCRIPTION
.PP
\f[B]notcurses-view\f[R] uses a multimedia-enabled notcurses to render
images and videos to a terminal.
By default, \f[B]stretch\f[R]-type scaling is used to fill the rendering
area, and the \f[B]sexblitter\f[R] blitter is used for a 3x2\[->]1
mapping from pixels to cells.
.SH OPTIONS
.PP
\f[B]-d delaymult\f[R]: Apply a rational multiplier to the framerate.
.PP
\f[B]-l loglevel\f[R]: Log everything (high log level) or nothing (log
level 0) to stderr.
.PP
\f[B]-s scalemode\f[R]: Scaling mode, one of \f[B]none\f[R],
\f[B]scale\f[R], or \f[B]stretch\f[R].
.PP
\f[B]-b blitter\f[R]: Blitter, one of \f[B]ascii\f[R],
\f[B]halfblocks\f[R], \f[B]quadblitter\f[R], \f[B]sexblitter\f[R], or
\f[B]braille\f[R].
.PP
\f[B]-m margins\f[R]: Define rendering margins (see below).
.PP
\f[B]-L\f[R]: Loop frames until a key is pressed.
.PP
\f[B]-k\f[R]: Inhibit use of the alternate screen.
Necessary if you want the output left on your terminal after the program
exits.
.PP
\f[B]-q\f[R]: Don\[cq]t print frame/timing information along the top of
the screen.
.PP
\f[B]-h\f[R]: Print help information, and exit with success.
.PP
files: Select which files to render, and what order to render them in.
.PP
Default margins are all 0 and default scaling is \f[B]stretch\f[R].
The full rendering area will thus be used.
Using \f[B]-m\f[R], margins can be supplied.
Provide a single number to set all four margins to the same value, or
four comma-delimited values for the top, right, bottom, and left margins
respectively.
Negative margins are illegal.
.PP
Scaling mode \f[B]stretch\f[R] resizes the object to match the target
rendering area exactly.
\f[B]scale\f[R] resizes the object so that the longer edge of the
rendering area is matched exactly, and the other edge is changed to
maintain aspect ratio.
\f[B]none\f[R] uses the original image size.
.PP
Blitters can be selected by pressing `0' through `8'.
\f[B]NCBLIT_DEFAULT\f[R] corresponds to `0'.
The various blitters are described in \f[B]notcurses_visual\f[R].
.PP
A video can be paused with space.
Press space (or any other valid control) to resume.
.SH NOTES
.PP
Optimal display requires a terminal advertising the \f[B]rgb\f[R]
terminfo(5) capability, or that the environment variable
\f[B]COLORTERM\f[R] is defined to \f[B]24bit\f[R] (and that the terminal
honors this variable), along with a fixed-width font with good coverage
of the Unicode Block Drawing Characters.
.SH SEE ALSO
.PP
\f[B]notcurses(3)\f[R], \f[B]notcurses_visual(3)\f[R],
\f[B]terminfo(5)\f[R], \f[B]unicode(7)\f[R]
.SH AUTHORS
nick black <nickblack@linux.com>.