mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-28 22:03:12 +00:00
2a98b7a593
man(1) uses lowercase placeholders but we usually don't. Additionally, the new synopsis autoformatting only recognizes placeholders if they are uppercase. Use uppercase for all placeholders.
41 lines
868 B
ReStructuredText
41 lines
868 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, 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
|