gbranden pushed a commit to branch master
in repository groff.
commit 214c6d32805d35976d2e7b4feb5753d107932c8b
Author: G. Branden Robinson <[email protected]>
AuthorDate: Tue Sep 3 05:47:10 2024 -0500
[man]: Wordsmith read-only register definitions.
In many cases, applicability of register values to the environment was
omitted.
---
man/groff.7.man | 83 +++++++++++++++++++++++++++++-----------------------
man/groff_diff.7.man | 81 +++++++++++++++++++++++++++-----------------------
2 files changed, 92 insertions(+), 72 deletions(-)
diff --git a/man/groff.7.man b/man/groff.7.man
index 03bd6dfb7..8c1163bef 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -6221,8 +6221,8 @@ see
.
.TP
.REG .br
-The normal control character was used to call the currently interpolated
-macro (Boolean-valued).
+The normal control character was used to call the macro being
+interpreted (Boolean-valued).
.
.TP
.REG .c
@@ -6234,7 +6234,9 @@ and
.
.TP
.REG .C
-Compatibility mode is enabled (Boolean-valued);
+AT&T
+.I troff \" AT&T
+compatibility mode is enabled (Boolean-valued);
see
.request .cp .
.
@@ -6251,7 +6253,7 @@ positive if glyph extends below the baseline.
.
.TP
.REG .ce
-Count of output lines remaining to be centered.
+Count of output lines remaining to be centered in the environment.
.
.TP
.REG .cht
@@ -6301,11 +6303,11 @@ see
.
.TP
.REG .fam
-Name of default font family (string-valued).
+Name of the environment's default font family (string-valued).
.
.TP
.REG .fn
-Resolved name of selected font (string-valued);
+Resolved name of font selected in the environment(string-valued);
see
.request .ft
and
@@ -6331,7 +6333,7 @@ Horizontal motion quantum of output device in basic units.
.
.TP
.REG .height
-Font height;
+Height of the environment's selected font;
see
.esc H .
.
@@ -6366,29 +6368,32 @@ Hyphenation space adjustment threshold in environment.
.
.TP
.REG .i
-Indentation amount;
+Environment's indentation amount;
see
.request .in .
.
.TP
.REG .in
-Indentation amount applicable to the pending output line;
+Indentation amount applicable to the output line pending
+in the environment;
see
.request .ti .
.
.TP
.REG .int
-Previous output line was \[lq]interrupted\[rq] or continued with
+The text most recently formatted in the environment
+was \[lq]interrupted\[rq] or continued with
.esc c
(Boolean-valued).
.
.TP
.REG .it
-The count of lines remaining in the pending input trap.
+The count of lines remaining in the environment's pending input trap.
.
.TP
.REG .itc
-The pending input trap honors output line continuation with
+The environment's pending input trap honors output line continuation
+with
.esc c
(Boolean-valued).
.
@@ -6399,7 +6404,7 @@ Name of the macro associated with the pending input trap
.
.TP
.REG .j
-Adjustment mode encoded as an integer;
+The environment's adjustment mode encoded as an integer;
see
.request .ad
and
@@ -6409,7 +6414,7 @@ Do not interpret or perform arithmetic on its value.
.
.TP
.REG .k
-Horizontal drawing position relative to indentation.
+The environment's horizontal drawing position relative to indentation.
.
.TP
.REG .kern
@@ -6433,15 +6438,15 @@ Ligature mode.
.
.TP
.REG .linetabs
-Line-tabs mode is enabled (Boolean-valued).
+Line-tabs mode is enabled in the environment (Boolean-valued).
.
.TP
.REG .ll
-Line length applicable to the pending output line.
+Line length applicable to the environment's pending output line.
.
.TP
.REG .lt
-Title length.
+Environment's title line length.
.
.TP
.REG .m
@@ -6479,11 +6484,12 @@ also see
.
.TP
.REG .nm
-Output line numbering is enabled (Boolean-valued).
+Output line numbering is enabled in the environment (Boolean-valued).
.
.TP
.REG .nn
-Count of output lines remaining to have numbering suppressed.
+Count of output lines remaining in the environment
+to have numbering suppressed.
.
.TP
.REG .ns
@@ -6525,11 +6531,11 @@ Number of the next page.
.
.TP
.REG .ps
-Type size in scaled points.
+The environment's type size in scaled points.
.
.TP
.REG .psr
-Most recently requested type size in scaled points;
+The environment's most recently requested type size in scaled points;
see
.request .ps
and
@@ -6537,7 +6543,7 @@ and
.
.TP
.REG .pvs
-Post-vertical line spacing.
+The environment's post-vertical line spacing.
.
.TP
.REG .R
@@ -6546,11 +6552,12 @@ Maximum representable integer in GNU
.
.TP
.REG .rj
-Count of lines remaining to be right-aligned.
+Count of lines remaining to be right-aligned in the environment.
.
.TP
.REG .s
-Type size in points as a decimal fraction (string-valued);
+The environment's type size in points as a decimal fraction
+(string-valued);
see
.request .ps
and
@@ -6558,13 +6565,14 @@ and
.
.TP
.REG .slant
-Slant of font in degrees;
+Slant in degrees of the environment's selected font;
see
.esc S .
.
.TP
.REG .sr
-Most recently requested type size in points as a decimal fraction
+The environment's most recently requested type size
+in points as a decimal fraction
(string-valued);
see
.request .ps
@@ -6573,17 +6581,17 @@ and
.
.TP
.REG .ss
-Size of minimum inter-word space in twelfths of the space width of the
-selected font.
+Size of the environment's minimum inter-word space
+in twelfths of the space width of the selected font.
.
.TP
.REG .sss
-Size of additional inter-sentence space in twelfths of the space width
-of the selected font.
+Size of the environment's additional inter-sentence space
+in twelfths of the space width of the selected font.
.
.TP
.REG .sty
-Selected abstract style (string-valued);
+The environment's selected abstract style (string-valued);
see
.request .ft
and
@@ -6618,13 +6626,16 @@ option.
.
.TP
.REG .tabs
-Representation of tab settings suitable for use as argument to
+The environment's tab stop settings
+(if any)
+suitable for use as argument to
.request .ta
(string-valued).
.
.TP
.REG .trap
-Name of the next vertical position trap that will be sprung
+Name of the next vertical position trap
+after the vertical drawing position.
(string-valued);
see
.request .wh ,
@@ -6646,7 +6657,7 @@ also see
.
.TP
.REG .u
-Filling is enabled (Boolean-valued);
+Filling is enabled in the environment (Boolean-valued);
see
.request .fi
and
@@ -6662,7 +6673,7 @@ option.
.
.TP
.REG .v
-Vertical line spacing;
+The environment's vertical line spacing;
see
.request .vs .
.
@@ -6708,7 +6719,7 @@ Empty if output is directed to the top-level diversion.
.
.TP
.REG .zoom
-Zoom multiplier of current font
+Magnification of the environment's selected font
(in thousandths;
zero if no magnification);
see
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 0fea158e5..2558e96bb 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -4174,7 +4174,7 @@ Their names often correspond to the requests that affect
them.
.
.TP 13n \" "\n[.height]" + 2n
.B \[rs]n[.br]
-Within a macro call,
+Within a macro definition,
interpolate\~1
if the macro is called with the \[lq]normal\[rq] control character
(\[lq].\[rq] by default),
@@ -4187,7 +4187,9 @@ Using this register outside of a macro definition makes
no sense.
.
.TP
.B \[rs]n[.C]
-Interpolate 1\~if compatibility mode is in effect,
+Interpolate 1\~if AT&T
+.I troff \" AT&T
+compatibility mode is in effect,
0\~otherwise.
.
See
@@ -4203,7 +4205,8 @@ It is positive if the glyph extends below the baseline.
.
.TP
.B \[rs]n[.ce]
-Interpolate number of input lines remaining to be centered.
+Interpolate number of input lines remaining to be centered
+in the environment.
.
.
.TP
@@ -4215,7 +4218,7 @@ It is positive if the glyph extends above the baseline.
.
.TP
.B \[rs]n[.color]
-Interpolate 1\~if colors are enabled,
+Interpolate 1\~if color output is enabled,
0\~otherwise.
.
.
@@ -4249,14 +4252,14 @@ This is a string-valued register.
.
.TP
.B \[rs]n[.fam]
-Interpolate name of default font family.
+Interpolate name of the environment's default font family.
.
This is a string-valued register.
.
.
.TP
.B \[rs]n[.fn]
-Interpolate resolved name of the selected font.
+Interpolate resolved name of the font selected in the environment.
.
This is a string-valued register.
.
@@ -4281,7 +4284,7 @@ is the formatter.
.
.TP
.B \[rs]n[.height]
-Interpolate font height.
+Interpolate height of the environment's selected font.
.
See
.BR \[rs]H .
@@ -4328,34 +4331,36 @@ Interpolate hyphenation space adjustment threshold of
the environment.
.
.TP
.B \[rs]n[.in]
-Interpolate indentation amount applicable to the pending output line.
+Interpolate indentation amount applicable to the output line pending
+in the environment.
.
.
.TP
.B \[rs]n[.int]
-Interpolate\~1 if the most recently formatted text was interrupted
-(ended with
+Interpolate\~1 if the text most recently formatted in the environment
+was \[lq]interrupted\[rq] or continued with
.BR \[rs]c ),
0\~otherwise.
.
.
.TP
.B \[rs]n[.it]
-Interpolate the count of lines remaining in any pending input trap.
+Interpolate the count of lines remaining in the environment's
+pending input trap.
.
.
.TP
.B \[rs]n[.itc]
-Interpolate\~1 if the pending input trap honors the output line
-continuation escape sequence
+Interpolate\~1 if the environment's pending input trap honors
+the output line continuation escape sequence
.RB ( \[rs]c ),
0\~otherwise.
.
.
.TP
.B \[rs]n[.itm]
-Interpolate the name of the macro associated with the pending input
-trap.
+Interpolate the name of the macro associated with the environment's
+pending input trap.
.
This is a string-valued register.
.
@@ -4373,18 +4378,19 @@ Interpolate ligature mode.
.
.TP
.B \[rs]n[.linetabs]
-Interpolate\~1 if line-tabs mode is enabled,
+Interpolate\~1 if line-tabs mode is enabled the environment,
0\~otherwise.
.
.
.TP
.B \[rs]n[.ll]
-Interpolate line length applicable to the pending output line.
+Interpolate line length applicable to the environment's
+pending output line.
.
.
.TP
.B \[rs]n[.lt]
-Interpolate title line length.
+Interpolate the environment's title line length.
.
.
.TP
@@ -4413,15 +4419,15 @@ See
.
.TP
.B \[rs]n[.nm]
-Interpolate\~1 if output line numbering is enabled
+Interpolate\~1 if output line numbering is enabled in the environment
(even if temporarily suppressed),
0\~otherwise.
.
.
.TP
.B \[rs]n[.nn]
-Interpolate count of output lines remaining to have numbering
-suppressed.
+Interpolate count of output lines remaining in the environment
+to have numbering suppressed.
.
.
.TP
@@ -4464,27 +4470,29 @@ or that of the current page plus\~1).
.
.TP
.B \[rs]n[.ps]
-Interpolate type size in scaled points.
+Interpolate the environment's type size in scaled points.
.
.
.TP
.B \[rs]n[.psr]
-Interpolate most recently requested type size in scaled points.
+Interpolate the environment's most recently requested type size
+in scaled points.
.
.
.TP
.B \[rs]n[.pvs]
-Interpolate post-vertical line spacing amount.
+Interpolate the environment's post-vertical line spacing amount.
.
.
.TP
.B \[rs]n[.rj]
-Interpolate number of input lines remaining to be right-aligned.
+Interpolate number of input lines remaining to be right-aligned
+in the environment.
.
.
.TP
.B \[rs]n[.slant]
-Interpolate font slant.
+Interpolate slant in degrees of the environment's selected font.
.
See
.BR \[rs]S .
@@ -4492,8 +4500,8 @@ See
.
.TP
.B \[rs]n[.sr]
-Interpolate most recently requested type size in points as a decimal
-fraction.
+Interpolate the environment's most recently requested type size
+in points as a decimal fraction.
.
This is a string-valued register.
.
@@ -4502,15 +4510,15 @@ This is a string-valued register.
.B \[rs]n[.ss]
.TQ
.B \[rs]n[.sss]
-Interpolate values of minimum inter-word space and additional
-inter-sentence space,
+Interpolate values of the environment's minimum inter-word space
+and additional inter-sentence space,
respectively,
in twelfths of the space width of the selected font.
.
.
.TP
.B \[rs]n[.sty]
-Interpolate selected abstract font style,
+Interpolate the environment's selected abstract font style,
if any.
.
This is a string-valued register.
@@ -4518,8 +4526,9 @@ This is a string-valued register.
.
.TP
.B \[rs]n[.tabs]
-Interpolate representation of the tab stop settings in a form suitable
-for passage to the
+Interpolate the environment's tab stop settings
+(if any)
+in a form suitable for passage to the
.B ta
request.
.
@@ -4528,8 +4537,8 @@ This is a string-valued register.
.
.TP
.B \[rs]n[.trap]
-Interpolate the name of the next vertical position trap that will be
-sprung.
+Interpolate the name of the next vertical position trap
+after the vertical drawing position.
.
This is a string-valued register.
.
@@ -4624,7 +4633,7 @@ contains\~0.
.
.TP
.B \[rs]n[.zoom]
-Interpolate magnification of font,
+Interpolate magnification of the environment's selected font,
in thousandths,
or\~0 if magnification unused.
.
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit