bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 30/61] Standardize "terminal type" nomenclature.


From: G. Branden Robinson
Subject: [PATCH 30/61] Standardize "terminal type" nomenclature.
Date: Fri, 24 Nov 2023 12:05:03 -0600

* man/clear.1:
* man/infocmp.1m:
* man/tic.1m:
* man/tput.1:
* man/tset.1: Refer to terminal types as such, not variously as "names",
  "termnames", or "types".  Hyphenate this noun phrase when using it as
  a metasyntactic variable.
---
 man/clear.1    |  2 +-
 man/infocmp.1m | 54 ++++++++++++++++++++++++++++----------------------
 man/tic.1m     |  8 ++++----
 man/tput.1     | 10 +++++-----
 man/tset.1     |  4 ++--
 5 files changed, 42 insertions(+), 36 deletions(-)

diff --git a/man/clear.1 b/man/clear.1
index 5351a2bc..24921c95 100644
--- a/man/clear.1
+++ b/man/clear.1
@@ -56,7 +56,7 @@ .SH SYNOPSIS
 .B @CLEAR@
 .RB [ \-x ]
 .RB [ \-T\ \c
-.IR type ]
+.IR terminal-type ]
 .PP
 .B "@CLEAR@ \-V"
 .SH DESCRIPTION
diff --git a/man/infocmp.1m b/man/infocmp.1m
index a4c066b7..9c9364b7 100644
--- a/man/infocmp.1m
+++ b/man/infocmp.1m
@@ -82,7 +82,7 @@ .SH SYNOPSIS
 \fP]
       [\fB\-v\fR \fIn\fR] [\fB\-s d\fR| \fBi\fR| \fBl\fR| \fBc\fR] [\fB\-Q\fR 
\fIn\fR] [\fB\-R \fBsubset\fR]
       [\fB\-w\fP\ \fIwidth\fP] [\fB\-A\fP\ \fIdirectory\fP] [\fB\-B\fP\ 
\fIdirectory\fP]
-      [\fItermname\fP...]
+      [\fIterminal-type\fP ...]
 .SH DESCRIPTION
 \fB@INFOCMP@\fP can be used to compare a binary \fBterminfo\fP entry with other
 terminfo entries, rewrite a \fBterminfo\fP description to take advantage of the
@@ -92,14 +92,16 @@ .SH DESCRIPTION
 fields will be printed first, followed by the numeric fields, followed by the
 string fields.
 .SS Default Options
-If no options are specified and zero or one \fItermnames\fP are specified, the
+If no options are specified and zero or one \fIterminal-types\fP are
+specified,
+the
 \fB\-I\fP option will be assumed.
-If more than one \fItermname\fP is specified,
+If more than one \fIterminal-type\fP is specified,
 the \fB\-d\fP option will be assumed.
 .SS Comparison Options [\-d] [\-c] [\-n]
 \fB@INFOCMP@\fP compares the \fBterminfo\fP description of the first terminal
-\fItermname\fP with each of the descriptions given by the entries for the other
-terminal's \fItermnames\fP.
+\fIterminal-type\fP with each of the descriptions given by the entries
+for the other terminal's \fIterminal-types\fP.
 If a capability is defined for only one of the
 terminals, the value returned depends on the type of the capability:
 .bP
