.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: captoinfo.1m,v 1.44 2023/09/16 23:39:05 tom Exp $
-.TH @CAPTOINFO@ 1M 2023-09-16 "ncurses 6.4" "User commands"
+.\" $Id: captoinfo.1m,v 1.50 2023/10/01 22:22:00 tom Exp $
+.TH @CAPTOINFO@ 1M 2023-10-01 "ncurses 6.4" "User commands"
+.ie \n(.g .ds `` \(lq
+.el .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el .ds '' ''
+.ie \n(.g .ds `` \(lq
+.el .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el .ds '' ''
.ds n 5
-.ds d @TERMINFO@
+.ds d /etc/termcap
.SH NAME
\fB\%@CAPTOINFO@\fP \-
convert a \fItermcap\fR description into a \fIterminfo\fR description
.SH SYNOPSIS
.B @CAPTOINFO@
.RI [ tic-option ]
-.I file
-\&.\|.\|.
+.RI [ file
+\&.\|.\|.]
.P
-\fB@CAPTOINFO@\fR \fB\-V\fR
+.B "@CAPTOINFO@ \-V"
.SH DESCRIPTION
-\fB@CAPTOINFO@\fP looks in each given text
-\fIfile\fP for \fBtermcap\fP descriptions.
-For each
-one found, an equivalent \fBterminfo\fP description is written to standard
-output.
-Termcap \fBtc\fP capabilities are translated directly to terminfo
-\fBuse\fP capabilities.
+\fB\%@CAPTOINFO@\fP looks in each given text
+\fIfile\fP for \fItermcap\fP descriptions.
+For each one found,
+it writes an equivalent \fIterminfo\fP description to the standard
+output stream.
+\fItermcap\fP \fBtc\fP capabilities are translated directly to
+\fIterminfo\fP \*(``\fBuse\fP\*('' capabilities.
.PP
-If no \fIfile\fP is given, then the environment variable \fBTERMCAP\fP is used
-for the filename or entry.
-If \fBTERMCAP\fP is a full pathname to a file, only
-the terminal whose name is specified in the environment variable \fBTERM\fP is
-extracted from that file.
-If the environment variable \fBTERMCAP\fP is not
-set, then the file \fB\*d\fP is read.
+If no \fIfile\fPs are specified,
+\fB\%@CAPTOINFO@\fP interprets the content of the environment variable
+\fB\%TERMCAP\fP as a file name,
+and extracts only the entry for the terminal named in the environment
+variable \fB\%TERM\fP from it.
+If the environment variable \fB\%TERMCAP\fP is not set,
+\fB\%@CAPTOINFO@\fP reads \fI\%\*d\fP.
.PP
-This utility is implemented as a link to \fB@TIC@\fP(1M),
+This utility is implemented as a link to \fB\%@TIC@\fP(1M),
with the latter's
.B \-I
option implied.
-You can use other \fB@TIC@\fP options such as
+You can use other \fB\%@TIC@\fP options such as
.BR \-1 ,
.BR \-f ,
.BR \-v ,
.BR \-w ,
and
.BR \-x .
-.SH FILES
-.TP 20
-\*d
-Compiled terminal description database.
-.SH TRANSLATIONS FROM NONSTANDARD CAPABILITIES
-Some obsolete nonstandard capabilities will automatically be translated
-into standard (SVr4/XSI Curses) terminfo capabilities by \fB@CAPTOINFO@\fP.
-Whenever one of these automatic translations is done, the program
-will issue an notification to stderr, inviting the user to check that
-it has not mistakenly translated a completely unknown and random
-capability and/or syntax error.
+.SS "Translations from nonstandard capabilities"
+\fB\%@CAPTOINFO@\fP translates some obsolete,
+nonstandard capabilities into standard (SVr4/XSI Curses) \fIterminfo\fP
+capabilities.
+It issues a diagnostic to the standard error stream for each,
+inviting the user to check that it has not mistakenly translated an
+unknown or mistyped capability name.
.PP
.TS
cb cb cb cb
cb cb cb cb
-l l l l .
-Nonstd Std \& Terminfo
+cb cb l lb.
+Nonstandard Standard \& \f(BIterminfo\fP
name name From capability
_
BO mr AT&T enter_reverse_mode
HS mh Iris enter_dim_mode
.TE
.PP
-XENIX termcap also used to have a set of extension capabilities
-for forms drawing, designed to take advantage of the IBM PC
-high-half graphics.
-They were as follows:
+XENIX \fItermcap\fP had a set of extension capabilities,
+corresponding to box drawing characters of CCSID
+(\*(``code page\*('') 437,
+as follows.
.PP
.TS
cb cb
-l l.
-Cap Graphic
+cb cb
+cb l .
+Termcap
+Name Graphic
_
-G2 upper left
-G3 lower left
-G1 upper right
-G4 lower right
-GR pointing right
-GL pointing left
-GU pointing up
-GD pointing down
+G2 upper left corner
+G3 lower left corner
+G1 upper right corner
+G4 lower right corner
+GR tee pointing right
+GL tee pointing left
+GU tee pointing up
+GD tee pointing down
GH horizontal line
GV vertical line
GC intersection
-G6 upper left
-G7 lower left
-G5 upper right
-G8 lower right
-Gr tee pointing right
-Gr tee pointing left
-Gu tee pointing up
-Gd tee pointing down
-Gh horizontal line
-Gv vertical line
-Gc intersection
-GG acs magic cookie count
+G6 double upper left corner
+G7 double lower left corner
+G5 double upper right corner
+G8 double lower right corner
+Gr double tee pointing right
+Gr double tee pointing left
+Gu double tee pointing up
+Gd double tee pointing down
+Gh double horizontal line
+Gv double vertical line
+Gc double intersection
+.\" TODO: There are about 40 box drawing code points in CCSID 437;
+.\" were there no XENIX capabilities for the mixed single- and double-
+.\" line intersections?
+.\"
+.\" TODO: GG doesn't seem to fit with the others; explain it.
+GG ACS magic cookie count
.TE
.PP
-If the single-line capabilities occur in an entry, they will automatically
-be composed into an \fBacsc\fP string.
+If the single-line capabilities occur in an entry,
+they are composed into an \fBacsc\fP string.
The double-line capabilities and
\fBGG\fP are discarded with a warning message.
.PP
-IBM's AIX has a terminfo facility descended from SVr1 terminfo but incompatible
-with the SVr4 format.
-The following AIX extensions are automatically
-translated:
+IBM's AIX has a \fIterminfo\fP facility descended from SVr1
+\fIterminfo\fP,
+but which is incompatible with the SVr4 format.
+\fB\%@CAPTOINFO@\fP translates the following AIX extensions.
.PP
.TS
cb cb
font3 s3ds
.TE
.PP
-Additionally, the AIX \fIbox1\fP capability will be automatically translated to
-an \fBacsc\fP string.
+Additionally,
+this program translates the AIX \fBbox1\fP capability to an \fBacsc\fP
+string.
.PP
-Hewlett-Packard's terminfo library supports two nonstandard terminfo
-capabilities \fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
-These will be discarded with a warning message.
+The HP-UX \fIterminfo\fP library supports two nonstandard \fIterminfo\fP
+capabilities,
+\fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
+\fB\%@CAPTOINFO@\fP discards these with a warning message.
+.SH FILES
+.TP
+\fI\*d\fP
+default \fItermcap\fP terminal capability database
.SH NOTES
The verbose option is not identical to SVr4's.
Under SVr4, instead of following
-the \fB\-v\fP with a trace level n, you repeat it n times.
+the \fB\-v\fP with a trace level \fIn\fP,
+you repeat it \fIn\fP times.
.SH PORTABILITY
X/Open Curses, Issue 7 (2009) describes \fBtic\fP briefly,
but omits this program.
-SVr4 systems provide \fBcaptoinfo\fP as a separate application from \fBtic\fP.
+SVr4 systems provide \fB\%captoinfo\fP as a separate application from
+\fBtic\fP.
.PP
NetBSD does not provide this application.
-.SH SEE ALSO
-\fB@INFOCMP@\fP(1M),
-\fBcurses\fP(3X),
-\fBterminfo\fP(\*n)
-.PP
-This describes \fBncurses\fP
-version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
.SH AUTHOR
Eric S. Raymond <esr@snark.thyrsus.com>
and
.br
Thomas E. Dickey <dickey@invisible-island.net>
+.SH SEE ALSO
+\fB\%@INFOCMP@\fP(1M),
+\fB\%@TIC@\fP(1M),
+\fB\%curses\fP(3X),
+\fB\%terminfo\fP(\*n)
projects / ncurses.git / blobdiff