51 lines
2.1 KiB
Plaintext
51 lines
2.1 KiB
Plaintext
'\"
|
|
'\" Copyright (c) 1993 The Regents of the University of California.
|
|
'\" All rights reserved.
|
|
'\"
|
|
'\" Permission is hereby granted, without written agreement and without
|
|
'\" license or royalty fees, to use, copy, modify, and distribute this
|
|
'\" documentation for any purpose, provided that the above copyright
|
|
'\" notice and the following two paragraphs appear in all copies.
|
|
'\"
|
|
'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
|
|
'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
|
'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
|
|
'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
'\"
|
|
'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
|
|
'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
'\" AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
|
'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
|
|
'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
|
'\"
|
|
'\" $Header: /user6/ouster/tcl/man/RCS/while.n,v 1.1 93/06/16 16:48:27 ouster Exp $ SPRITE (Berkeley)
|
|
'\"
|
|
.so man.macros
|
|
.HS while tcl
|
|
.BS
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
|
.SH NAME
|
|
while \- Execute script repeatedly as long as a condition is met
|
|
.SH SYNOPSIS
|
|
\fBwhile \fItest body
|
|
.BE
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \fIwhile\fR command evaluates \fItest\fR as an expression
|
|
(in the same way that \fBexpr\fR evaluates its argument).
|
|
The value of the expression must a proper boolean
|
|
value; if it is a true value
|
|
then \fIbody\fR is executed by passing it to the Tcl interpreter.
|
|
Once \fIbody\fR has been executed then \fItest\fR is evaluated
|
|
again, and the process repeats until eventually \fItest\fR
|
|
evaluates to a false boolean value. \fBContinue\fR
|
|
commands may be executed inside \fIbody\fR to terminate the current
|
|
iteration of the loop, and \fBbreak\fR
|
|
commands may be executed inside \fIbody\fR to cause immediate
|
|
termination of the \fBwhile\fR command. The \fBwhile\fR command
|
|
always returns an empty string.
|
|
|
|
.SH KEYWORDS
|
|
boolean value, loop, test, while
|