fish-shell/sphinx_doc_src/cmds/break.rst
Fabian Homborg cf9b8fa3fa docs: Add labels to all commands
This allows us to use :ref: references, which don't require hardcoding
it as html

[ci skip]
2019-03-31 11:05:33 +02:00

35 lines
701 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 `switch <cmds/switch.html>`__, `for <cmds/for.html>`__ or `while <cmds/while.html>`__ loop. It is usually added inside of a conditional block such as an `if <cmds/if.html>`__ 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