[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 05/42] Style subsection headings consistently.
From: |
G. Branden Robinson |
Subject: |
[PATCH 05/42] Style subsection headings consistently. |
Date: |
Sat, 16 Dec 2023 11:41:19 -0600 |
Quote multi-word heading titles to avoid problems with descendants of
McIlroy man(7) (1979) that accept six arguments at most in macro calls.
Consistently use title case.
* man/curs_initscr.3x:
* man/curs_terminfo.3x:
* man/terminfo.tail: Do it.
---
man/curs_initscr.3x | 6 +++---
man/curs_terminfo.3x | 24 ++++++++++++------------
man/terminfo.tail | 38 +++++++++++++++++++-------------------
3 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/man/curs_initscr.3x b/man/curs_initscr.3x
index 20a52ad4f..d268d7e53 100644
--- a/man/curs_initscr.3x
+++ b/man/curs_initscr.3x
@@ -215,7 +215,7 @@ .SS Differences
NetBSD copied this feature of \fI\%ncurses\fP in 2001.
PDCurses follows the SVr4 model,
deleting only the standard \fBWINDOW\fP structures.
-.SS High-level versus low-level
+.SS "High-level versus Low-level"
Different implementations may disagree regarding the level of some functions.
For example, \fBSCREEN\fP (returned by \fBnewterm\fP) and
\fBTERMINAL\fP (returned by \fBsetupterm\fP(3X)) hold file descriptors for
@@ -237,7 +237,7 @@ .SS High-level versus low-level
\fBdef_shell_mode\fP(3X),
\fBdef_prog_mode\fP(3X).
SVr4 curses uses the descriptor in \fBSCREEN\fP.
-.SS Unset TERM Variable
+.SS "Unset \fITERM\fP Variable"
If the \fITERM\fP variable is missing or empty, \fBinitscr\fP uses the
value \*(``unknown\*('',
which normally corresponds to a terminal entry with the \fIgeneric\fP
@@ -245,7 +245,7 @@ .SS Unset TERM Variable
Generic entries are detected by \fBsetupterm\fP(3X)
and cannot be used for full-screen operation.
Other implementations may handle a missing/empty \fITERM\fP variable
differently.
-.SS Signal Handlers
+.SS "Signal Handlers"
Quoting from X/Open Curses Issue 7, section 3.1.1:
.RS 5
.PP
diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index 43429d5b1..276ff1f4b 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -242,7 +242,7 @@ .SS Initialization
which uses all the defaults and sends the output to \fBstdout\fP.
.RE
.\" ***************************************************************************
-.SS The Terminal State
+.SS "The Terminal State"
The \fBsetupterm\fP routine stores its information about the terminal
in a \fBTERMINAL\fP structure pointed to by the global variable \fBcur_term\fP.
If it detects an error,
@@ -277,7 +277,7 @@ .SS The Terminal State
Accordingly, \fBrestartterm\fP saves various tty state bits,
calls \fBsetupterm\fP, and then restores the bits.
.\" ***************************************************************************
-.SS Formatting Output
+.SS "Formatting Output"
The \fBtparm\fP routine instantiates the string \fIstr\fP with
parameters \fIpi\fP. A pointer is returned to the result of \fIstr\fP
with the parameters applied.
@@ -315,7 +315,7 @@ .SS Formatting Output
The extension \fBtiscan_s\fP allows the application
to inspect a formatting capability to see what the curses library would assume.
.\" ***************************************************************************
-.SS Output Functions
+.SS "Output Functions"
String capabilities can contain padding information,
a time delay
(accommodating performance limitations of hardware terminals)
@@ -389,7 +389,7 @@ .SS Output Functions
they are declared in \fB\%<curses.h>\fP because System\ V did this
(see \fIHISTORY\fP).
.\" ***************************************************************************
-.SS Terminal Capability Functions
+.SS "Terminal Capability Functions"
The \fBtigetflag\fP, \fBtigetnum\fP and \fBtigetstr\fP routines return
the value of the capability corresponding to the \fBterminfo\fP
\fIcapname\fP passed to them, such as \fBxenl\fP.
@@ -424,7 +424,7 @@ .SS Terminal Capability Functions
\fB0\fP
if it is canceled or absent from the terminal description.
.\" ***************************************************************************
-.SS Terminal Capability Names
+.SS "Terminal Capability Names"
These null-terminated arrays contain
.bP
the short \fIterminfo\fP names (\*(``codes\*(''),
@@ -443,7 +443,7 @@ .SS Terminal Capability Names
.fi
.RE
.\" ***************************************************************************
-.SS Releasing Memory
+.SS "Releasing Memory"
Each successful call to \fBsetupterm\fP allocates memory to hold the terminal
description.
As a side-effect, it sets \fBcur_term\fP to point to this memory.
@@ -524,7 +524,7 @@ .SH PORTABILITY
The function \fBsetterm\fP is not described by X/Open and must
be considered non-portable.
All other functions are as described by X/Open.
-.SS Compatibility macros
+.SS "Compatibility Macros"
This implementation provides a few macros for compatibility with systems
before SVr4 (see \fIHISTORY\fP).
Those include
@@ -548,7 +548,7 @@ .SS Compatibility macros
and is not recommended for new programs.
This implementation provides each of those symbols
as macros for BSD compatibility.
-.SS Legacy data
+.SS "Legacy Data"
\fBsetupterm\fP copies the terminal name to the array \fBttytype\fP.
This is not part of X/Open Curses, but is assumed by some applications.
.PP
@@ -558,7 +558,7 @@ .SS Legacy data
.PP
Extended terminal capability names, e.g., as defined by \fB@TIC@\ \-x\fP,
are not stored in the arrays described here.
-.SS Output buffering
+.SS "Output Buffering"
Older versions of \fI\%ncurses\fP assumed that the file descriptor
passed to \fBsetupterm\fP from \fBinitscr\fP or \fBnewterm\fP uses
buffered I/O,
@@ -576,7 +576,7 @@ .SS Output buffering
The high-level functions in \fI\%ncurses\fP use
alternate versions of these functions
using the more reliable buffering scheme.
-.SS Function prototypes
+.SS "Function Prototypes"
The X/Open Curses prototypes are based on the SVr4 curses header declarations,
which were defined at the same time the C language was first standardized in
the late 1980s.
@@ -630,7 +630,7 @@ .SS Function prototypes
.IP
The \fB@TPUT@\fR(1) program checks its use of these capabilities with a table,
so that it calls \fBtparm\fP correctly.
-.SS Special TERM treatment
+.SS "Special \fITERM\fP treatment"
If configured to use the terminal-driver,
e.g., for the MinGW port,
.bP
@@ -648,7 +648,7 @@ .SS Special TERM treatment
\fBsetupterm\fP allows explicit use of the
the windows console driver by checking if \fB$TERM\fP is set to
\*(``#win32con\*('' or an abbreviation of that string.
-.SS Other portability issues
+.SS "Other Portability Issues"
In System V Release 4, \fBset_curterm\fP has an \fBint\fP return type and
returns \fBOK\fP or \fBERR\fP. We have chosen to implement the X/Open Curses
semantics.
diff --git a/man/terminfo.tail b/man/terminfo.tail
index 1f20e81d4..8b5e3c948 100644
--- a/man/terminfo.tail
+++ b/man/terminfo.tail
@@ -29,7 +29,7 @@
.\"
.\" $Id: terminfo.tail,v 1.137 2023/12/03 00:17:23 tom Exp $
.ps +1
-.SS User-Defined Capabilities
+.SS "User-Defined Capabilities"
.
The preceding section listed the \fIpredefined\fP capabilities.
They deal with some special features for terminals no longer
@@ -81,7 +81,7 @@ Other user-defined capabilities (including function keys) are
described in the terminal database, in the section on
.I "NCURSES USER-DEFINABLE CAPABILITIES"
.
-.SS A Sample Entry
+.SS "A Sample Entry"
.
The following entry, describing an ANSI-standard terminal, is representative
of what a \fBterminfo\fP entry for a modern terminal typically looks like.
@@ -135,7 +135,7 @@ or the size of particular delays, and
string
capabilities, which give a sequence which can be used to perform particular
terminal operations.
-.SS Types of Capabilities
+.SS "Types of Capabilities"
All capabilities have names.
For instance, the fact that
ANSI-standard terminals have
@@ -245,7 +245,7 @@ For example, see the second
in the example above.
.br
.ne 5
-.SS Fetching Compiled Descriptions
+.SS "Fetching Compiled Descriptions"
Terminal descriptions in \fI\%ncurses\fP are stored in terminal
databases.
These databases, which are found by their pathname,
@@ -306,7 +306,7 @@ it checks the \fI\%TERMCAP\fP and \fI\%TERMPATH\fP variables
(for content and search path,
respectively)
after the system terminal database.
-.SS Preparing Descriptions
+.SS "Preparing Descriptions"
We now outline how to prepare descriptions of terminals.
The most effective way to prepare a terminal description is by imitating
the description of a similar terminal in
@@ -327,7 +327,7 @@ delete 16 or so lines from the middle of the screen, then
hit the \*(``u\*(''
key several times quickly.
If the terminal messes up, more padding is usually needed.
A similar test can be used for insert character.
-.SS Basic Capabilities
+.SS "Basic Capabilities"
The number of columns on each line for the terminal is given by the
\fBcols\fP numeric capability.
If the terminal is a \s-1CRT\s0, then the
@@ -454,7 +454,7 @@ while the Lear Siegler \s-1ADM-3\s0 is described as
ind=\*^J, lines#24,\s+1
.\".in +2
.EE
-.SS Parameterized Strings
+.SS "Parameterized Strings"
Cursor addressing and other strings requiring parameters
in the terminal are described by a
parameterized string capability,
@@ -643,7 +643,7 @@ ASCII value for a space (32), adds them (pushing the sum on
the stack
in place of the two previous values) and outputs that value as a character.
Then the same is done for the second parameter.
More complex arithmetic is possible using the stack.
-.SS Cursor Motions
+.SS "Cursor Motions"
If the terminal has a fast way to home the cursor
(to very upper left corner of screen) then this can be given as
\fBhome\fP; similarly a fast way of getting to the lower left-hand corner
@@ -820,7 +820,7 @@ When setting margins, the line- and column-values are
zero-based.
The \fBmgc\fP string capability should be defined.
Applications such as \fBtabs\fP(1) rely upon this to reset all margins.
.\"
-.SS Area Clears
+.SS "Area Clears"
If the terminal can clear from the current position to the end of the
line, leaving the cursor where it is, this should be given as \fBel\fP.
If the terminal can clear from the beginning of the line to the current
@@ -834,7 +834,7 @@ if a true
.B ed
is not available.)
.\"
-.SS Insert/delete line and vertical motions
+.SS "Insert/Delete Line and Vertical Motions"
If the terminal can open a new blank line before the line where the cursor
is, this should be given as \fBil1\fP; this is done only from the first
position of a line.
@@ -911,7 +911,7 @@ below, then \fBdb\fP should be given.
These indicate
that deleting a line or scrolling may bring non-blank lines up from below
or that scrolling back with \fBri\fP may bring down non-blank lines.
-.SS Insert/Delete Character
+.SS "Insert/Delete Character"
There are two basic kinds of intelligent terminals with respect to
insert/delete character which can be described using
.I terminfo.
@@ -1188,7 +1188,7 @@ If a character overstriking another leaves both
characters on the screen,
specify the capability \fBos\fP.
If overstrikes are erasable with a blank,
then this should be indicated by giving \fBeo\fP.
-.SS Keypad and Function Keys
+.SS "Keypad and Function Keys"
If the terminal has a keypad that transmits codes when the keys are pressed,
this information can be given.
Note that it is not possible to handle
@@ -1295,7 +1295,7 @@ If there are commands to turn the labels on and off,
give them in \fBsmln\fP and \fBrmln\fP.
\fBsmln\fP is normally output after one or more pln
sequences to make sure that the change becomes visible.
-.SS Tabs and Initialization
+.SS "Tabs and Initialization"
A few capabilities are used only for tabs:
.bP
If the terminal has hardware tabs, the command to advance to the next
@@ -1479,7 +1479,7 @@ use the
\fBhts\fP (\fBset_tab\fP) capabilities directly
only when the \fBit\fP (\fBinit_tabs\fP) capability
is set to a value other than \fIeight\fP.
-.SS Delays and Padding
+.SS "Delays and Padding"
Many older and slower terminals do not support either XON/XOFF or DTR
handshaking, including hard copy terminals and some very archaic CRTs
(including, for example, DEC VT100s).
@@ -1507,7 +1507,7 @@ then this can be given as \fBpad\fP.
Only the first character of the
.B pad
string is used.
-.SS Status Lines
+.SS "Status Lines"
Some terminals have an extra \*(``status line\*('' which is not normally used
by
software (and thus not counted in the terminal's \fBlines\fP capability).
.PP
@@ -1542,7 +1542,7 @@ etc., work ordinarily in the status line.
The \fI\%ncurses\fP implementation does not yet use any of these
capabilities.
They are documented here in case they ever become important.
-.SS Line Graphics
+.SS "Line Graphics"
Many terminals have alternate character sets useful for forms-drawing.
Terminfo and \fBcurses\fP have built-in support
for most of the drawing characters
@@ -1617,7 +1617,7 @@ to a copy of this table for your terminal, giving the
character which
as the corresponding graphic.
Then read off the VT100/your terminal
character pairs right to left in sequence; these become the ACSC string.
-.SS Color Handling
+.SS "Color Handling"
The curses library functions \fBinit_pair\fP and \fBinit_color\fP
manipulate the \fIcolor pairs\fP and \fIcolor values\fP discussed in this
section
@@ -1892,7 +1892,7 @@ All text, including
is transparently passed to the printer while an
.B mc5p
is in effect.
-.SS Glitches and Braindamage
+.SS "Glitches and Brain Damage"
Hazeltine terminals,
which do not allow \*(``\*~\*('' characters to be displayed should
indicate \fBhz\fP.
@@ -1927,7 +1927,7 @@ Note that in older terminfo versions, this capability was
called
.PP
Other specific terminal problems may be corrected by adding more
capabilities of the form \fBx\fIx\fR.
-.SS Pitfalls of Long Entries
+.SS "Pitfalls of Long Entries"
Long terminfo entries are unlikely to be a problem; to date, no entry has even
approached terminfo's 4096-byte string-table maximum.
Unfortunately, the termcap
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 05/42] Style subsection headings consistently.,
G. Branden Robinson <=