@@ -138,9 +140,9 @@ .SS Comparison Options [\-d] [\-c] [\-n]
 Use the \fB\-x\fP option to add the BSD-compatibility
 capabilities (names prefixed with \*(``OT\*('').
 .IP
-If no \fItermnames\fP are given,
+If no \fIterminal-types\fP are given,
 \fB@INFOCMP@\fP uses the environment variable \fBTERM\fP
-for each of the \fItermnames\fP.
+for each of the \fIterminal-types\fP.
 .SS Source Listing Options [\-I] [\-L] [\-C] [\-r]
 The \fB\-I\fP, \fB\-L\fP, and \fB\-C\fP options will produce
 a source listing for each terminal named.
@@ -155,8 +157,8 @@ .SS Source Listing Options [\-I] [\-L] [\-C] [\-r]
 \fB\-K\fP/modifies the \fB\-C\fP option, improving BSD-compatibility.
 .TE
 .PP
-If no \fItermnames\fP are given, the environment variable \fBTERM\fP will be
-used for the terminal name.
+If no \fIterminal-types\fP are given,
+the environment variable \fBTERM\fP will be used for the terminal name.
 .PP
 The source produced by the \fB\-C\fP option may be used directly as a
 \fBtermcap\fP entry, but not all parameterized strings can be changed to
@@ -223,12 +225,12 @@ .SS Source Listing Options [\-I] [\-L] [\-C] [\-r]
 .TE
 .SS Use= Option [\-u]
 The \fB\-u\fP option produces a \fBterminfo\fP source description of the first
-terminal \fItermname\fP which is relative to the sum of the descriptions given
-by the entries for the other terminals \fItermnames\fP.
+terminal \fIterminal-type\fP which is relative to the sum of the
+descriptions given by the entries for the other \fIterminal-types\fP.
 It does this by
-analyzing the differences between the first \fItermname\fP and the other
-\fItermnames\fP and producing a description with \fBuse=\fP fields for the
-other terminals.
+analyzing the differences between the first \fIterminal-types\fP and the
+other \fIterminal-types\fP and producing a description with \fBuse=\fP
+fields for the other terminals.
 In this manner, it is possible to retrofit generic terminfo
 entries into a terminal's description.
 Or, if two similar terminals exist, but
@@ -238,21 +240,24 @@ .SS Use= Option [\-u]
 one description to be relative to the other.
 .PP
 A capability will be printed with an at-sign (@) if it no longer exists in the
-first \fItermname\fP, but one of the other \fItermname\fP entries contains a
-value for it.
+first \fIterminal-type\fP,
+but one of the other \fIterminal-type\fP entries contains a value for
+it.
 A capability's value will be printed if the value in the first
-\fItermname\fP is not found in any of the other \fItermname\fP entries, or if
-the first of the other \fItermname\fP entries that has this capability gives a
-different value for the capability than that in the first \fItermname\fP.
+\fIterminal-type\fP is not found in any of the other \fIterminal-type\fP
+entries,
+or if the first of the other \fIterminal-type\fP entries that has this
+capability gives a different value for the capability than that in the
+first \fIterminal-type\fP.
 .PP
-The order of the other \fItermname\fP entries is significant.
+The order of the other \fIterminal-type\fP entries is significant.
 Since the
 terminfo compiler \fB@TIC@\fP does a left-to-right scan of the capabilities,
 specifying two \fBuse=\fP entries that contain differing entries for the same
 capabilities will produce different results depending on the order that the
 entries are given in.
 \fB@INFOCMP@\fP will flag any such inconsistencies between
-the other \fItermname\fP entries as they are found.
+the other \fIterminal-type\fP entries as they are found.
 .PP
 Alternatively, specifying a capability \fIafter\fP a \fBuse=\fP entry that
 contains that capability will cause the second specification to be ignored.
@@ -263,7 +268,7 @@ .SS Use= Option [\-u]
 Another error that does not cause incorrect compiled files, but will slow down
 the compilation time, is specifying extra \fBuse=\fP fields that are
 superfluous.
-\fB@INFOCMP@\fP will flag any other \fItermname use=\fP fields that
+\fB@INFOCMP@\fP will flag any other \fIterminal-type use=\fP fields that
 were not needed.
 .SS Changing Databases [\-A \fIdirectory\fR] [\-B \fIdirectory\fR]
 Like other \fBncurses\fP utilities,
@@ -277,9 +282,10 @@ .SS Changing Databases [\-A \fIdirectory\fR] [\-B 
\fIdirectory\fR]
 and \fB\-B\fP to override the list of places to search
 when comparing terminal descriptions:
 .bP
-The \fB\-A\fP option sets the location for the first \fItermname\fP
+The \fB\-A\fP option sets the location for the first \fIterminal-type\fP
 .bP
-The \fB\-B\fP option sets the location for the other \fItermnames\fP.
+The \fB\-B\fP option sets the location for the other
+\fIterminal-types\fP.
 .PP
 Using these options, it is possible to
 compare descriptions for a terminal with the same name located in two different
diff --git a/man/tic.1m b/man/tic.1m
index 62e9d99a..21109c08 100644
--- a/man/tic.1m
+++ b/man/tic.1m
@@ -76,7 +76,7 @@ .SH SYNOPSIS
 W\
 x\
 \fP]
-[\fB\-e\fP \fInames\fP]
+[\fB\-e\fP \fIterminal-type-list\fP]
 [\fB\-o\fP \fIdir\fP]
 [\fB\-Q\fP[\fIn\fP]]
 [\fB\-R\fP \fIsubset\fP]
@@ -216,9 +216,9 @@ .SH OPTIONS
 it will print a diagnostic and exit with an error rather than
 printing a list of database locations.
 .TP
-\fB\-e \fInames\fR
-Limit writes and translations to the following comma-separated list of
-terminals.
+\fB\-e \fIlist\fR
+Limit writes and translations to the comma-separated \fIlist\fP of
+terminal types.
 If any name or alias of a terminal matches one of the names in
 the list, the entry will be written or translated as normal.
 Otherwise no output will be generated for it.
diff --git a/man/tput.1 b/man/tput.1
index 7dc42d86..d568ad43 100644
--- a/man/tput.1
+++ b/man/tput.1
@@ -52,15 +52,15 @@ .SH NAME
 \fB\%reset\fP \-
 initialize a terminal or query \fIterminfo\fR database
 .SH SYNOPSIS
-\fB@TPUT@\fR [\fB\-T\fItype\fR] \fIcapname\fR [\fIparameters\fR]
+\fB@TPUT@\fR [\fB\-T \fIterminal-type\fR] \fIcapname\fR [\fIparameters\fR]
 .br
-\fB@TPUT@\fR [\fB\-T\fItype\fR] [\fB\-x\fR] \fBclear\fR
+\fB@TPUT@\fR [\fB\-T \fIterminal-type\fR] [\fB\-x\fR] \fBclear\fR
 .br
-\fB@TPUT@\fR [\fB\-T\fItype\fR] \fBinit\fR
+\fB@TPUT@\fR [\fB\-T \fIterminal-type\fR] \fBinit\fR
 .br
-\fB@TPUT@\fR [\fB\-T\fItype\fR] \fBreset\fR
+\fB@TPUT@\fR [\fB\-T \fIterminal-type\fR] \fBreset\fR
 .br
-\fB@TPUT@\fR [\fB\-T\fItype\fR] \fBlongname\fR
+\fB@TPUT@\fR [\fB\-T \fIterminal-type\fR] \fBlongname\fR
 .br
 \fB@TPUT@ \-S\fP  \fB<<\fP
 .br
diff --git a/man/tset.1 b/man/tset.1
index 504bdbbb..ffaaf32f 100644
--- a/man/tset.1
+++ b/man/tset.1
@@ -53,9 +53,9 @@ .SH NAME
 \fB\%@RESET@\fP \-
 initialize or reset terminal state
 .SH SYNOPSIS
-\fB@TSET@\fP [\fB\-IQVcqrsw\fP] [\fB\-\fP] [\fB\-e\fP \fIch\fP] [\fB\-i\fP 
\fIch\fP] [\fB\-k\fP \fIch\fP] [\fB\-m\fP \fImapping\fP] [\fIterminal\fP]
+\fB@TSET@\fP [\fB\-IQVcqrsw\fP] [\fB\-\fP] [\fB\-e\fP \fIch\fP] [\fB\-i\fP 
\fIch\fP] [\fB\-k\fP \fIch\fP] [\fB\-m\fP \fImapping\fP] [\fIterminal-type\fP]
 .br
-\fB@RESET@\fP [\fB\-IQVcqrsw\fP] [\fB\-\fP] [\fB\-e\fP \fIch\fP] [\fB\-i\fP 
\fIch\fP] [\fB\-k\fP \fIch\fP] [\fB\-m\fP \fImapping\fP] [\fIterminal\fP]
+\fB@RESET@\fP [\fB\-IQVcqrsw\fP] [\fB\-\fP] [\fB\-e\fP \fIch\fP] [\fB\-i\fP 
\fIch\fP] [\fB\-k\fP \fIch\fP] [\fB\-m\fP \fImapping\fP] [\fIterminal-type\fP]
 .SH DESCRIPTION
 .SS tset - initialization
 This program initializes terminals.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]