38 lines
1.3 KiB
Plaintext
38 lines
1.3 KiB
Plaintext
'\"
|
|
'\" Copyright (c) 1993 The Regents of the University of California.
|
|
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
|
|
'\"
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
'\"
|
|
'\" SCCS: @(#) while.n 1.6 96/03/25 20:27:35
|
|
'\"
|
|
.so man.macros
|
|
.TH while n "" Tcl "Tcl Built-In Commands"
|
|
.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\fR
|
|
.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
|