groff-commit
[Top][All Lists]
Advanced

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

[groff] 07/18: [docs]: Eschew term "no-fill mode".


From: G. Branden Robinson
Subject: [groff] 07/18: [docs]: Eschew term "no-fill mode".
Date: Thu, 3 Jun 2021 11:03:21 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 7022c47564fd0bba544f0a148c18361065cc816e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Jun 3 16:21:18 2021 +1000

    [docs]: Eschew term "no-fill mode".
    
    It is awkward (even if impressively pedigreed--"nofill" without the
    hyphen, explained as "non-fill", dates back at least to the 1976 edition
    of CSTR #54).
    
    Say instead that "filling" is "enabled" or "disabled" as appropriate.
    
    * doc/groff.texi:
    * doc/meintro.me:
    * doc/meref.me:
    * doc/pic.ms:
    * man/groff.7.man:
    * man/roff.7.man:
    * src/roff/troff/troff.1.man:
    * tmac/groff_man.7.man.in:
    * tmac/groff_mdoc.7.man:
    * tmac/groff_me.7.man:
    Do it.
    
    I did not update uses of "{no-?,}fill mode" in change logs, TODOs, or
    code comments (except in groff_man*(7) which is already filthy with my
    handprints anyway), or in mom, which has a carefully curated lexicon and
    is well-maintained by Peter Schaffter.
    
    Also...
    
    * doc/groff.texi (Manipulating Filling and Adjustment): Add explicit
      notice of synonymy of "fill mode" with "filling of output lines" in
      description of `fi` request and concept index entries for those
      accustomed to the older terminology.
    
      (Line Control): Tighten discussion of `\c` escape by adding cross
      reference to the node above.
    
      (Warnings): Recast description of `break` warning category per the
      above and explicitly note the .l register.
    
    * man/groff.7.man (Requests/Request short reference) <fi, nf>: Sync with
      node "Manipulating Filling and Adjustment" from our Texinfo, adding
      notice of effect on .u register.
    
    * src/roff/troff/troff.1.man (Warnings) <break>: Sync with node
      "Warnings" from our Texinfo manual, noting relevance of .l register.
---
 doc/groff.texi             | 68 ++++++++++++++++++++++++----------------------
 doc/meintro.me             |  3 +-
 doc/meref.me               |  4 +--
 doc/pic.ms                 |  3 +-
 man/groff.7.man            | 21 ++++++++++++--
 man/roff.7.man             |  2 +-
 src/roff/troff/troff.1.man |  8 ++++--
 tmac/groff_man.7.man.in    |  4 +--
 tmac/groff_mdoc.7.man      |  2 +-
 tmac/groff_me.7.man        |  4 +--
 10 files changed, 71 insertions(+), 48 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index fac5519..5ab9476 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -424,7 +424,7 @@ developing GNU and promoting software freedom.''
 @title groff
 @subtitle The GNU implementation of @code{troff}
 @subtitle Edition 1.23.0
-@subtitle May 2021
+@subtitle June 2021
 @author by Trent A.@tie{}Fisher
 @author and Werner Lemberg
 
@@ -6983,32 +6983,36 @@ the @code{fi} request.
 
 @DefreqList {fi, }
 @DefregListEndx {.u}
-@cindex fill mode (@code{fi})
-@cindex mode, fill (@code{fi})
-Activate fill mode; a pending output line is broken.  The read-only
-register @code{.u} is set to@tie{}1.  The fill mode enablement status is
-associated with the environment (@pxref{Environments}).
-
-See @ref{Line Control}, for interaction with the @code{\c} escape.
+@cindex filling of output, enabling (@code{fi})
+@cindex output, filling, enablement of (@code{fi})
+@cindex fill mode (@code{fi}), enabling
+@cindex mode, fill (@code{fi}), enabling
+Enable filling of output lines; a pending output line is broken.  The
+read-only register @code{.u} is set to@tie{}1.  The filling enablement
+status, sometimes called @dfn{fill mode}, is associated with the
+environment (@pxref{Environments}).  See @ref{Line Control}, for
+interaction with the @code{\c} escape.
 @endDefreq
 
 @Defreq {nf, }
-@cindex no-fill mode (@code{nf})
-@cindex mode, no-fill (@code{nf})
-Activate no-fill mode: the output line length (@pxref{Line Layout}) is
-ignored and output lines are broken where the input lines are.  A
-pending output line is broken and adjustment is suppressed.  The
-register @code{.u} is set to@tie{}0.  The fill mode enablement status is
-associated with the environment (@pxref{Environments}).
-
-See @ref{Line Control}, for interaction with the @code{\c} escape.
+@cindex filling of output, disabling (@code{nf})
+@cindex output, filling, disablement of (@code{nf})
+@cindex no-fill mode
+@cindex mode, no-fill
+@cindex fill mode, disabling
+@cindex mode, fill, disabling
+Disable filling of output lines: the output line length (@pxref{Line
+Layout}) is ignored and output lines are broken where the input lines
+are.  A pending output line is broken and adjustment is suppressed.  The
+register @code{.u} is set to@tie{}0.  The filling enablement status is
+associated with the environment (@pxref{Environments}).  See @ref{Line
+Control}, for interaction with the @code{\c} escape.
 @endDefreq
 
 @DefreqList {ad, [@Var{mode}]}
 @DefregListEndx {.j}
 Set adjustment mode to @var{mode}, taking effect when the pending (or
-next) output line is broken.   Adjustment is suppressed in no-fill mode.
-
+next) output line is broken.   Adjustment is suppressed when filling is.
 @var{mode} can have one of the following values.
 
 @table @code
