Commit: runtime(doc): Fix erroneous *roff syntax examples

0 views
Skip to first unread message

Christian Brabandt

unread,
Jan 25, 2026, 11:01:27 AM (16 hours ago) Jan 25
to vim...@googlegroups.com
runtime(doc): Fix erroneous *roff syntax examples

Commit: https://github.com/vim/vim/commit/e914ada32334af67604c9791aa4149a74ab0d1eb
Author: G. Branden Robinson <g.branden...@gmail.com>
Date: Sun Jan 25 15:55:20 2026 +0000

runtime(doc): Fix erroneous *roff syntax examples

Problem dates back at least to commit 071d4279d6, Vim 7.0001 (2004).

The examples shown were of special character interpolation syntax, not
("number") register interpolation syntax.

Sources:
* https://www.gnu.org/software/groff/manual/groff.html.node/Built_002din-Registers.html
* https://github.com/mamccollum/troff-resources/blob/main/cstr-54.pdf

closes: #19243

Signed-off-by: G. Branden Robinson <g.branden...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index 9b0f34c3e..501dd9457 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -1,4 +1,4 @@
-*syntax.txt* For Vim version 9.1. Last change: 2026 Jan 23
+*syntax.txt* For Vim version 9.1. Last change: 2026 Jan 25


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -2712,10 +2712,10 @@ package, arrange for files to be recognized as groff input (see
GNU troff differs from older AT&T n/troff programs (that you may still find in
Solaris or Plan 9) by extending the *roff language syntax. For example, in
AT&T troff, you access the count of years since 1900 with the escape sequence
-\(yr. In groff you can do the same, which it recognizes for compatibility, or
-use groff's extended syntax, \[yr]. AT&T troff documented the yr register as
-storing the "last two digits of current year", but had a Y2K problem; in
-groff, you can access the Gregorian year correctly: \[year]. In groff, font,
+
(yr. In groff you can do the same, which it recognizes for compatibility,
+or use groff's extended syntax,
[yr]. AT&T troff documented the yr register
+as storing the "last two digits of current year", but had a Y2K problem; in
+groff, you can access the Gregorian year correctly:
[year]. In groff, font,
register, macro, string, and request names can exceed two characters; for
example, with groff's mm package, the control lines ".VERBON" and ".VERBOFF"
call macros of those names to bracket displays of "verbatim" content.
Reply all
Reply to author
Forward
0 new messages