groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 14/15: [docs]: Fix style nits.


From: G. Branden Robinson
Subject: [groff] 14/15: [docs]: Fix style nits.
Date: Tue, 20 Jul 2021 18:13:16 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit e9481f8e76802104fb0ea6e2ecc930f2d851b533
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Jul 21 06:52:33 2021 +1000

    [docs]: Fix style nits.
    
    * doc/groff.texi (Character Translations) <ecs, ecr>: Recast.
      (Font Families) <fam>: Note that default font family is determined by
      the output device.
      (Environments) <evc>: Recast bulleted list full of fragments as a
      real sentence.  Recast items in list of environment parameters not
      copied.
    
    * man/groff_diff.7.man: Sync with groff.texi changes.  Perform a Kemper
      notectomy.  Use U.S.-style first-order quotation marks.  Fix spelling
      error.  Use two empty requests where vertical space is expected.
      Delete copy-and-paste wastage.  Fix direction of internal cross
      reference.  Drop `ev` request from list of requests changed in GNU
      troff.  We elsewhere established recently (commit e50dbed9, 13 June)
      that the only real difference is that GNU troff accepts general
      identifiers for environment names.  The other points made here were
      not differences, or were consequences of more general changes already
      discussed (such as removal of arbitrary limits).
    
    Also:
    * Use Texinfo @code command to refer to register names, not @samp.
---
 doc/groff.texi       |  53 +++++++++++-----------
 man/groff_diff.7.man | 125 ++++++++++++++++++++++++++++++++++-----------------
 2 files changed, 111 insertions(+), 67 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 53966c4..8175568 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -8444,13 +8444,13 @@ it is executed literally.
 
 @DefreqList {ecs, }
 @DefreqListEndx {ecr, }
-The @code{ecs} request saves the current escape character in an internal
-register.  Use this request in combination with the @code{ec} request to
-temporarily change the escape character.
+The @code{ecs} request saves the current escape character.  Use this
+request in combination with the @code{ec} request to temporarily change
+the escape character.
 
 The @code{ecr} request restores the escape character saved with
-@code{ecs}.  Without a previous call to @code{ecs}, this request sets
-the escape character to @code{\}.
+@code{ecs}, or sets the escape character to @samp{\} if none has been
+saved.
 @endDefreq
 
 @DefescList {\\\\, , , }
@@ -9558,14 +9558,15 @@ different font family on the command line (@pxref{Groff 
Options}).
 @DefregListEndx {.fn}
 @cindex changing font family (@code{fam}, @code{\F})
 @cindex font family, changing (@code{fam}, @code{\F})
-Switch font family to @var{family} (one-character name@tie{}@var{f},
-two-character name @var{fm}).  If no argument is given, switch back to
-the previous font family.  Use @code{\F[]} to do this with the escape;
-@code{\FP} selects font family @samp{P} instead.
-
-The value at start-up is @samp{T}.  The current font family is available
-in the read-only string-valued register @samp{.fam}; it is associated
-with the environment (@pxref{Environments}).
+Set the font family to @var{family} (one-character name@tie{}@var{f},
+two-character name @var{fm}).  If no argument is given, switch to the
+previous font family, or the default family if there is none.  Use
+@samp{\F[]} to do this with an escape sequence; @samp{\FP} selects font
+family @samp{P} instead.  The initial font family is @samp{T} (Times),
+but can be overridden by the output device description file---@xref{DESC
+File Format}.  The current font family is available in the read-only
+string-valued register @code{.fam}; it is associated with the
+environment (@pxref{Environments}).
 
 @Example
 spam,
@@ -9589,7 +9590,7 @@ a single character as an argument) to change the font 
family on the fly.
 .mc \F[P]x\F[]
 @endExample
 
-The read-only string-valued register @samp{.fn} contains the current
+The read-only string-valued register @code{.fn} contains the current
 @dfn{real font name} of the current font.  If the current font is a
 style, the value of @code{\n[.fn]} is the proper concatenation of family
 and style name.
@@ -14091,36 +14092,38 @@ Here is an example:
 @endExample
 @endDefreq
 
-@Defreq {evc, env}
+@Defreq {evc, environment}
 @cindex copying environment (@code{evc})
 @cindex environment, copying (@code{evc})
-Copy the environment @var{env} into the current environment.
+Copy the contents of @var{environment} to the current environment.
 
 The following environment data are not copied:
 
 @itemize @bullet
 @item
-A partially collected line, if present.
+a partially collected line, if present;
 
 @item
-The status whether the previous line was interrupted.
+the interruption status of the previous input line (due to use of the
+@code{\c} escape sequence);
 
 @item
-The number of lines still to center, or to right-justify, or to
-underline (with or without underlined spaces); they are set to zero.
+the count of remaining lines to center, to right-justify, or to
+underline (with or without underlined spaces; these counts are set to
+zero);
 
 @item
-The status whether a temporary indentation is active.
+the activation status of temporary indentation;
 
 @item
-Input traps and their associated data.
+input traps and their associated data;
 
 @item
