[groff] 33/39: doc/groff.texi: Lightly recast.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit b0819db0ab8665cbcc1d469307429613096f4681
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue May 31 16:04:06 2022 -0500

    doc/groff.texi: Lightly recast.
    
    * Refer to escape sequences as such, not as "commands".  We reserve that
      term for executable file objects and the instructions in
      device-independent intermediate output.
    * Update example of `eo` request usage to recast and more closely align
      with current code in "an.tmac".
    
    Also wrap a long input line.
---
 doc/groff.texi | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 0f596d9d..1f0fbd19 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -6368,13 +6368,13 @@ The first line is the @code{uh} macro being called with 
three arguments,
 @code{uh} macro with one argument, @samp{The Mouse Problem}.  The last
 solution, using escaped spaces, can be found in documents prepared for
 @acronym{AT&T} @code{troff}.  Nevertheless, it is not optimal in most
-situations, since @w{@samp{\ }} inserts a fixed-width, non-breaking space.
-GNU @code{troff} provides a different command @code{\~} to insert an
-adjustable, non-breaking space.@footnote{@code{\~} is also supported by
-Heirloom Doctools @code{troff} 050915 (September 2005), @code{neatroff}
-(since commit 1c6ab0f6e, 2016-09-13), and @code{mandoc} 1.14.5 (March
-2019) but not by Plan@tie{}9 @code{troff}, Solaris @code{troff}, or DWB
-@code{troff} or @code{onroff}.}
+situations, since @w{@samp{\ }} inserts a fixed-width, non-breaking
+space.  GNU @code{troff} provides the @code{\~} escape sequence to
+insert an adjustable, non-breaking space.@footnote{@code{\~} is also
+supported by Heirloom Doctools @code{troff} 050915 (September 2005),
+@code{neatroff} (since commit 1c6ab0f6e, 2016-09-13), and @code{mandoc}
+1.14.5 (March 2019) but not by Plan@tie{}9 @code{troff}, Solaris
+@code{troff}, or DWB @code{troff} or @code{onroff}.}
 @c as of this writing, 2022-03-21
 
 @cindex @code{"}, in a macro argument
@@ -6678,21 +6678,22 @@ an exact description of those escape sequences.
 Disable the escape mechanism completely.  After executing this request,
 the backslash character @samp{\} no longer starts an escape sequence.
 
-This request can be very helpful in writing macros since it is not
-necessary then to double the escape character.  Here is an example:
+This request can be helpful in writing macros since it obviates the
+need to double the escape character.
 
 @Example
-.\" This is a simplified version of the
-.\" .BR request from the man macro package
+.\" This is a simplified version of the `BR` macro from
+.\" the man(7) macro package.
 .eo
 .de BR
 .  ds result \&
 .  while (\n[.$] >= 2) \@{\
-.    as result \fB\$1\fR\$2
+.    as result \fB\$1\fR\$2\"
 .    shift 2
 .  \@}
-.  if \n[.$] .as result \fB\$1
+.  if \n[.$] .as result \fB\$1\"
 \*[result]
+.  rm result
 .  ft R
 ..
 .ec