mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-28 13:53:10 +00:00
3a23fdf359
Includes harmonizing the display of options and arguments, standardising terminology, using the envvar directive more broadly, adding help options to all commands that support them, simplifying some language, and tidying up multiple formatting issues. string documentation is not changed.
40 lines
886 B
ReStructuredText
40 lines
886 B
ReStructuredText
.. _cmd-break:
|
|
|
|
break - stop the current inner loop
|
|
===================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
LOOP_CONSTRUCT
|
|
[COMMANDS ...]
|
|
break
|
|
[COMMANDS ...]
|
|
end
|
|
|
|
Description
|
|
-----------
|
|
|
|
``break`` halts a currently running loop (*LOOP_CONSTRUCT*), such as a :ref:`switch <cmd-switch>`, :ref:`for <cmd-for>` or :ref:`while <cmd-while>` loop. It is usually added inside of a conditional block such as an :ref:`if <cmd-if>` block.
|
|
|
|
There are no parameters for ``break``.
|
|
|
|
Example
|
|
-------
|
|
The following code searches all .c files for "smurf", and halts at the first occurrence.
|
|
|
|
::
|
|
|
|
for i in *.c
|
|
if grep smurf $i
|
|
echo Smurfs are present in $i
|
|
break
|
|
end
|
|
end
|
|
|
|
See Also
|
|
--------
|
|
|
|
- the :ref:`continue <cmd-continue>` command, to skip the remainder of the current iteration of the current inner loop
|