summaryrefslogtreecommitdiffstats
path: root/doc/if.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-10-27 12:52:31 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-10-27 12:52:31 (GMT)
commit5bc57d7b0f63d86fc383565d69f7704943fff94d (patch)
tree3ed6ba33b7a0eb1bb7d89c83f86bb2f420d5284a /doc/if.n
parent7ea5d4dbe8b82a86701cec95132a8a9557a5f105 (diff)
downloadtcl-5bc57d7b0f63d86fc383565d69f7704943fff94d.zip
tcl-5bc57d7b0f63d86fc383565d69f7704943fff94d.tar.gz
tcl-5bc57d7b0f63d86fc383565d69f7704943fff94d.tar.bz2
More doc fix backporting
Diffstat (limited to 'doc/if.n')
-rw-r--r--doc/if.n37
1 files changed, 36 insertions, 1 deletions
diff --git a/doc/if.n b/doc/if.n
index 7f9032f..a23dd5f 100644
--- a/doc/if.n
+++ b/doc/if.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: if.n,v 1.3 2000/09/07 14:27:48 poenitz Exp $
+'\" RCS: @(#) $Id: if.n,v 1.3.18.1 2004/10/27 12:52:40 dkf Exp $
'\"
.so man.macros
.TH if n "" Tcl "Tcl Built-In Commands"
@@ -38,6 +38,41 @@ There may be any number of \fBelseif\fR clauses, including zero.
The return value from the command is the result of the body script
that was executed, or an empty string
if none of the expressions was non-zero and there was no \fIbodyN\fR.
+.SH EXAMPLES
+A simple conditional:
+.CS
+\fBif\fR {$vbl == 1} { puts "vbl is one" }
+.CE
+.PP
+With an \fBelse\fR-clause:
+.CS
+\fBif\fR {$vbl == 1} {
+ puts "vbl is one"
+} \fBelse\fR {
+ puts "vbl is not one"
+}
+.CE
+.PP
+With an \fBelseif\fR-clause too:
+.CS
+\fBif\fR {$vbl == 1} {
+ puts "vbl is one"
+} \fBelseif\fR {$vbl == 2} {
+ puts "vbl is two"
+} \fBelse\fR {
+ puts "vbl is not one or two"
+}
+.CE
+.PP
+Remember, expressions can be multi-line, but in that case it can be a
+good idea to use the optional \fBthen\fR keyword for clarity:
+.CS
+\fBif\fR {
+ $vbl == 1 || $vbl == 2 || $vbl == 3
+} \fBthen\fR {
+ puts "vbl is one, two or three"
+}
+.CE
.SH "SEE ALSO"
expr(n), for(n), foreach(n)