gbranden pushed a commit to branch master
in repository groff.
commit 1718f4471af75bf0ff13d08d6147aa32b120a7a4
Author: G. Branden Robinson <[email protected]>
AuthorDate: Wed May 14 08:39:38 2025 -0500
doc/*,man/*: Clarify \k escape sequence behavior.
---
doc/groff.texi.in | 15 +++++++++++----
man/groff.7.man | 15 ++++++++++++---
man/groff_diff.7.man | 6 ++++--
3 files changed, 27 insertions(+), 9 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 31700dd38..43b3e5e60 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -14807,10 +14807,17 @@ over that glyph.
@cindex input line position, horizontal, saving (@code{\k})
@cindex position, horizontal input line, saving (@code{\k})
@cindex line, input, horizontal position, saving (@code{\k})
-Store the horizontal drawing position relative to that corresponding to
-the beginning of the input line in a register with the name
-@var{position} (one-character name@tie{}@var{p}, two-character name
-@var{ps}). Use this, for example, to move to the beginning of a word
+Store the horizontal drawing position,
+relative to that corresponding to the start of the input line
+(ignoring page offset and indentation),
+in a register with the name
+@var{position}
+(one-character name@tie{}@var{p},
+two-character name
+@var{ps}).
+Use this,
+for example,
+to later move to the beginning of a word
for highlighting or other decoration.
@endDefesc
diff --git a/man/groff.7.man b/man/groff.7.man
index 1d3f6b010..826bf4650 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -5621,18 +5621,27 @@ set the font height to the selected type size.
.
.TP
.ESC k r
-Mark horizontal position in one-character register
+Store the horizontal drawing position,
+relative to that corresponding to the start of the input line
+(ignoring page offset and indentation),
+in register
.RI name\~ r .
.
.TP
.ESC k( rg
-Mark horizontal position in two-character register
+Store the horizontal drawing position,
+relative to that corresponding to the start of the input line
+(ignoring page offset and indentation),
+in register
.RI name\~ rg .
.
.
.TP
.ESC[] k reg
-Mark horizontal position in register with arbitrarily long
+Store the horizontal drawing position,
+relative to that corresponding to the start of the input line
+(ignoring page offset and indentation),
+in register
.RI name\~ reg .
.
.
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 8fe3da545..46bab054b 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -936,8 +936,10 @@ request below.
.BI \[rs]k( rg
.TQ
.BI \[rs]k[ reg ]
-Mark horizontal drawing position in
-two-character register
+Store the horizontal drawing position,
+relative to that corresponding to the start of the input line
+(ignoring page offset and indentation),
+in two-character register
.RI name\~ rg
or arbitrary register
.RI name\~ reg .
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
