[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 10/33: [docs]: Standardize phraseology.
From: |
G. Branden Robinson |
Subject: |
[groff] 10/33: [docs]: Standardize phraseology. |
Date: |
Sun, 16 Oct 2022 15:52:17 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 7c613a28e41ca2ab9cfa7c3dffa29021b92af5b2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Oct 11 08:34:29 2022 -0500
[docs]: Standardize phraseology.
...when discussing requests that strip a leading " from their argument.
---
doc/groff.texi | 24 ++++++++++++------------
man/groff.7.man | 12 +++++-------
man/groff_diff.7.man | 17 +++++++----------
3 files changed, 24 insertions(+), 29 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index 349c32c40..2ac1377be 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -12062,10 +12062,8 @@ creeping into them during source document maintenance.
@cindex leading spaces with @code{ds}
@cindex spaces with @code{ds}
@cindex @code{ds} request, and leading spaces
-To store leading space in a string, start it with a double quote. A
-double quote is special only in that position; double quotes in any
-other location are included in the string (the effects of escape
-sequences notwithstanding).
+An initial neutral double quote is stripped to allow
+embedding of leading spaces.
@c Examples should be more accessible than Unix nerd stuff like this,
@c but in general document authors shouldn't want to use "straight"
@@ -15084,8 +15082,8 @@ at all; its argument is simply ignored.
@Defreq {output, string}
Emit @var{string} directly to GNU @code{troff}'s intermediate output
(subject to copy mode interpretation); this is similar to @code{\!} used
-at the top level. An initial double quote in @var{string} is stripped
-off to allow initial blanks.
+at the top level. An initial neutral double quote in @var{string} is
+stripped to allow embedding of leading spaces.
This request can't be used before the first page has started---if you
get an error, simply insert @code{.br} before the @code{output} request.
@@ -15726,8 +15724,9 @@ enable unsafe mode.
Write to the file associated with the specified @var{stream}. The
stream must previously have been the subject of an open request. The
remainder of the line is interpreted as the @code{ds} request reads its
-second argument: A leading @samp{"} is stripped, and it is read in
-copy mode.
+second argument: an initial neutral double quote is
+stripped to allow embedding of leading spaces, and it is read in copy
+mode.
The @code{writec} request is like @code{write}, but only @code{write}
appends a newline to the data.
@@ -15807,8 +15806,8 @@ other postprocessor.
@cindex copy mode, and @code{device} request
@cindex mode, copy, and @code{device} request
The @code{device} request processes its arguments in copy mode
-(@pxref{Copy Mode}). A leading @code{"} is stripped; this enables
-@var{xxx} to contain leading spaces.
+(@pxref{Copy Mode}). An initial neutral double quote
+is stripped to allow embedding of leading spaces.
@cindex @code{\&}, in @code{\X}
@cindex @code{\)}, in @code{\X}
@cindex @code{\%}, in @code{\X}
@@ -16253,8 +16252,9 @@ the standard error stream.
@var{string} is read in copy mode.
The @code{tm} request ignores leading spaces of @var{string}; @code{tm1}
-handles its argument similar to the @code{ds} request: a leading double
-quote in @var{string} is stripped to allow initial blanks.
+handles its argument similarly to the @code{ds} request: an
+initial neutral double quote is stripped to allow
+embedding of leading spaces.
The @code{tmc} request is similar to @code{tm1} but does not append a
newline (as is done in @code{tm} and @code{tm1}).
diff --git a/man/groff.7.man b/man/groff.7.man
index a443de5f4..199ce59f9 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -436,9 +436,8 @@ In the
and
.request .as1
requests,
-a leading double quote in the second argument is stripped off,
-enabling the inclusion of leading space characters in the string
-definition or appendment.
+an initial neutral double quote in the second argument is stripped off
+to allow embedding of leading spaces.
.
To include a double quote inside a quoted argument,
use the
@@ -3951,11 +3950,10 @@ on stderr.
.REQ .tm1 "anything"
Print
.I anything
-on stderr, allowing leading whitespace if
+on stderr,
+but an initial neutral double quote in
.I anything
-starts with
-\&\f[CB]\[dq]\f[]
-(which is stripped off).
+is stripped off to allow embedding of leading spaces.
.
.TPx
.REQ .tmc "anything"
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index a65fa4cf6..c93bbeba4 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -2029,12 +2029,9 @@ escape sequence.
.I anything
is read in copy mode.
.
-A
-.RB leading\~ \[dq]
-is stripped;
-this enables
+An initial neutral double quote in
.I anything
-to contain leading spaces.
+is stripped off to allow embedding of leading spaces.
.
.
.TP
@@ -2951,9 +2948,9 @@ this is similar to
.B \[rs]!\&
used at the top level.
.
-An initial double quote in
+An initial neutral double quote in
.I string
-is stripped off to allow initial blanks.
+is stripped off to allow embedding of leading spaces.
.
.
.TP
@@ -3409,10 +3406,10 @@ Similar to the
.B tm
request,
.I string
-is read in copy mode and written on the standard error, but an initial
-double quote in
+is read in copy mode and written on the standard error,
+but an initial neutral double quote in
.I string
-is stripped off to allow initial blanks.
+is stripped off to allow embedding of leading spaces.
.
.TP
.BI .tmc\~ string
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 10/33: [docs]: Standardize phraseology.,
G. Branden Robinson <=