.\" Automatically generated by Pandoc 3.1.8
.\"
.TH "ncls" "1" "v3.0.9" "" ""
.SH NAME
ncls - List paths with rendering of multimedia
.SH SYNOPSIS
\f[B]ncls\f[R]\ [\f[B]-h\f[R]|\f[B]--help\f[R]]\ [\f[B]-V\f[R]|\f[B]--version\f[R]]
[\f[B]-d\f[R]] [\f[B]-l\f[R]]\ [\f[B]-L\f[R]] [\f[B]-R\f[R]]
[\f[B]-a\f[R]|\f[B]--align\f[R] \f[B]\f[BI]type\f[B]\f[R]]
[\f[B]-b\f[R]|\f[B]--blitter\f[R] \f[B]\f[BI]blitter\f[B]\f[R]]
[\f[B]-s\f[R]|\f[B]--scale\f[R] \f[B]\f[BI]scale\f[B]\f[R]] [ paths ]
.SH DESCRIPTION
\f[B]ncls\f[R] uses a multimedia-enabled Notcurses to list paths,
similarly to the \f[B]ls(1)\f[R] command, rendering images and videos to
a terminal.
.SH OPTIONS
\f[B]-d\f[R]: list directories themselves, not their contents.
.PP
\f[B]-l\f[R]: use a long listing format.
.PP
\f[B]-L\f[R]: dereference symbolic links
.PP
\f[B]-R\f[R]: list subdirectories recursively.
.PP
\f[B]-V\f[R]|\f[B]--version\f[R]: Print version information, and exit
with success.
.PP
\f[B]-h\f[R]|\f[B]--help\f[R]: Print help information, and exit with
success.
.PP
\f[B]-a\f[R]|\f[B]--align\f[R] \f[B]\f[BI]type\f[B]\f[R]: Align images
on \f[B]left\f[R], \f[B]center\f[R], or \f[B]right\f[R].
.PP
\f[B]-b\f[R]|\f[B]--blitter\f[R] \f[B]\f[BI]blitter\f[B]\f[R]: Blitter,
one of \f[B]ascii\f[R], \f[B]half\f[R], \f[B]quad\f[R], \f[B]sex\f[R],
\f[B]braille\f[R], or \f[B]pixel\f[R].
The default is \f[B]pixel\f[R].
If the chosen blitter is unavailable, \f[B]ncls\f[R] will degrade (see
\f[B]notcurses_visual(3)\f[R]).
.PP
\f[B]-s\f[R]|\f[B]--scale\f[R] \f[B]\f[BI]scalemode\f[B]\f[R]: Scaling
mode, one of \f[B]none\f[R], \f[B]hires\f[R], \f[B]scale\f[R],
\f[B]scalehi\f[R], or \f[B]stretch\f[R].
.PP
paths: Run on the specified paths.
If none are supplied, run on the current directory.
.PP
If no scaling is specified, \f[B]hires\f[R] will be used with the
\f[B]pixel\f[R] blitter, and \f[B]scalehi\f[R] will be used otherwise.
.SH NOTES
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
\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>.