[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 18/40: [docs]: Undocument SN string.
From: |
G. Branden Robinson |
Subject: |
[groff] 18/40: [docs]: Undocument SN string. |
Date: |
Wed, 10 Feb 2021 01:32:17 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 6db74e9f2076dbe0dbcff400cbb4a670c989cafd
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Feb 6 16:57:46 2021 +1100
[docs]: Undocument SN string.
The SN string is for compatibility with non-GNU ms documents only;
SN-STYLE has been preferred since its implementation in April 2007.
Undocument SN here; with the availablity of doc/ms.ms, I am planning to
make this man page a shorter, terser reference document. (In fact, it
was rewritten as a "port" of ms.ms to man(7) in January 2002.)
We can possibly resurrect documentation of things like SN and FL in a
"legacy compatibility" section later; such a thing would need to be
carefully organized since there are at least 5 dialects of non-GNU ms in
the world: V6 Unix, V7 Unix, V10 Unix, and Berkeley. The differences
matter--in V6, .FL is a request; in V7, it's a register. V10 also
implemented different macros for cover page material. I haven't even
looked hard at Heirloom, DWB, Solaris, or Plan 9 ms yet, though they
(like Berkeley and V10) are all ultimately descended from V7 ms.
* doc/groff.texi (Headings in ms): Undocument SN string and tighten
discussion of SN-STYLE, SN-DOT, and SN-NO-DOT.
* tmac/groff_ms.7.man (Usage/Headings): Undocument SN.
---
doc/groff.texi | 26 +++++---------------------
tmac/groff_ms.7.man | 26 --------------------------
2 files changed, 5 insertions(+), 47 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index ca54543..6c7ece4 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3147,35 +3147,19 @@ If you specify heading levels out of sequence, such as
invoking
on the standard error stream.
@endDefmac
-@DefstrList {SN, ms}
+@DefstrList {SN-STYLE, ms}
@DefstrItemx {SN-DOT, ms}
@DefstrListEndx {SN-NO-DOT, ms}
After invocation of @code{NH}, the assigned section number is made
available in the strings @code{SN-DOT} (as it appears in a printed
section heading with default formatting, followed by a terminating
period), and @code{SN-NO-DOT} (with the terminating period omitted).
-The string @code{SN} is also defined, as an alias for @code{SN-DOT}; if
-preferred, you may redefine it as an alias for @code{SN-NO-DOT}, by
-including the initialization
-@Example
-.als SN SN-NO-DOT
-@endExample
-
-@noindent
-at any time @emph{before} you would like the change to take effect.
-@endDefstr
-@Defstr {SN-STYLE, ms}
-You may control the style used to print section numbers, within numbered
-section headings, by defining an appropriate alias for the string
-@code{SN-STYLE}. The default style, in which the printed section number
-is followed by a terminating period, is obtained by defining the alias
+You may control the style used to print section numbers within numbered
+section headings by defining an appropriate alias for the string
+@code{SN-STYLE}. By default, @code{SN-STYLE} is aliased to
+@code{SN-DOT}.
-@Example
-.als SN-STYLE SN-DOT
-@endExample
-
-@noindent
If you prefer to omit the terminating period, from section numbers
appearing in numbered section headings, you may define the alias
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index dc44d48..57b15e9 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -662,32 +662,6 @@ and
.B SN\-NO\-DOT
(with this terminating period omitted).
.
-The string
-.B SN
-is also defined,
-as an alias for
-.BR SN\-DOT ;
-if preferred,
-the user may redefine it as an alias for
-.BR SN\-NO\-DOT ,
-'ne 10
-by including the initialisation:
-.
-.
-.RS
-.IP
-.EX
-\&.als SN SN\-NO\-DOT
-.EE
-.RE
-.
-.
-.IP
-at any time;
-the change becomes effective with the next use of
-.BR .NH ,
-.I after
-the new alias is defined.
.
.TP
.B .SH\c
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 18/40: [docs]: Undocument SN string.,
G. Branden Robinson <=