fish-shell/doc_src/cmds/break.rst
2022-09-17 00:12:10 -05:00

40 lines
858 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:`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