-Line numbering mode is disabled; it can be reactivated with @w{@samp{.nm
-+0}}.
+the activation status of line numbering (which can be reactivated with
+@w{@samp{.nm +0}}); and
 
 @item
-The number of consecutive hyphenated lines (set to zero).
+the count of consecutive hyphenated lines (set to zero).
 @end itemize
 @endDefreq
 
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 022a172..ef876a9 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -494,14 +494,18 @@ i.e., to return to the previous font.
 .BI \[rs]F[ fam ]
 Change font family.
 .
-This is the same as the
+See the
 .B .fam
-request.
+request below.
 .
 .B \[rs]F[]
-switches back to the previous font family (note that
+switches to the previous font family,
+or to the default family if there is none.
+.
 .B \[rs]FP
-won't work; it selects font family \[oq]P\[cq] instead).
+won't do this;
+it selects font family \[lq]P\[rq] instead.
+.
 .
 .TP
 .BI \[rs]k( rg
@@ -1108,7 +1112,7 @@ and
 .I Unformat
 the diversion
 .I div
-in a way such that Unicode basic Latin (ASCI) characters,
+in a way such that Unicode basic Latin (ASCII) characters,
 characters translated with the
 .B .trin
 request,
@@ -1925,13 +1929,13 @@ FOO groff FOO compatibility c1 \[ti]
 as output.
 .RE \" this "extra" RE avoids indentation of the remaining paragraphs
 .
+.
 .TP
 .BI .ds1\~ "name string"
 Similar to
 .BR .ds ,
 but compatibility mode is switched off when the string is later
 interpolated.
-but compatibility mode is switched off during expansion.
 .
 To be more precise,
 a \[lq]compatibility save\[rq] token is inserted at the beginning of the
@@ -1941,41 +1945,92 @@ and a \[lq]compatibility restore\[rq] token at the end.
 .
 .TP
 .B .ecr
-Restore escape character saved with
-.BR ecs .
-Without a previous call to
+Restore the escape character saved with
 .BR ecs ,
-.RB \[oq] \[rs] \[cq]
-will be the new escape character.
+or set escape character to
+.RB \[lq] \[rs] \[rq]
+if none has been saved.
 .
 .
 .TP
 .B .ecs
-Save current escape character.
+Save the current escape character.
 .
 .
 .TP
-.BI .evc\~ xx
-Copy the contents of environment
-.I xx
+.BI .evc\~ environment
+Copy the contents of
+.I environment
 to the current environment.
 .
-No pushing or popping of environments is done.
+.
+.IP
+The following environment data are not copied:
+.
+.
+.RS
+.IP \[bu]
+a partially collected line, if present;
+.
+.
+.IP \[bu]
+the interruption status of the previous input line
+(due to use of the
+.B \[rs]c
+escape sequence);
+.
+.
+.IP \[bu]
+the count of remaining lines to center,
+to right-justify,
+or to underline
+(with or without underlined spaces;
+all set to zero);
+.
+.
+.IP \[bu]
+the activation status of temporary indentation;
+.
+.
+.IP \[bu]
+input traps and their associated data;
+.
+.
+.IP \[bu]
+the activation status of line numbering
+(which can be reactivated with
+.RB \[lq] .nm\~+0 \[rq]);
+and
+.
+.
+.IP \[bu]
+the count of consecutive hyphenated lines
+(set to zero).
+.RE
+.
 .
 .TP
-.BI .fam\~ xx
-Set the current font family to
-.IR xx .
-The current font family is part of the current environment.
-If
-.I xx
-is missing, switch back to previous font family.
+.BR .fam\~ [\c
+.IR family ]
+Set the font family to
+.IR family .
 .
-The value at start-up is \[oq]T\[cq].
+If no argument is given,
+switch to the previous font family,
+or the default family if there is none.
+.
+Use
+.RB \[lq] \[rs]F[] \[rq]
+to do this with an escape sequence;
+.RB \[lq] \[rs]FP \[rq]
+selects font family \[lq]P\[rq] instead.
+.
+The initial font family is \[lq]T\[rq] (Times),
+but can be overridden by the output device\[em]see
+.IR groff_font (@MAN5EXT@)).
+.
+The current font family is associated with the environment.
 .
-See the description of the
-.B sty
-request for more information on font families.
 .
 .TP
 .BI .fchar\~ c\~string
@@ -2177,7 +2232,7 @@ or
 file;
 see the
 .B .hpf
-request above.
+request below.
 .
 .
 .IP
@@ -3513,20 +3568,6 @@ with compatibility mode switched on during execution.
 .
 .
 .TP
-.BI .ev\~ xx
-If
-.I xx
-is not a number, this switches to a named environment called
-.IR xx .
-The environment should be popped with a matching
-.B ev
-request without any arguments, just as for numbered environments.
-.
-There is no limit on the number of named environments; they are
-created the first time that they are referenced.
-.
-.
-.TP
 .BI .hy\~ n
 New values 16 and\~32 are available;
 the former enables hyphenation before the last character in a word,



reply via email to

[Prev in Thread] Current Thread [Next in Thread]