bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 16/17] Consistently discuss tab stop initialization database.


From: G. Branden Robinson
Subject: [PATCH 16/17] Consistently discuss tab stop initialization database.
Date: Fri, 13 Oct 2023 18:42:11 -0500

Drop use of glob syntax in file reference.  It makes no sense when using
a hashed terminfo database.  (The man page also fails to indicate the
correct file name when a hashed database in use, but that problem
requires a more intrusive change to fix.)

Alphabetize items in "FILES" section by "basename", since it's not in
our power (barring circus tricks) to sort the list by the full file
specification, which starts with a user-configured portion (consider
"--prefix=$HOME").

* man/ncurses.3x: Update discussion of tset(1).  You don't need to use
  it to initialize the tab stops if you're already using tput(1).  Tune
  cross reference to terminfo(3) to include section title.  Set
  parenthesized section number in roman in man page cross reference, not
  bold.  Identify target of cross reference as subsection, not section.
  Drop "for further details" from cross reference; why else would
  someone look?  Only specifics are worthwhile in cross references;
  "see" implies "for {further details,more information}".
  Update "FILES" section entry for "tabset" database to describe
  it instead of "terminfo" (copy-and-paste error?).
* man/tabs.1: Add "FILES" section and mention the tab stop
  initialization database.
* man/tput.1: Simplify description of tab stop initialization database.
---
 man/ncurses.3x |  8 ++++----
 man/tabs.1     |  4 ++++
 man/tput.1     | 11 +++--------
 3 files changed, 11 insertions(+), 12 deletions(-)

diff --git a/man/ncurses.3x b/man/ncurses.3x
index 04342e4a..0d9c50fa 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -138,8 +138,8 @@ .SS Initialization
 should be set and its initialization strings, if defined, must be output.
 This can be done by executing the \fB@TPUT@ init\fP command
 after the shell environment variable \fBTERM\fP has been exported.
-\fB@TSET@(1)\fP is usually responsible for doing this.
-[See \fBterminfo\fP(\*n) for further details.]
+(The BSD-style \fB\%@TSET@\fP(1) utility also performs this function.)
+See subsection \*(``Tabs and Initialization\*('' of \fBterminfo\fP(\*n).
 .SS Datatypes
 The \fBncurses\fP library permits manipulation of data structures,
 called \fIwindows\fP, which can be thought of as two-dimensional
@@ -1368,8 +1368,8 @@ .SH ALTERNATE CONFIGURATIONS
 than assuming it is always in the debug library.
 .SH FILES
 .TP 5
-@DATADIR@/tabset
-directory containing initialization files for the terminal capability database
+.I @DATADIR@/tabset
+tab stop initialization database
 .TP
 .I \*d
 compiled terminal capability database
diff --git a/man/tabs.1 b/man/tabs.1
index 86fc74fc..ba8ed09c 100644
--- a/man/tabs.1
+++ b/man/tabs.1
@@ -217,6 +217,10 @@ .SS Margins
 .PP
 When setting or resetting the left-margin,
 @TABS@ may reset the right-margin.
+.SH FILES
+.TP
+.I @DATADIR@/tabset
+tab stop initialization database
 .SH PORTABILITY
 \fIIEEE Std 1003.1/The Open Group Base Specifications Issue 7\fP (POSIX.1-2008)
 describes a \fBtabs\fP utility.
diff --git a/man/tput.1 b/man/tput.1
index 16912d12..48e88263 100644
--- a/man/tput.1
+++ b/man/tput.1
@@ -369,16 +369,11 @@ .SH EXAMPLES
 The list is terminated by an exclamation mark (\fB!\fP) on a line by itself.
 .SH FILES
 .TP
+.I @DATADIR@/tabset
+tab stop initialization database
+.TP
 .I \*d
 compiled terminal description database
-.TP
-\fB@DATADIR@/tabset/*\fP
-tab settings for some terminals, in a format
-appropriate to be output to the terminal (escape
-sequences that set margins and tabs); for more
-information, see the
-.IR "Tabs and Initialization" ,
-section of \fBterminfo\fP(5)
 .SH EXIT CODES
 If the \fB\-S\fP option is used,
 \fB@TPUT@\fP checks for errors from each line,
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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