summaryrefslogtreecommitdiffstats
path: root/mandoc_char.7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2022-06-02 14:51:41 +0000
committerIngo Schwarze <schwarze@openbsd.org>2022-06-02 14:51:41 +0000
commit4de2134e6e8bcf00651ea443b38238baef53467e (patch)
tree7a1af3995f84340a9217359cb58cdcfd3ea1c529 /mandoc_char.7
parent3f1a8f780a3e6cd71d71a29bce66571cc2fad12e (diff)
downloadmandoc-4de2134e6e8bcf00651ea443b38238baef53467e.tar.gz
Since \. is not a character escape sequence, re-classify it from the
wrong parsing class ESCAPE_SPECIAL to the better-suited parsing class ESCAPE_UNDEF, exactly like it is already done for the similar \\, which isn't a character escape sequence either. No formatting change is intended just yet, but this will matter for upcoming improvements in the parser for roff(7) macro, string, and register names. See the node "5.23.2 Copy Mode" in "info groff" regarding what \\ and \. really mean.
Diffstat (limited to 'mandoc_char.7')
-rw-r--r--mandoc_char.719
1 files changed, 12 insertions, 7 deletions
diff --git a/mandoc_char.7 b/mandoc_char.7
index de1ef177..5aed14fb 100644
--- a/mandoc_char.7
+++ b/mandoc_char.7
@@ -1,8 +1,9 @@
-.\" $Id$
+.\" $Id$
.\"
.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2011,2013,2015,2017-2020 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2011, 2013, 2015, 2017-2020, 2022
+.\" Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -220,13 +221,18 @@ where it introduces a
request or a macro, and when appearing alone as a macro argument in
.Xr mdoc 7 .
In such situations, prepend a zero-width space
-.Pq Sq \e&.
+.Pq Sq \e&.\&
to make it behave like normal text.
.Pp
-Do not use the
+Do not use the character pair
.Sq \e.
-escape sequence.
-It does not prevent special handling of the period.
+to escape a period because
+.Sq \e.
+is not a character escape sequence, does not prevent special handling
+of the period under normal circumstances, and is only intended to
+be used in the very special situation of defining a user-defined
+macro that, when called, defines another user-defined macro, which
+no manual page is ever supposed to do.
.Ss Backslashes
To include a literal backslash
.Pq Sq \e
@@ -326,7 +332,6 @@ Punctuation:
.It \e(en Ta \(en Ta en-dash
.It \e(hy Ta \(hy Ta hyphen
.It \ee Ta \e Ta back-slash
-.It \e. Ta \. Ta period
.It \e(r! Ta \(r! Ta upside-down exclamation
.It \e(r? Ta \(r? Ta upside-down question
.El