mirror of
https://github.com/dankamongmen/notcurses
synced 2025-03-09 17:19:03 -04:00
notcurses-demo.1: migrate to pandoc
This commit is contained in:
parent
7d598a5033
commit
d057473c4c
@ -115,12 +115,13 @@ foreach(f ${POCSRCS})
|
|||||||
endforeach()
|
endforeach()
|
||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
|
file(GLOB MANSOURCE1 CONFIGURE_DEPENDS doc/man/man1/*.md)
|
||||||
file(GLOB MANSOURCE3 CONFIGURE_DEPENDS doc/man/man3/*.md)
|
file(GLOB MANSOURCE3 CONFIGURE_DEPENDS doc/man/man3/*.md)
|
||||||
FIND_PROGRAM(PANDOC pandoc)
|
FIND_PROGRAM(PANDOC pandoc)
|
||||||
iF(NOT PANDOC)
|
iF(NOT PANDOC)
|
||||||
message(WARNING "pandoc not found, won't generate documentation")
|
message(WARNING "pandoc not found, won't generate documentation")
|
||||||
else()
|
else()
|
||||||
foreach(m ${MANSOURCE3})
|
foreach(m ${MANSOURCE3} ${MANSOURCE1})
|
||||||
get_filename_component(me ${m} NAME_WLE)
|
get_filename_component(me ${m} NAME_WLE)
|
||||||
add_custom_command(
|
add_custom_command(
|
||||||
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${me}
|
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${me}
|
||||||
@ -134,6 +135,7 @@ foreach(m ${MANSOURCE3})
|
|||||||
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${me}
|
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${me}
|
||||||
)
|
)
|
||||||
set(MANPAGES3 ${MANPAGES3} ${CMAKE_CURRENT_BINARY_DIR}/${me})
|
set(MANPAGES3 ${MANPAGES3} ${CMAKE_CURRENT_BINARY_DIR}/${me})
|
||||||
|
set(MANPAGES1 ${MANPAGES1} ${CMAKE_CURRENT_BINARY_DIR}/${me})
|
||||||
add_custom_command(
|
add_custom_command(
|
||||||
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${me}.html
|
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${me}.html
|
||||||
DEPENDS ${m}
|
DEPENDS ${m}
|
||||||
|
@ -1,75 +0,0 @@
|
|||||||
.TH notcurses-demo 1 "v1.0.2"
|
|
||||||
.SH NAME
|
|
||||||
notcurses-demo \- Show off some notcurses features
|
|
||||||
.SH SYNOPSIS
|
|
||||||
.B notcurses-demo
|
|
||||||
[ \fB\-p \fIpath \fR]
|
|
||||||
[ \fB\-d \fIdelaymult \fR]
|
|
||||||
[ \fB\-k \fR]
|
|
||||||
[ \fB\-c \fR]
|
|
||||||
[ \fB\-h / \fB\-\-help \fR]
|
|
||||||
.IR demospec
|
|
||||||
.SH OPTIONS
|
|
||||||
.TP
|
|
||||||
.BR \-p \fIpath\fR
|
|
||||||
Look in the specified path for data files.
|
|
||||||
.TP
|
|
||||||
.BR \-d \fIdelaymult\fR
|
|
||||||
Apply a (floating-point) multiplier to the standard delay of 1s.
|
|
||||||
.TP
|
|
||||||
.BR \-H
|
|
||||||
Launch a HUD with running timers for each demo. This HUD can be moved or
|
|
||||||
closed with the mouse.
|
|
||||||
.TP
|
|
||||||
.BR \-k
|
|
||||||
Inhibit use of the alternate screen. Necessary if you want the output left
|
|
||||||
on your terminal after the program exits.
|
|
||||||
.TP
|
|
||||||
.BR \-c
|
|
||||||
Do not attempt to seed the PRNG. This is useful when benchmarking.
|
|
||||||
.TP
|
|
||||||
.BR \-h ", " \-\-help
|
|
||||||
Print a usage message, and exit with success.
|
|
||||||
.TP
|
|
||||||
.BR \-V ", " \-\-version
|
|
||||||
Print the program name and version, and exit with success.
|
|
||||||
.TP
|
|
||||||
.IR demospec
|
|
||||||
Select which demos to run, and what order to run them in. The default is "ixetcgswubvlpo". See below for a list of demos.
|
|
||||||
.SH DESCRIPTION
|
|
||||||
.B notcurses-demo
|
|
||||||
contains a set of text-based demonstrations of capabilities from the notcurses library. The demonstrations include:
|
|
||||||
.P
|
|
||||||
(i)ntro—a setting of tone
|
|
||||||
.P
|
|
||||||
(x)ray—stimulate a logo with energy
|
|
||||||
.P
|
|
||||||
(e)agle—zoom in on a background from Ninja Gaiden
|
|
||||||
.P
|
|
||||||
(t)rans—an exploration of various transparencies
|
|
||||||
.P
|
|
||||||
(c)hunli—the day Bison graced her village, it was Tuesday
|
|
||||||
.P
|
|
||||||
(l)uigi-a dashing plumber of Apennine persuasion
|
|
||||||
.P
|
|
||||||
(u)niblocks—a series of blocks detailing Unicode pages
|
|
||||||
.P
|
|
||||||
(b)oxes—pulsating boxes with a transparent center
|
|
||||||
.P
|
|
||||||
(g)rid—a gradient of color lain atop a great grid
|
|
||||||
.P
|
|
||||||
(s)liders—a missing-piece puzzle made up of colorful blocks
|
|
||||||
.P
|
|
||||||
(w)hiteworm—a great Nothing slowly robs the world of color
|
|
||||||
.P
|
|
||||||
(v)iew—images and a video are rendered as text
|
|
||||||
.P
|
|
||||||
(p)anelreels—demonstration of the panelreel high-level widget
|
|
||||||
.P
|
|
||||||
(o)utro—a message of hope from the library's author
|
|
||||||
.P
|
|
||||||
At any time, press 'q' to quit. The demo is best run in at least a 80x45 terminal.
|
|
||||||
.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), ncurses(3ncurses), terminfo(5)
|
|
63
doc/man/man1/notcurses-demo.1.md
Normal file
63
doc/man/man1/notcurses-demo.1.md
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
% notcurses-demo(1)
|
||||||
|
% nick black <nickblack@linux.com>
|
||||||
|
% v1.0.2
|
||||||
|
|
||||||
|
# NAME
|
||||||
|
|
||||||
|
notcurses-demo - Show off some notcurses features
|
||||||
|
|
||||||
|
# SYNOPSIS
|
||||||
|
|
||||||
|
**notcurses-demo** [**-h|--help**] [**-p path**] [**-d delaymult**] [**-l loglevel**] [**-kHVc**] 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.
|
||||||
|
|
||||||
|
The demonstrations include:
|
||||||
|
|
||||||
|
* (i)ntro—a setting of tone
|
||||||
|
* (x)ray—stimulate a logo with energy
|
||||||
|
* (e)agle—they took some time off my life, back in the day
|
||||||
|
* (t)rans—an exploration of various transparencies
|
||||||
|
* (c)hunli—the strongest woman in the world
|
||||||
|
* (g)rid—a gradient of color lain atop a great grid
|
||||||
|
* (s)liders—a missing-piece puzzle made up of colorful blocks
|
||||||
|
* (w)hiteworm—a great Nothing slowly robs the world of color
|
||||||
|
* (u)niblocks—a series of blocks detailing Unicode pages
|
||||||
|
* (b)oxes—pulsating boxes with a transparent center
|
||||||
|
* (v)iew—images and a video are rendered as text
|
||||||
|
* (l)uigi-a dashing Apennine plumber in a world of fire
|
||||||
|
* (p)anelreels—demonstration of the panelreel high-level widget
|
||||||
|
* (o)utro—a message of hope from the library's author
|
||||||
|
|
||||||
|
At any time, press 'q' to quit. The demo is best run in at least a 80x45 terminal.
|
||||||
|
|
||||||
|
# OPTIONS
|
||||||
|
|
||||||
|
**-p path**: Look in the specified **path** for data files.
|
||||||
|
|
||||||
|
**-d delaymult**: Apply a rational multiplier to the standard delay of 1s.
|
||||||
|
|
||||||
|
**-H**: Launch a HUD with running timers for each demo. This HUD can be moved or closed with the mouse.
|
||||||
|
|
||||||
|
**-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.
|
||||||
|
|
||||||
|
**-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 **ixetcgswubvlpo**. See above for a list of demos.
|
||||||
|
|
||||||
|
# NOTES
|
||||||
|
Proper 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),
|
||||||
|
* A monospaced font, and
|
||||||
|
* Good Unicode support in your libc, font, and terminal emulator.
|
||||||
|
|
||||||
|
# SEE ALSO
|
||||||
|
notcurses(3notcurses), ncurses(3ncurses), terminfo(5)
|
Loading…
x
Reference in New Issue
Block a user