fish-shell/doc_src/while.txt
Mark Griffiths 509d152e54 Tutorial auto colouring, Man page and Make fixes
Completely fixes #1557 and the underlying Doxygen changes that caused
it. Should make fish docs simpler and more robust, more consistent and
generally prettier.

todo:
- trap unmarked text as arguments in context
- test & fix sed portability - see in particular. (so far tested on BSD
(Mac) and GNU sed).
- test Makefile changes
- last round of aesthetic changes and getting that ascii fish in there…
2014-09-03 14:43:26 +01:00

24 lines
No EOL
754 B
Text

\section while while - perform a command multiple times
\subsection while-synopsis Synopsis
\fish{synopsis}
while CONDITION; COMMANDS...; end
\endfish
\subsection while-description Description
`while` repeatedly executes `CONDITION`, and if the exit status
is 0, then executes `COMMANDS`.
If the exit status of `CONDITION` is non-zero on the first iteration,
`COMMANDS` will not be executed at all.
Use <a href="#begin">`begin; ...; end`</a> for complex conditions; more
complex control can be achieved with `while true` containing a
<a href="#break">break</a>.
\subsection while-example Example
\fish
while test -f foo.txt; echo file exists; sleep 10; end
# outputs 'file exists' at 10 second intervals as long as the file foo.txt exists.
\endfish