notcurses-demo(1)

nick black

v1.2.0

NAME

notcurses-demo - Show off some notcurses features

SYNOPSIS

notcurses-demo [-h|–help] [-p path] [-d delaymult] [-l loglevel] [-f renderfile] [-ikVc] demospec

DESCRIPTION

notcurses-demo demonstrates the capabilities of the notcurses library. It can be run in any terminal emulator or console with a correct terminfo(5) database, but is at is best in a “DirectColor” 24bpp RGB environment. If notcurses-demo seems to generate garbage, something is likely configured in a way that is going to prevent notcurses from working.

The demonstrations include (see NOTES below):

At any time, press ‘q’ to quit. The demo is best run in at least an 80x45 terminal.

OPTIONS

-p path: Look in the specified path for data files.

-d delaymult: Apply a non-negative rational multiplier to the standard delay of 1s.

-l loglevel: Log everything (high log level) or nothing (log level 0) to stderr.

-f renderfile: Render each frame to renderfile in addition to the screen.

-k: Inhibit use of the alternate screen. Necessary if you want the output left on your terminal after the program exits.

-c: Do not attempt to seed the PRNG. This is useful when benchmarking.

-i: Continue after a failing demo.

-h: Print a usage message, and exit with success.

-V: Print the program name and version, and exit with success.

demospec: Select which demos to run, and what order to run them in. The default is ixethbcgrwuvlfsjo. See above for a list of demos.

NOTES

Proper display requires:

The Debian version of notcurses leaves out certain multimedia considered non-free under the Debian Free Software Guidelines. As a result, the chunli, eagle, fallin’, jungle, luigi, and view demos are unavailable through the Debian package.

If notcurses is built without FFmpeg, the chunli, eagle, fallin’, outro, view, and xray demos will be unavailable.

If notcurses-demo is run in a terminal lacking the can_change terminfo capability, jungle will be skipped.

The following keypresses are recognized (and are also available from the menu):

BUGS

COPYRIGHT

SEE ALSO

notcurses(3), ncurses(3NCURSES), terminfo(5)