[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 04/49: doc/groff.texi: Recast presentation of `\x`.
From: |
G. Branden Robinson |
Subject: |
[groff] 04/49: doc/groff.texi: Recast presentation of `\x`. |
Date: |
Sun, 25 Sep 2022 17:02:54 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 605f5bc17e12ce3b1e09d1453aa599204a8875cc
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Sep 18 11:52:02 2022 -0500
doc/groff.texi: Recast presentation of `\x`.
* Migrate terminology: "scaling indicator" -> "scaling unit".
* Tighten wording.
---
doc/groff.texi | 23 +++++++++++------------
1 file changed, 11 insertions(+), 12 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index 1f2ed359e..1f37a56e2 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -8675,23 +8675,22 @@ alternatives to @code{ls}.
@DefescList {\\x, @code{'}, spacing, @code{'}}
@DefregListEndx {.a}
-Sometimes, extra vertical spacing is only needed occasionally, e.g., to
-allow space for a tall construct (like an equation). The @code{\x}
-escape does this. The escape is given a numerical argument, usually
-enclosed in quotes (like @samp{\x'3p'}); the default scaling indicator
-is @samp{v}. If this number is positive extra vertical space is
-inserted below the current line. A negative number adds space above.
-If this escape is used multiple times on the same line, the maximum of
-the values is used.
-
-@xref{Escape Sequences}, for details on parameter delimiting characters.
+Sometimes, extra vertical spacing is needed only occasionally, for
+instance to allow room for a tall construct like an inline equation.
+The @code{\x} escape sequence takes a delimited measurement (like
+@samp{\x'3p'}); the default scaling unit is @samp{v}. If the
+measurement is positive, extra vertical space is inserted below the
+current line; a negative measurement adds space above. If @code{\x} is
+used multiple times on the same output line, the maxima of the positive
+and negative adjustments are used. @xref{Escape Sequences}, for
+more on delimiters.
@cindex extra post-vertical line space register (@code{.a})
The @code{.a} read-only register contains the most recent (non-negative)
extra vertical line space.
-Using @code{\x} can be necessary in combination with the @code{\b}
-escape, as the following example shows.
+Use of @code{\x} can be necessary in combination with the @code{\b}
+escape sequence, as the following example shows.
@Example
This is a test of \[rs]b.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 04/49: doc/groff.texi: Recast presentation of `\x`.,
G. Branden Robinson <=