summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2021-01-05 20:35:25 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2021-01-05 20:35:25 (GMT)
commit124e36102e8b08023fe370defa49f89705d61a13 (patch)
treedee766451814776c9dd0a6744ee33c975d500006
parent3b7c040233cbbfe0f1e1187325365597fed23d8d (diff)
parentfb6da59e2f75fde712df8d3936b702d2e4a85343 (diff)
downloadtcl-124e36102e8b08023fe370defa49f89705d61a13.zip
tcl-124e36102e8b08023fe370defa49f89705d61a13.tar.gz
tcl-124e36102e8b08023fe370defa49f89705d61a13.tar.bz2
Fix unclear language in re_syntax. [2da4c23916]
-rw-r--r--doc/re_syntax.n19
1 files changed, 17 insertions, 2 deletions
diff --git a/doc/re_syntax.n b/doc/re_syntax.n
index 4504a58..628b1bf 100644
--- a/doc/re_syntax.n
+++ b/doc/re_syntax.n
@@ -137,11 +137,26 @@ later, under \fBESCAPES\fR.
.TP 8
\fB^\fR
.
-matches at the beginning of a line
+matches at the beginning of the string or a line (according to whether
+matching is line-sensitive or not, as described in \fBMATCHING\fR,
+below).
.TP
\fB$\fR
.
-matches at the end of a line
+matches at the end of the string or a line (according to whether
+matching is line-sensitive or not, as described in \fBMATCHING\fR,
+below).
+.RS
+.PP
+The difference between string and line matching modes is immaterial
+when the string does not contain a newline character. The \fB\eA\fR
+and \fB\eZ\fR constraint escapes have a similar purpose, but are
+always constraints for the overall string.
+.PP
+The default line-sensitvity depends on the command that uses the
+regular expression, and can be overridden as described in
+\fBMETASYNTAX\fR, below.
+.RE
.TP
\fB(?=\fIre\fB)\fR
.