]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/captoinfo.1m
ncurses 6.4 - patch 20231125
[ncurses.git] / man / captoinfo.1m
index 40c09f5a213fb8207aa7fc7c9466d303336eca5f..35b92a20bd0331a8958cd8784e749acb1090d51c 100644 (file)
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
+.\" Copyright 2018-2022,2023 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: captoinfo.1m,v 1.16 2000/08/13 01:56:49 tom Exp $
-.TH captoinfo 1M ""
-.ds n 5
-.ds d @TERMINFO@
+.\" $Id: captoinfo.1m,v 1.54 2023/11/25 14:32:36 tom Exp $
+.TH @CAPTOINFO@ 1M 2023-11-25 "ncurses 6.4" "User commands"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.ds '  \(aq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.ie t .ds '  \(aq
+.el   .ds '  '
+.\}
+.
+.ds d /etc/termcap
 .SH NAME
-\fBcaptoinfo\fR - convert a \fItermcap\fR description into a \fIterminfo\fR description
+\fB\%@CAPTOINFO@\fP \-
+convert a \fItermcap\fR description into a \fIterminfo\fR description
 .SH SYNOPSIS
-\fBcaptoinfo\fR [\fB-v\fR\fIn\fR \fIwidth\fR]  [\fB-V\fR] [\fB-1\fR] [\fB-w\fR \fIwidth\fR] \fIfile\fR . . .
+.B @CAPTOINFO@
+.RI [ tic-option ]
+.RI [ file
+\&.\|.\|.]
+.P
+.B "@CAPTOINFO@ \-V"
 .SH DESCRIPTION
-\fBcaptoinfo\fR looks in \fIfile\fR for \fBtermcap\fR descriptions.  For each
-one found, an equivalent \fBterminfo\fR description is written to standard
-output.  Termcap \fBtc\fR capabilities are translated directly to terminfo
-\fBuse\fR capabilities.
-
-If no \fIfile\fR is given, then the environment variable \fBTERMCAP\fR is used
-for the filename or entry.  If \fBTERMCAP\fR is a full pathname to a file, only
-the terminal whose name is specified in the environment variable \fBTERM\fR is
-extracted from that file.  If the environment variable \fBTERMCAP\fR is not
-set, then the file \fB\*d\fR is read.
-.TP 5
-\fB-v\fR
-print out tracing information on standard error as the program runs.
-.TP 5
-\fB-V\fR
-print out the version of the program in use on standard error and exit.
-.TP 5
-\fB-1\fR
-cause the fields to print out one to a line.  Otherwise, the fields
-will be printed several to a line to a maximum width of 60
-characters.
-.TP 5
-\fB-w\fR
-change the output to \fIwidth\fR characters.
-.SH FILES
-.TP 20
-\*d
-Compiled terminal description database.
-.SH TRANSLATIONS FROM NONSTANDARD CAPABILITIES
+\fB\%@CAPTOINFO@\fP translates terminal descriptions.
+It looks in each given text \fIfile\fP for \fI\%termcap\fP entries and,
+for each one found,
+writes an equivalent \fI\%terminfo\fP description to the standard output
+stream.
+\fI\%termcap\fP \fBtc\fP capabilities translate to \fI\%terminfo\fP
+\*(``\fBuse\fP\*('' capabilities.
+.PP
+If no \fIfile\fPs are specified,
+\fB\%@CAPTOINFO@\fP interprets the content of the environment variable
+\fI\%TERMCAP\fP as a file name,
+and extracts only the entry for the terminal named in the environment
+variable \fITERM\fP from it.
+If the environment variable \fI\%TERMCAP\fP is not set,
+\fB\%@CAPTOINFO@\fP reads \fI\%\*d\fP.
 .PP
-Some obsolete nonstandard capabilities will automatically be translated
-into standard (SVr4/XSI Curses) terminfo capabilities by \fBcaptoinfo\fR.
-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.
+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
+.BR \-1 ,
+.BR \-f ,
+.BR \-v ,
+.BR \-w ,
+and
+.BR \-x .
+The \fB\-V\fP option reports the version of \fI\%ncurses\fP associated
+with this program and exits with a successful status.
+.SS "Translations from nonstandard capabilities"
+\fB\%@CAPTOINFO@\fP translates some obsolete,
+nonstandard capabilities into standard
+(SVr4/XSI Curses)
+\fI\%terminfo\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 H
-c c c c
-c c c c
-l l l l.
-Nonstd Std     From    Terminfo
-name   name            capability
+.TS
+Cb S
+Cb Cb Cb Cb
+Cb Cb C  Lb.
+Name
+Obsolete       Standard        Origin  \f(BIterminfo\fP capability
 _
 BO     mr      AT&T    enter_reverse_mode
 CI     vi      AT&T    cursor_invisible
@@ -99,62 +120,70 @@ PS pf      XENIX   prtr_on
 PU     kP      XENIX   key_ppage
 RT     @8      XENIX   kent
 UP     ku      XENIX   kcuu1
-KA     k;      Tek     key_f10
-KB     F1      Tek     key_f11
-KC     F2      Tek     key_f12
-KD     F3      Tek     key_f13
-KE     F4      Tek     key_f14
-KF     F5      Tek     key_f15
-BC     Sb      Tek     set_background
-FC     Sf      Tek     set_foreground
-HS     mh      Iris    enter_dim_mode
+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 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 \fI\%termcap\fP had a set of extension capabilities,
+corresponding to box drawing characters of CCSID
+(\*(``code page\*('') 437,
+as follows.
 .PP
-.TS H
-c c
-l l.
-Cap    Graphic
+.TS
+cb cb
+cb l .
+\f(BItermcap\fP 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\fR string.  The double-line capabilities and
-\fBGG\fR are discarded with a warning message.
+\fB\%@CAPTOINFO@\fP composes single-line capabilities into an \fBacsc\fP
+string,
+and discards \fBGG\fP and double-line capabilities with a warning
+diagnostic.
 .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 \fI\%terminfo\fP facility descended from SVr1
+\fI\%terminfo\fP,
+but which is incompatible with the SVr4 format.
+\fB\%@CAPTOINFO@\fP translates the following AIX extensions.
 .PP
 .TS
-c c
-l l.
+cb cb
+l  l .
 IBM    XSI
 _
 ksel   kslt
@@ -165,25 +194,38 @@ font2     s2ds
 font3  s3ds
 .TE
 .PP
-Additionally, the AIX \fBbox1\fR capability will be automatically translated to
-an \fBacsc\fR 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\fR (memory lock) and \fBmemu\fR (memory unlock).
-These will be discarded with a warning message.
+The HP-UX \fI\%terminfo\fP library supports two nonstandard
+\fI\%terminfo\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 \fI\%termcap\fP terminal capability database
 .SH NOTES
-This utility is actually a link to \fItic\fR(1M), running in \fI-I\fR mode.
-You can use other \fItic\fR options such as \fB-f\fR and  \fB-x\fR.
-
-The trace option isn't identical to SVr4's.  Under SVr4, instead of following
-the -v with a trace level n, you repeat it n times.
-.SH SEE ALSO
-\fBcurses\fR(3X), \fB@INFOCMP@\fR(1M), \fBterminfo\fR(\*n)
-.SH AUTHOR
+The verbose option is not identical to SVr4's.
+Under SVr4,
+instead of following 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 \fB\%captoinfo\fP as a separate application from
+\fBtic\fP.
+.PP
+NetBSD does not provide this application.
+.SH AUTHORS
 Eric S. Raymond <esr@snark.thyrsus.com>
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+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)