@@ -7226,7 +7230,7 @@ respectively.  These parameters are associated with the 
environment
 (@pxref{Environments}), and rounded down to the nearest multiple
 of@tie{}12 on terminal output devices.
 
-@cindex fill mode, and inter-sentence space
+@cindex filling, and inter-sentence space
 @cindex mode, fill, and inter-sentence space
 Additional inter-sentence spacing is used only if the output line is not
 full when the end of a sentence occurs in the input.  If a sentence ends
@@ -8979,16 +8983,16 @@ before @code{\c} on the same line is appended to the 
pending output
 line.  The next non-command line after an interrupted line counts as a
 new input line.
 
-The visual results depend on whether no-fill mode is active.
+The visual results depend on whether filling is enabled;
+@xref{Manipulating Filling and Adjustment}.
 
 @itemize @bullet
 @item
-@cindex @code{\c}, and fill mode
+@cindex @code{\c}, when filling enabled
 @cindex fill mode, and @code{\c}
 @cindex mode, fill, and @code{\c}
-If fill mode is active (using the @code{fi} request), a word interrupted
-with @code{\c} is continued with the text on the next input text line,
-without an intervening space.
+If filling is enabled, a word interrupted with @code{\c} is continued
+with the text on the next input text line, without an intervening space.
 
 @Example
 This is a te\c
@@ -8997,12 +9001,11 @@ st.
 @endExample
 
 @item
-@cindex @code{\c}, and no-fill mode
+@cindex @code{\c}, when filling disabled
 @cindex no-fill mode, and @code{\c}
 @cindex mode, no-fill, and @code{\c}
-If no-fill mode is active (using the @code{nf} request), the next input
-text line after @code{\c} is handled as a continuation of the same input
-text line.
+If filling is disabled, the next input text line after @code{\c} is
+handled as a continuation of the same input text line.
 
 @Example
 .nf
@@ -15322,10 +15325,11 @@ Invalid numeric expressions.  This is enabled by 
default.
 
 @item break
 @itemx 4
-@cindex fill mode, and @code{break} warnings
+@cindex filling, and @code{break} warnings
 @cindex mode, fill, and @code{break} warnings
-In fill mode, lines that could not be broken so that their length was
-less than the line length.  This is enabled by default.
+When filling is enabled, a line could not be broken such that its length
+was less than the output line length @samp{\n[.l]}.  This is enabled by
+default.
 
 @item delim
 @itemx 8
diff --git a/doc/meintro.me b/doc/meintro.me
index 3514492..31ec94f 100644
--- a/doc/meintro.me
+++ b/doc/meintro.me
@@ -766,8 +766,7 @@ Keeps and lists are normally collected in
 .i nofill
 mode,
 so that they are good for tables and such.
-If you want a display
-in fill mode
+If you want filling enabled in the display
 (for text),
 type
 .b ".(l\ F"
diff --git a/doc/meref.me b/doc/meref.me
index 73ea081..dcc06b9 100644
--- a/doc/meref.me
+++ b/doc/meref.me
@@ -1219,7 +1219,7 @@ if
 .i W
 is spread or broken (including hyphenated).
 In other words,
-it is safe in nofill mode only.
+it is safe only when filling is disabled.
 .TL
 .b .q
 .i W
@@ -1262,7 +1262,7 @@ if
 .i W
 is spread or broken (including hyphenated).
 In other words,
-it is safe in nofill mode only.
+it is safe only when filling is disabled.
 .TL
 .b .sm
 .i W
