[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 20/21: groff(7), groff_diff(7): Fix content, style nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 20/21: groff(7), groff_diff(7): Fix content, style nits. |
Date: |
Fri, 28 Jul 2023 07:51:28 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 17bfeca73e2aa506a82634d19f0032a05fea5320
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Jul 28 05:59:20 2023 -0500
groff(7), groff_diff(7): Fix content, style nits.
groff(7):
* Fix missing comma.
* Drop duplicate explanation of glyph skew.
* Clarify meaning of `hp` register.
* Convert standard C library function reference into man page cross
reference.
* Note validity of tabs and spaces between double dots in macro
definition endings.
* Note that requests, and not just macros, can be used as "end macros".
* Italicize "end macro" as terminology instead of quoting it as a nonce
word would be.
* Protect ".return" from hyphenation.
* Add forward cross reference to "top-level diversion" definition.
* Fix subject/verb disagreement.
* Use correct escape sequence to prevent inter-sentence space
adjustment.
groff_diff(7):
* Note that GNU troff's handling of `\X` differs from AT&T's.
* Drop paragraphs about `\X` and "use_charnames_in_special" directive.
GNU troff no longer throws error diagnostics about special character
escape sequences inside `\X` parameters.
* Use active voice more.
* Clarify that compatibility mode applies only to those parts of a macro
or string that use the corresponding requests when invoked in
compatibility mode.
* Add description of `.nn` register.
---
man/groff.7.man | 38 ++++++++++++++++++++++++--------------
man/groff_diff.7.man | 37 +++++++++++++++----------------------
2 files changed, 39 insertions(+), 36 deletions(-)
diff --git a/man/groff.7.man b/man/groff.7.man
index fd9d4d2dd..3c6827dc1 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -5811,7 +5811,8 @@ The value of the increment is specified with a third
argument to the
.request .nr
request,
and a special interpolation syntax,
-.BI \[rs]n \[+-]
+.BI \[rs]n \[+-]\c
+,
is used to alter and then retrieve
the register's value.
.
@@ -5946,9 +5947,8 @@ see
.TP
.REG .csk
Skew of the last glyph formatted in the environment;
-.\" TODO: Give page a discussion of glyph properties and move this.
-skew is how far to the right of the center of a glyph the center of an
-accent over that glyph should be placed.
+see
+.register skw .
.
.TP
.REG .d
@@ -6424,7 +6424,8 @@ Count of hours elapsed since midnight (0\[en]23).
.
.TP
.REG hp
-Horizontal drawing position relative to start of input line.
+Horizontal drawing position relative to that at the start of the input
+line.
.
.TP
.REG llx
@@ -6542,8 +6543,8 @@ after rendering into dummy environment by
.TP
.REG systat
Return value of
-.I system()
-function; see
+.MR system 3 ;
+see
.request .sy .
.
.TP
@@ -6955,9 +6956,17 @@ the definition ends with the control line
.RB \[lq] .. \[rq]\&
(two dots).
.
+Tabs and spaces are permitted between the dots.
+.
Alternatively,
-a second argument names a macro whose call syntax ends the definition;
-this \[lq]end macro\[rq] is then called normally.
+a second argument to
+.B .de
+names a macro whose call
+(or request whose invocation)
+syntax ends the definition;
+this
+.I "end macro"
+is then interpreted normally.
.
Spaces or tabs are permitted after the first control character in the
line containing this ending token,
@@ -7001,7 +7010,7 @@ remove,
and rename a macro,
respectively.
.
-.B .return
+.B \%.return
stops the execution of a macro immediately,
returning to the enclosing context.
.
@@ -7358,7 +7367,8 @@ their positions are reported in basic units.
.
An
.I implicit page trap
-always exists in the top-level diversion;
+always exists in the top-level diversion
+(see below);
it works like a trap in some ways but not others.
.
Its purpose is to eject the current page and start the next one.
@@ -7462,7 +7472,7 @@ see section \[lq]Strings\[rq] above.
.B box
and
.B boxa
-works similarly,
+work similarly,
but ignore partially collected lines.
.
Call any of these macros again without an argument to end the diversion.
@@ -7490,9 +7500,9 @@ including the top level.
.
.P
The
-.B \[rs]!\%
+.B \[rs]!\&
and
-.B \[rs]?\%
+.B \[rs]?\&
escape sequences and
.B output
request escape from a diversion,
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index da35a3b78..4941e7211 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -622,7 +622,9 @@ escape sequences
.BR \[rs]s ,
.BR \[rs]$ ,
and
-.BR \[rs]* ).
+.BR \[rs]* ),
+and alters the behavior of
+.BR \[rs]X .
.
In the following list,
escape sequences are collated alphabetically at first,
@@ -1036,25 +1038,6 @@ character translations and definitions are ignored.
Other escape sequences are not supported.
.
.
-.IP
-If the
-.B \%use_charnames_in_special
-directive appears in the output device's
-.I DESC
-file,
-the use of special character escape sequences is
-.I not
-an error;
-they are simply output verbatim
-(with the exception of the seven mapped to Unicode basic Latin
-characters,
-discussed above).
-.
-.B \%use_charnames_in_special
-is currently employed only by
-.MR grohtml @MAN1EXT@ .
-.
-.
.TP
.BI \[rs]Y m
.TQ
@@ -1093,7 +1076,7 @@ Tabs and leaders in the argument are ignored with an
error diagnostic.
.
.TP
.B \[rs]#
-Everything up to and including the next newline is ignored.
+Ignore everything up to and including the next newline.
.
This escape sequence is interpreted even in copy mode.
.
@@ -4053,7 +4036,11 @@ and
respectively:
a \[lq]compatibility save\[rq] token is inserted at the beginning,
and a \[lq]compatibility restore\[rq] token at the end,
-with compatibility mode switched on during execution.
+with compatibility mode switched on during interpolation of the
+applicable macro definition,
+appendment,
+or string
+.I contents.
.
.
.TP
@@ -4369,6 +4356,12 @@ Interpolate\~1 if output line numbering is enabled
.
.
.TP
+.B \[rs]n[.nn]
+Interpolate count of output lines remaining to have numbering
+suppressed.
+.
+.
+.TP
.B \[rs]n[.ns]
Interpolate\~1 if no-space mode is enabled,
0\~otherwise.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 20/21: groff(7), groff_diff(7): Fix content, style nits.,
G. Branden Robinson <=