Files
fish-shell/doc_src/cmds/break.rst
Johannes Altmanninger 87c73b7fbf builtin break/continue: support -h/--help argument
These are not generic builtins because we check whether they're inside
a loop. There's no reason to not support "break -h" when we support
"if -h" etc.; do that.
2025-09-20 13:56:23 +02:00

41 lines
875 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 :doc:`for <for>` or :doc:`while <while>` loop. It is usually added inside of a conditional block such as an :doc:`if <if>` block.
The **-h** or **--help** option displays help about using this command.
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 :doc:`continue <continue>` command, to skip the remainder of the current iteration of the current inner loop