gbranden pushed a commit to branch master
in repository groff.
commit ab9e82cd9716d929051eedfb104d227a02c964e5
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Aug 10 00:03:13 2023 -0500
[man,mdoc]: Make base paragraph indent 5n (2/2).
* tmac/groff_man.7.man.in:
* tmac/groff_mdoc.7.man: Document it.
* NEWS: Add item.
---
ChangeLog | 3 +++
NEWS | 10 ++++++++++
tmac/groff_man.7.man.in | 31 +++++++++++++++++--------------
tmac/groff_mdoc.7.man | 11 +++++------
4 files changed, 35 insertions(+), 20 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 10e9f778a..0545a746f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -26,6 +26,9 @@
* tmac/tests/doc_synopsis_is_not_adjusted.sh: Update amount of
indentation expected in output.
+ * tmac/groff_man.7.man.in:
+ * tmac/groff_mdoc.7.man: Document it.
+
Fixes <https://savannah.gnu.org/bugs/?64018>. Thanks to
Thorsten Glaser and Ingo Schwarze for the discussion.
diff --git a/NEWS b/NEWS
index 398e2ec08..c067e1d22 100644
--- a/NEWS
+++ b/NEWS
@@ -49,6 +49,16 @@ o Hyperlink support is now enabled by default on non-HTML
devices that
Instructions and commented code for disabling it remain in the
"man.local" file.
+o The an (man) and doc (mdoc) macro packages now support a `BP` register
+ to configure the ("base") paragraph indentation amount; that is the
+ amount used by man(7) for paragraphs not within an `RS`/`RE` relative
+ inset, and in mdoc(7) for all paragraphs. Formerly, the `IN` register
+ configured this amount with other indentation and inset amount
+ parameters used by man(7). (In mdoc(7), it had no other purpose.)
+ The base paragraph indentation default is now 5n, corresponding to
+ that used by historical man(7) and mdoc(7) implementations going back
+ to Unix Version 7 and 4.3BSD-Reno, respectively.
+
o The an (man) and doc (mdoc) macro packages now support a `PO` register
to configure the page offset used by the formatter.
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index fe353a530..ad1ddf0ec 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -582,10 +582,8 @@ use of an italic style in
.I heading-text
is mapped to the bold-italic style if available in the font family.
.
-The inset level is reset to 1,
-setting the left margin to the value of the
-.B IN \" TODO: future: BP or BI register ("base paragraph indentation")
-register.
+The inset level is reset to 1;
+see subsection \(lqHorizontal and vertical spacing\(rq below.
.
Text after
.I heading-text
@@ -653,10 +651,8 @@ use of an italic style in
.I subheading-text
is mapped to the bold-italic style if available in the font family.
.
-The inset level is reset to 1,
-setting the left margin to the value of the
-.B IN \" TODO: future: BP or BI register ("base paragraph indentation")
-register.
+The inset level is reset to 1;
+see subsection \(lqHorizontal and vertical spacing\(rq below.
.
Text after
.I subheading-text
@@ -768,7 +764,7 @@ calls is\~1.
.IR level ]
End a relative inset.
.
-The left margin corresponding to inset level
+The inset amount corresponding to inset level
.I level
is restored.
.
@@ -3388,6 +3384,15 @@ for less-common choices.
.
.
.TP
+.BI \-rBP= base-paragraph-indentation
+Set the indentation amount for ordinary paragraphs not within an
+.BR .RS / .RE
+inset.
+.
+The default is 5n.
+.
+.
+.TP
.B \-rcR=1
Enable continuous rendering.
.
@@ -3494,10 +3499,7 @@ see section \[lq]Localization\[lq] of
.
.TP
.BI \-rIN= standard-indentation
-Set the amount of indentation used for ordinary paragraphs
-.RB ( .P
-and its synonyms)
-and the default indentation amount used by
+Set the default indentation amount used by
.BR .IP ,
.BR .RS ,
.BR .TP ,
@@ -4228,6 +4230,7 @@ implemented the
and
.B MF
strings;
+.BR BP , \" 1.24
.BR CS ,
.BR CT ,
and
@@ -4235,7 +4238,7 @@ and
registers;
and the
.B MR
-macro. \" all 1.23
+macro. \" all 1.23 except where noted
.
.
Except for
diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index a12c44a8e..db75b857b 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -5088,17 +5088,16 @@ register to zero.
.Pp
The paragraph and subsection heading indentation amounts can be changed
by setting the registers
-.Ql IN
+.Ql BP
and
.Ql SN .
.
-.Dl groff \-Tutf8 \-rIN=5n \-rSN=2n \-mdoc foo.man | less \-R
+.Dl groff \-Tutf8 \-rBP=4n \-rSN=2n \-mdoc foo.man | less \-R
.
-The default paragraph indentation is 7.2n on typesetters and 7n on
-terminals.
+The default paragraph and subsection heading indentation amounts are 5n
+and 3n, respectively.
.
-The default subsection heading indentation amount is 3n;
-section headings are set with an indentation of zero.
+Section headings are set with an indentation of zero.
.
.
.Pp
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
