summaryrefslogtreecommitdiffstats
path: root/doc/string.n
diff options
context:
space:
mode:
authorhobbs <hobbs>1999-08-09 16:30:34 (GMT)
committerhobbs <hobbs>1999-08-09 16:30:34 (GMT)
commitc6cad9a80c362fb16803329eb1f55bf319d0c628 (patch)
tree2c876a8bde9c5a01f096833763979b73f6256321 /doc/string.n
parent4ff6daaaf9efbd9a03407ec0362aee849b29cb7d (diff)
downloadtcl-c6cad9a80c362fb16803329eb1f55bf319d0c628.zip
tcl-c6cad9a80c362fb16803329eb1f55bf319d0c628.tar.gz
tcl-c6cad9a80c362fb16803329eb1f55bf319d0c628.tar.bz2
1999-08-09 Jeff Hobbs <hobbs@scriptics.com>
* doc/Object.3: clarified Tcl_DecrRefCount docs [Bug: 1952] * doc/array.n: clarified array pattern docs [Bug: 1330] * doc/clock.n: fixed clock docs [Bug: 693] * doc/lindex.n: clarified to account for new end-int behavior. * doc/string.n: fixed formatting errors [Bug: 2188 2189] * doc/tclvars.n: fixed doc error [Bug: 2042]
Diffstat (limited to 'doc/string.n')
-rw-r--r--doc/string.n13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/string.n b/doc/string.n
index d394d0c..f06c3b6 100644
--- a/doc/string.n
+++ b/doc/string.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: string.n,v 1.11 1999/06/24 03:27:56 stanton Exp $
+'\" RCS: @(#) $Id: string.n,v 1.12 1999/08/09 16:30:35 hobbs Exp $
'\"
.so man.macros
.TH string n 8.1 Tcl "Tcl Built-In Commands"
@@ -44,8 +44,8 @@ are used in the comparison. If \fB\-length\fR is negative, it is
ignored. If \fB\-nocase\fR is specified, then the strings are
compared in a case-insensitive manner.
.TP
-\fBstring equal ?\fB\-nocase\fR? ?\fB-length int\fR? \fIstring1
-string2\fR Perform a character-by-character comparison of strings
+\fBstring equal ?\fB\-nocase\fR? ?\fB-length int\fR? \fIstring1 string2\fR
+Perform a character-by-character comparison of strings
\fIstring1\fR and \fIstring2\fR. Returns 1 if \fIstring1\fR and
\fIstring2\fR are identical, or 0 when not. If \fB\-length\fR is
specified, then only the first \fIlength\fR characters are used in the
@@ -95,8 +95,8 @@ offset (e.g. \fBend\-1\fR would refer to the "c" in "abcd").
If \fIcharIndex\fR is less than 0 or greater than
or equal to the length of the string then an empty string is
returned.
-.RE
.VS 8.1
+.RE
.TP
\fBstring is \fIclass\fR ?\fB\-strict\fR? ?\fB\-failindex \fIvarname\fR? \fIstring\fR
Returns 1 if \fIstring\fR is a valid member of the specified character
@@ -151,10 +151,11 @@ Any Unicode word character. That is any alphanumeric character,
and any Unicode connector punctuation characters (e.g. underscore).
.IP \fBxdigit\fR 10
Any hexadecimal digit character ([0\-9A\-Fa\-f]).
-.RE
+.PP
In the case of \fBboolean\fR, \fBtrue\fR and \fBfalse\fR, if the
-function will return 0, the \fIvarname\fR will always be set to 0,
+function will return 0, then the \fIvarname\fR will always be set to 0,
due to the varied nature of a valid boolean value.
+.RE
.TP
\fBstring last \fIstring1 string2\fR ?\fIstartIndex\fR?
.VE 8.1