The break built-in aborts a loop being executed.
Syntax
-
break [nest] -
break -i
Description
When executed without the -i (--iteration) option, the built-in aborts a
currently executed for,
while, or until
loop.
When executed in nested loops, it aborts the nestth innermost loop.
The default nest is one.
If the number of currently executed nested loops is less than nest, the
built-in aborts the outermost loop.
When executed with the -i (--iteration) option, the built-in aborts the
currently executed (innermost) iterative execution.
Options
-
-i -
--iteration -
Abort an iterative execution instead of a loop.
Operands
- nest
-
The number of loops to abort, which must be a positive integer.
Exit status
The exit status of the break built-in is:
-
zero if a loop was successfully aborted.
-
that of the command that was executed just before the break built-in if an iterative execution was successfully aborted.
Notes
The break built-in is a special built-in.
The POSIX standard defines no options for the break built-in; the built-in accepts no options in the POSIXly-correct mode.
Treatment of currently executed loops that are not lexically enclosing the break built-in is unspecified in POSIX. Examples of such loops include:
-
A loop invoking a function in which the break built-in is used.
-
A loop in which a trap action is executed in which the break built-in is used.
Yash does not allow breaking such loops.