man page for colloquy

This commit is contained in:
nick black 2020-04-06 05:19:22 -04:00
parent b12ec8d555
commit 37b5564722
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 45 additions and 0 deletions

View File

@ -17,6 +17,7 @@
<h1><a href="https://nick-black.com/dankwiki/index.php/Notcurses">notcurses</a> man pages (v1.2.5)</h1>
<a href="notcurses.3.html">notcurses(3)</a>—a blingful TUI library<br/>
<h2>Binaries (section 1)</h2>
<a href="colloquy.1.html">colloquy</a>—attractive terminal dialogs<br/>
<a href="notcurses-demo.1.html">notcurses-demo</a>—shows off some notcurses features<br/>
<a href="notcurses-input.1.html">notcurses-input</a>—reads and decodes input events<br/>
<a href="notcurses-keyplot.1.html">notcurses-input</a>—plots input events over time<br/>

View File

@ -0,0 +1,44 @@
% colloquy(1)
% nick black <nickblack@linux.com>
% v1.2.5
# NAME
colloquy - Command line dialogs and widgets
# SYNOPSIS
**colloquy** [**-h|--help**]
# DESCRIPTION
**colloquy** uses notcurses to construct attractive widgets from the command
line and shell scripts. It can be used with any terminal environment, and
supports both keyboards and mice. Available widget types include:
* Message boxes requiring a button press to continue
* Selection of a single item from a list
* Selection of zero or more items from a list
Data to be displayed is provided on the command line, and the user's input
is reported on standard output. If the user aborts, the program returns
non-zero.
**colloquy** is inspired by (and compatible with a subset of) **dialog(1)**,
a similar tool built atop NCURSES.
# OPTIONS
**-h**|**--help**: Display a usage message
# 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
fixed-width font with good coverage of the Unicode Block Drawing Characters.
# SEE ALSO
**dialog(1)**,
**notcurses(3)**