diff options
| author | rjohnson <rjohnson> | 1998-03-26 14:45:59 (GMT) |
|---|---|---|
| committer | rjohnson <rjohnson> | 1998-03-26 14:45:59 (GMT) |
| commit | 2b5738da524e944cda39e24c0a87b745a43bd8c3 (patch) | |
| tree | 6e8c9473978f6dab66c601e911721a7bd9d70b1b /doc/break.n | |
| parent | c6a259aeeca4814a97cf6694814c63e74e4e18fa (diff) | |
| download | tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.zip tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.tar.gz tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.tar.bz2 | |
Initial revision
Diffstat (limited to 'doc/break.n')
| -rw-r--r-- | doc/break.n | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/break.n b/doc/break.n new file mode 100644 index 0000000..391ba91 --- /dev/null +++ b/doc/break.n @@ -0,0 +1,34 @@ +'\" +'\" Copyright (c) 1993-1994 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: @(#) break.n 1.7 96/10/09 08:29:26 +'\" +.so man.macros +.TH break n "" Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +break \- Abort looping command +.SH SYNOPSIS +\fBbreak\fR +.BE + +.SH DESCRIPTION +.PP +This command is typically invoked inside the body of a looping command +such as \fBfor\fR or \fBforeach\fR or \fBwhile\fR. +It returns a TCL_BREAK code, which causes a break exception +to occur. +The exception causes the current script to be aborted +out to the innermost containing loop command, which then +aborts its execution and returns normally. +Break exceptions are also handled in a few other situations, such +as the \fBcatch\fR command, Tk event bindings, and the outermost +scripts of procedure bodies. + +.SH KEYWORDS +abort, break, loop |