ncurses/man/captoinfo.1m

'\" t
.\"***************************************************************************
.\" Copyright 2018-2024,2025 Thomas E. Dickey                                *
.\" Copyright 1998-2010,2016 Free Software Foundation, Inc.                  *
.\"                                                                          *
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
.\" copy of this software and associated documentation files (the            *
.\" "Software"), to deal in the Software without restriction, including      *
.\" without limitation the rights to use, copy, modify, merge, publish,      *
.\" distribute, distribute with modifications, sublicense, and/or sell       *
.\" copies of the Software, and to permit persons to whom the Software is    *
.\" furnished to do so, subject to the following conditions:                 *
.\"                                                                          *
.\" The above copyright notice and this permission notice shall be included  *
.\" in all copies or substantial portions of the Software.                   *
.\"                                                                          *
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
.\"                                                                          *
.\" Except as contained in this notice, the name(s) of the above copyright   *
.\" holders shall not be used in advertising or otherwise to promote the     *
.\" sale, use or other dealings in this Software without prior written       *
.\" authorization.                                                           *
.\"***************************************************************************
.\"
.\" $Id: captoinfo.1m,v 1.77 2025/11/12 01:03:56 tom Exp $
.TH @CAPTOINFO@ 1M 2025-11-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
.\}
.el \{\
.ie t .ds `` ``
.el   .ds `` ""
.ie t .ds '' ''
.el   .ds '' ""
.\}
.SH NAME
\fB\%@CAPTOINFO@\fP \-
convert a \fItermcap\fP description into a \fI\%term\%info\fP description
.SH SYNOPSIS
.B @CAPTOINFO@
.RI [ tic-option ]
.RI [ file
\&.\|.\|.]
.P
.B "@CAPTOINFO@ \-V"
.SH DESCRIPTION
.B \%@CAPTOINFO@
translates terminal descriptions.
It looks in each given text
.I file
for
.I termcap
entries and,
for each one found,
writes an equivalent
.I term\%info
description to the standard output stream.
.I termcap
.B tc
capabilities translate to
.I term\%info
.RB \*(`` use \*(''
capabilities.
.PP
If no
.IR file s
are specified,
.B \%@CAPTOINFO@
interprets the content of the environment variable
.I \%TERMCAP
as a file name,
and extracts only the entry for the terminal type named
in the environment variable
.I TERM
from it.
If the environment variable
.I \%TERMCAP
is not set,
.B \%@CAPTOINFO@
reads
.IR \%/etc/termcap "."
.PP
This utility is implemented as a link to \fB\%@TIC@\fP(1M),
with the latter's
.B \-I
option implied.
You can use other
.B \%@TIC@
options such as
.BR \-1 ,
.BR \-f ,
.BR \-v ,
.BR \-w ,
and
.BR \-x .
The
.B \-V
option reports the version of
.I \%ncurses
associated with this program and exits with a successful status.
.SS "Translations from Nonstandard Capabilities"
.B \%@CAPTOINFO@
translates some obsolete,
nonstandard capabilities into standard
.I term\%info
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
.\" DWB 3.3 and Plan 9 tbl require the two junk "L" specifiers in the
.\" first row description.  System V, GNU, and Heirloom Doctools tbl do
.\" not; they "rectangularize" the table geometry.
.TS
center;
Cb S  L  L
Cb Cb Cb Cb
Cb Cb C  Lb.
\f(BItermcap\fP Code
Obsolete	Standard	Origin	\f(BIterminfo\fP capability
_
BO	mr	AT&T	enter_reverse_mode
CI	vi	AT&T	cursor_invisible
CV	ve	AT&T	cursor_normal
DS	mh	AT&T	enter_dim_mode
EE	me	AT&T	exit_attribute_mode
FE	LF	AT&T	label_on
FL	LO	AT&T	label_off
XS	mk	AT&T	enter_secure_mode
EN	@7	XENIX	key_end
GE	ae	XENIX	exit_alt_charset_mode
GS	as	XENIX	enter_alt_charset_mode
HM	kh	XENIX	key_home
LD	kL	XENIX	key_dl
PD	kN	XENIX	key_npage
PN	po	XENIX	prtr_off
PS	pf	XENIX	prtr_on
PU	kP	XENIX	key_ppage
RT	@8	XENIX	kent
UP	ku	XENIX	kcuu1
KA	k;	Tektronix	key_f10
KB	F1	Tektronix	key_f11
KC	F2	Tektronix	key_f12
KD	F3	Tektronix	key_f13
KE	F4	Tektronix	key_f14
KF	F5	Tektronix	key_f15
BC	Sb	Tektronix	set_background
FC	Sf	Tektronix	set_foreground
HS	mh	IRIX	enter_dim_mode
.TE
.PP
XENIX
.I termcap
had a set of extension capabilities,
corresponding to box drawing characters of CCSID
(\*(``code page\*('') 437,
as follows.
.PP
.TS
center;
Cb Cb
Cb L .
\f(BItermcap\fP Code	Graphic
_
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	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
.B \%@CAPTOINFO@
composes single-line box-drawing capabilities into a
.I term\%info
.B \%acs_chars
.RB \%( acsc )
string capability,
and discards
.B GG
and double-line capabilities with a warning
diagnostic.
.PP
AIX has a
.I term\%info
facility descended from SVr2
.IR term\%info ","
but which is incompatible with the SVr4 format.
.B \%@CAPTOINFO@
translates the following AIX extensions.
.PP
.TS
center;
Cb Cb
L  L .
IBM	X/Open
_
ksel	kslt
kbtab	kcbt
font0	s0ds
font1	s1ds
font2	s2ds
font3	s3ds
.TE
.PP
It furthermore translates the AIX
.B box1
capability to an
.B \%acs_chars
.RB \%( acsc )
string capability.
.PP
The HP-UX
.I \%term\%info
library supports two nonstandard
.I \%term\%info
capabilities:
.B \%memory_lock
.RB ( meml )
and
.B \%memory_unlock
.RB ( memu ).
.B \%@CAPTOINFO@
discards these with a warning message.
.SH FILES
.TP
.I /etc/termcap
default
.I termcap
terminal capability database
.SH EXTENSIONS
This command is an SVr4
.I curses
and
.I \%ncurses
extension.
.SH PORTABILITY
X/Open Curses Issue\ 7 (2009) does not specify this command.
.PP
SVr4 systems provide
.I \%captoinfo
as a separate application from
.IR \%tic "."
Its
.B \-v
option does not accept a trace level argument
.IR n ;
repeat
.B \-v
.I n
times instead.
.PP
NetBSD does not provide this application.
.SH AUTHORS
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(5)