summaryrefslogtreecommitdiff
path: root/PROBLEMS
diff options
context:
space:
mode:
authorG. Branden Robinson <g.branden.robinson@gmail.com>2022-10-18 16:40:15 -0500
committerG. Branden Robinson <g.branden.robinson@gmail.com>2022-10-21 21:02:54 -0500
commitff137021cbfb678cba95417e1160e46305824905 (patch)
tree70c9d26a2fe40204f34f1f267f11ac6d0bcef551 /PROBLEMS
parent0a4faa8ec67fa236f2e9a6642e7bd59b81e32774 (diff)
downloadgroff-git-ff137021cbfb678cba95417e1160e46305824905.tar.gz
Document a CSTR #54 erratum re: \n(st and \n(sb.
* doc/groff.texi (Page Motions): * man/groff.7.man (Writable registers): * man/groff_diff.7.man (New registers): Do it. * PROBLEMS: Further clarify. Note DWB and Heirloom behavior.
Diffstat (limited to 'PROBLEMS')
-rw-r--r--PROBLEMS20
1 files changed, 15 insertions, 5 deletions
diff --git a/PROBLEMS b/PROBLEMS
index 13ce8be7e..697c3c486 100644
--- a/PROBLEMS
+++ b/PROBLEMS
@@ -229,11 +229,21 @@ You need version 1.42 or newer.
them to the height and depth of its argument, but the registers
always seem to be 0.
-\n(st and \n(sb aren't supposed to give the height and depth of the
-string rather they give the minimum and maximum vertical displacement
-of the baseline. For example for \v'2u'\v'-3u', \n(st is 1 and \n(sb
-is -2. The height and depth of the string is available in the \n[rst]
-and \n[rsb] registers: these are groff extensions.
+\n(st and \n(sb don't give the height and depth of the argument to \w,
+but the maximum vertical displacements of the text baseline above
+(\n(st) and below (\n(sb) its original position. Consider an example
+where no text is formatted, but small vertical motions are used.
+
+ \w"\v'-1u'\v'3u'"
+ .tm st=\n(st, sb=\n(sb
+ st=1, sb=-2
+
+Observe that the sign convention of these registers is opposite that of
+relative vertical motion. (This is how Documenter's Workbench troff
+and Heirloom Doctools troff work as well.)
+
+The height and depth of formatted text in the \w argument are available
+in the \n[rst] and \n[rsb] registers; these are groff extensions.
----------------------------------------------------------------------