diff --git a/doc/pic.ms b/doc/pic.ms
index d47433b..aeda253 100644
--- a/doc/pic.ms
+++ b/doc/pic.ms
@@ -2212,7 +2212,8 @@ bugs, but point size and font changes are usually safe.
 Point sizes and font changes are also safe within text strings, as
 long as they are undone before the end of string.
 .PP
-The state of \fB[gt]roff\fP's fill mode is preserved across pictures.
+The enablement of output line filling by \fB[gt]roff\fP is preserved
+across pictures.
 .
 .NH 2
 PIC and EQN
diff --git a/man/groff.7.man b/man/groff.7.man
index 53ad31a..0b18246 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -1919,9 +1919,15 @@ Set fill color to previous fill color.
 Set fill color to
 .IR c .
 .
+.
 .TPx
 .REQ .fi
-Fill output lines.
+Enable filling of output lines;
+a pending output line is broken.
+.
+Sets
+.BR \[rs]n[.u] .
+.
 .
 .TPx
 .REQ .fl
@@ -2357,9 +2363,15 @@ Need
 vertical space (default scaling indicator\~\c
 .scaleindicator v ).
 .
+.
 .TPx
 .REQ .nf
-No filling or adjusting of output lines.
+Disable filling of output lines;
+a pending output line is broken.
+.
+Clears
+.BR \[rs]n[.u] .
+.
 .
 .TPx
 .REQ .nh
@@ -4812,9 +4824,12 @@ minus the amount of vertical motion produced by
 Useful in conjunction with the
 .register .ne .
 .
+.
 .TPx
 .REG .u
-Equal to 1 in fill mode and 0 in no-fill mode.
+Equal to 1 if filling is enabled,
+0 otherwise.
+.
 .
 .TPx
 .REG .U
diff --git a/man/roff.7.man b/man/roff.7.man
index 839e77f..0a9cb81 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -235,7 +235,7 @@ on
 .I RUNOFF
 you had to backspace and underscore in the input yourself).
 .B .fi
-to turn on fill mode got the name it retains to this day.
+to enable filling of output lines got the name it retains to this day.
 .
 .\" GBR can't find a source for this claim (of Bernd's).
 .\"Multics
diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man
index f607bdf..ab7abed 100644
--- a/src/roff/troff/troff.1.man
+++ b/src/roff/troff/troff.1.man
@@ -448,13 +448,17 @@ _
 .nr x \w'\fBright-brace'+1n+\w'00000'u
 .ta \nxuR
 .
+.
 .TP \nxu+3n
 .BR break "\t4"
-In fill mode, lines which could not be broken so that their length was
-less than the line length.
+When filling is enabled,
+a line could not be broken such that its length was less than the output
+line length
+.BR \[rs]n[.l] .
 .
 This is enabled by default.
 .
+.
 .TP
 .BR char "\t1"
 Non-existent characters.
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index b80d2b5..31452dc 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -2391,14 +2391,14 @@ the end of an input line is treated like a space;
 .\" end-of-sentence detection is performed, and...
 an output line
 .I may
-be broken there\" in fill mode
+be broken there\" if filling enabled
 (if not,
 an adjustable space is inserted)
 and
 .I will
 be broken there in
 .BR .EX / .EE
-examples.)\" i.e., no-fill mode
+examples.)\" i.e., when filling is disabled
 .
 Anything after
 .B \ec
diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index f090135..ab4eefa 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -4876,7 +4876,7 @@ needs to have a check to prevent splitting up the line if 
its length is
 too short.
 .
 Occasionally it separates the last parenthesis,
-and sometimes looks ridiculous if a line is in fill mode.
+and sometimes looks ridiculous if output lines are being filled.
 .
 .
 .Pp
diff --git a/tmac/groff_me.7.man b/tmac/groff_me.7.man
index eca6ed8..ca0fae7 100644
--- a/tmac/groff_me.7.man
+++ b/tmac/groff_me.7.man
@@ -326,7 +326,7 @@ Begin bulleted paragraph.
 T}
 \&.bx [\fIX\fP [\fIY\fP]]      \-      no      T{
 Print \fIX\fP in a box (with Y appended).
-Renders reliably only in no-fill mode.
+Renders reliably only if filling disabled.
 T}
 \&.ef \fIclcmcrc\fP    """"    no      T{
 Set even-numbered page footer.
@@ -419,7 +419,7 @@ Underline
 (appending
 .I Y
 without underlining).
-Renders reliably only in no-fill mode.
+Renders reliably only if filling disabled.
 T}
 \&.uh [\fIT\fP]        \-      yes     T{
 Start unnumbered section (and print title



reply via email to

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