diff --git a/doc/man/man1/notcurses-view.1 b/doc/man/man1/notcurses-view.1 deleted file mode 100644 index 8fb25c9b6..000000000 --- a/doc/man/man1/notcurses-view.1 +++ /dev/null @@ -1,17 +0,0 @@ -.TH notcurses-view 1 "v1.0.2" -.SH NAME -notcurses-view \- Render multimedia to the terminal -.SH SYNOPSIS -.B notcurses-view -.IR files... -.SH OPTIONS -.TP -.IR files -Files to successively render. -.SH DESCRIPTION -.B notcurses-view -renders multimedia to the terminal using libav. -.SH NOTES -Proper display requires a terminal advertising the RGB terminfo(5) capability (necessary for specification of arbitrary 24bpp colors), and a monospaced font with good Unicode support. -.SH SEE ALSO -notcurses(3notcurses), ffmpeg(1), terminfo(5) diff --git a/doc/man/man1/notcurses-view.1.md b/doc/man/man1/notcurses-view.1.md new file mode 100644 index 000000000..63ee8f494 --- /dev/null +++ b/doc/man/man1/notcurses-view.1.md @@ -0,0 +1,33 @@ +% notcurses-view(1) +% nick black +% v1.0.2 + +# NAME + +notcurses-view - Render images and video to the console + +# SYNOPSIS + +**notcurses-view** [**-h|--help**] [**-d delaymult**] [**-l loglevel**] files + +# DESCRIPTION + +**notcurses-view** uses the FFmpeg libraries and notcurses to render images +and videos to the terminal. Media will be scaled to the terminal's size. + +# OPTIONS + +**-d delaymult**: Apply a rational multiplier to the standard delay of 1s. + +**-l loglevel**: Log everything (high log level) or nothing (log level 0) to stderr. + +files: Select which files to render, and what order to render them in. + +# NOTES +Optimal display requires a terminal advertising the **rgb** terminfo(5) +capability, or that the environment variable **COLORTERM** is defined to +**24bit** (and that the terminal honors this variable), along with a good +monospaced font supporting the Unicode Block Drawing Characters. + +# SEE ALSO +notcurses(3notcurses), notcurses_ncvisual(3), terminfo(5)