fish-shell/doc_src/cmds/while.rst
Aaron Gyes 14d60ccb32 More synopsis work.
A great leap forward
2021-12-21 17:24:47 -08:00

28 lines
888 B
ReStructuredText

.. _cmd-while:
while - perform a set of commands multiple times
================================================
Synopsis
--------
**while** *CONDITION*; *COMMANDS...*; **end**
Description
-----------
**while** repeatedly executes ``CONDITION``, and if the exit status is 0, then executes ``COMMANDS``.
The exit status of the **while** loop is the exit status of the last iteration of the ``COMMANDS`` executed, or 0 if none were executed. (This matches other shells and is POSIX-compatible.)
You can use :ref:`and <cmd-and>` or :ref:`or <cmd-or>` for complex conditions. Even more complex control can be achieved with ``while true`` containing a :ref:`break <cmd-break>`.
Example
-------
::
while test -f foo.txt; or test -f bar.txt ; echo file exists; sleep 10; end
# outputs 'file exists' at 10 second intervals,
# as long as the file foo.txt or bar.txt exists.