groff-commit
[Top][All Lists]
Advanced

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

[groff] 06/11: doc/groff.texi: Update control character intro.


From: G. Branden Robinson
Subject: [groff] 06/11: doc/groff.texi: Update control character intro.
Date: Sat, 31 Jul 2021 10:36:29 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 85f966634687fc90c1d8a9daeadfa995727dc566
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Jul 31 12:00:40 2021 +1000

    doc/groff.texi: Update control character intro.
    
    * doc/groff.texi (Text): Be specific about which requests expect a
      control character; in the months since I wrote this, I haven't found
      any others.  Explicitly tell people how to lead a line with a control
      character used literally.
---
 doc/groff.texi | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index bbee575..2b3a1bd 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -4936,15 +4936,17 @@ languages, with an exception already noted several 
times in passing.
 @cindex no-break control character
 A @dfn{request} is an instruction to the formatter that occurs after a
 control character.  A @dfn{control character} must occur at the
-beginning of an input line to be recognized.@footnote{Occasionally a
-control character is expected as part of another request, such as
-@code{if} or @code{while}.}  The regular control character has a
-counterpart, the @dfn{no-break control character}, which suppresses the
-break that is implied by some requests.  The default control characters
-are the dot (@code{.}) and the neutral apostrophe (@code{'}), the latter
-being the no-break control character.  These characters were chosen
-because it is uncommon for lines of text in natural languages to begin
-with periods or apostrophes.
+beginning of an input line to be recognized.@footnote{A control
+character is also expected in arguments to the @code{if}, @code{ie},
+@code{el}, and @code{while} requests.}  The regular control character has a 
counterpart, the
+@dfn{no-break control character}, which suppresses the break that is
+implied by some requests.  The default control characters are the dot
+(@code{.}) and the neutral apostrophe (@code{'}), the latter being the
+no-break control character.  These characters were chosen because it is
+uncommon for lines of text in natural languages to begin with periods or
+apostrophes.  If you require a literal period or neutral
+apostrophe where GNU @code{troff} is expecting a control character,
+prefix it with the non-printing input break escape sequence, @samp{\&}.
 
 @cindex control line
 An input line beginning with a control character is called a



reply via email to

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