summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2021-01-05 20:33:49 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2021-01-05 20:33:49 (GMT)
commit279c0829fcf5d56c5c0c9105bc6c4a1837bdad06 (patch)
treea7e0073d80d00df4a3547aef5d3bf96f94f3411a
parent2f9727a745138487306a89f9e976b3c6acdead7d (diff)
downloadtcl-279c0829fcf5d56c5c0c9105bc6c4a1837bdad06.zip
tcl-279c0829fcf5d56c5c0c9105bc6c4a1837bdad06.tar.gz
tcl-279c0829fcf5d56c5c0c9105bc6c4a1837bdad06.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 14b0de0..554f659 100644
--- a/doc/re_syntax.n
+++ b/doc/re_syntax.n
@@ -135,11 +135,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
.