Files
fish-shell/doc_src/cmds/break.rst
Johannes Altmanninger 7a59540517 docs: use :doc: role when referencing entire pages
No need to define "cmd-foo" anchors; use :doc:`foo <cmds/foo>`
instead. If we want "cmd-foo" but it should be tested.

See also 38b24c2325 (docs: Use :doc: role when linking to commands,
2022-09-23).
2025-11-06 12:58:59 +01:00

39 lines
859 B
ReStructuredText

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