fish-shell/sphinx_doc_src/cmds/break.rst
Fabian Homborg cb94dd4d30 docs: Use command labels
[ci skip]
2019-03-31 11:15:57 +02:00

35 lines
689 B
ReStructuredText

.. _cmd-break:
break - stop the current inner loop
===================================
Synopsis
--------
LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end
Description
-----------
``break`` halts a currently running loop, 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