Added examples.

1 files changed, 28 insertions, 1 deletions

diff --git a/doc/regexp.n b/doc/regexp.n
index 4309d26..1d88b99 100644
--- a/doc/regexp.n
+++ b/doc/regexp.n
@@ -4,7 +4,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: regexp.n,v 1.12 2002/10/10 14:46:57 dgp Exp $
+'\" RCS: @(#) $Id: regexp.n,v 1.13 2004/05/21 23:47:48 dkf Exp $
 '\" 
 .so man.macros
 .TH regexp n 8.3 Tcl "Tcl Built-In Commands"
@@ -126,6 +126,33 @@ in \fIexp\fR doesn't match the string (e.g. because it was in a
 portion of the expression that wasn't matched), then the corresponding
 \fIsubMatchVar\fR will be set to ``\fB\-1 \-1\fR'' if \fB\-indices\fR
 has been specified or to an empty string otherwise.
+.SH EXAMPLES
+Find the first occurrence of a word starting with \fBfoo\fR in a
+string that is not actually an instance of \fBfoobar\fR, and get the
+letters following it up to the end of the word into a variable:
+.CS
+regexp {\\<foo(?!bar\\>)(\w*)} $string -> restOfWord
+.CE
+Note that the whole matched substring has been placed in the variable
+\fB\->\fR which is a name chosen to look nice given that we are not
+actually interested in its contents.
+
+Find the index of the word \fBbadger\fR (in any case) within a string
+and store that in the variable \fBlocation\fR:
+.CS
+regexp -indices {(?i)\\<badger\\>} $string location
+.CE
+
+Count the number of octal digits in a string:
+.CS
+regexp -all {[0-7]} $string
+.CE
+
+List all words (consisting of all sequences of non-whitespace
+characters) in a string:
+.CS
+regexp -all -inline {\\S+} $string
+.CE
 
 .SH "SEE ALSO"
 re_syntax(n), regsub(n)