groff-commit
[Top][All Lists]
Advanced

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

[groff] 01/03: Recast description of .blm request.


From: G. Branden Robinson
Subject: [groff] 01/03: Recast description of .blm request.
Date: Tue, 19 May 2020 08:57:34 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit bacd1f98fd4bc6806e67022db5f7727ca1ddcc08
Author: G. Branden Robinson <address@hidden>
AuthorDate: Tue May 19 07:26:35 2020 +1000

    Recast description of .blm request.
    
    * doc/groff.texi: Include phrase "blank line macro" to make obvious the
      mnemonic for the request name.  Add cross-reference to node "Implicit
      Line Breaks" for explanation of default blank-line behavior.  Note
      what happens when no argument is given.
    
    * man/groff.7.man: Add mention of blank line macro as a "trap" for
      consistency with Texinfo manual terminology.  Explicitly indicate that
      default blank-line handling is restored when no argument is given.
    
    * man/groff_diff.7.man: Parallelize language with Texinfo manual.
---
 doc/groff.texi       |  9 ++++++---
 man/groff.7.man      |  8 +++++---
 man/groff_diff.7.man | 20 +++++++++++++++-----
 3 files changed, 26 insertions(+), 11 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 145ea0f..6be012d 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -12365,10 +12365,13 @@ of already processed lines.
 @cindex blank line traps
 @cindex traps, blank line
 
-@Defreq {blm, macro}
+@Defreq {blm, [@Var{macro}]}
 @cindex blank line macro (@code{blm})
-Set a blank line trap.  @code{gtroff} executes @var{macro} when it
-encounters a blank line in the input file.
+Set a blank line trap.  If a blank line macro is thus defined, GNU
+@code{troff} executes @var{macro} when a blank line is encountered in
+the input file, instead of the usual behavior (@pxref{Implicit Line
+Breaks}).  If no argument is supplied, the default blank line behavior
+is (re-)asserted.
 @endDefreq
 
 @c ---------------------------------------------------------------------
diff --git a/man/groff.7.man b/man/groff.7.man
index f71598e..ede3a76 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -1292,11 +1292,13 @@ when current font is
 .
 .TPx
 .REQ .blm
-Unset the blank line macro.
+Unset blank line macro (trap).
+.
+Restore default handling of blank lines.
 .
 .TPx
-.REQ .blm "macro"
-Set the blank line macro to
+.REQ .blm macro
+Set blank line trap to
 .IR macro .
 .
 .TPx
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index a85ccf6..690d2b2 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -908,12 +908,22 @@ Also see the
 option of
 .IR groff (@MAN1EXT@).
 .
+.
 .TP
-.BI .blm\~ xx
-Set the blank line macro to
-.IR xx .
-If there is a blank line macro, it is invoked when a blank line
-is encountered instead of the usual troff behaviour.
+.BR .blm\~ [\c
+.IR macro ]
+Set a blank line trap.
+.
+If a blank line macro is thus defined,
+.I groff
+executes
+.I macro
+when a blank line is encountered in the input file,
+instead of the usual behavior.
+.
+If no argument is supplied,
+the default blank line behavior is (re-)asserted.
+.
 .
 .TP
 .BI .box\~ xx



reply via email to

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