aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/while.txt
diff options
context:
space:
mode:
authorGravatar Mark Griffiths <mark@thebespokepixel.com>2014-08-01 03:37:32 +0100
committerGravatar Mark Griffiths <mark@thebespokepixel.com>2014-09-03 14:43:24 +0100
commitd282bc462578a6e47747c78d2d42883530f0d11e (patch)
treea6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/while.txt
parent1c4223889bd729ee83aa21a3450dc28f92ade641 (diff)
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
Diffstat (limited to 'doc_src/while.txt')
-rw-r--r--doc_src/while.txt18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc_src/while.txt b/doc_src/while.txt
index 496c36c2..2fa74cb6 100644
--- a/doc_src/while.txt
+++ b/doc_src/while.txt
@@ -1,21 +1,23 @@
\section while while - perform a command multiple times
\subsection while-synopsis Synopsis
-<tt>while CONDITION; COMMANDS...; end</tt>
+\fish{syn}
+while CONDITION; COMMANDS...; end
+\endfish
\subsection while-description Description
-<tt>while</tt> repeatedly executes <tt>CONDITION</tt>, and if the exit status
-is 0, then executes <tt>COMMANDS</tt>.
+`while` repeatedly executes `CONDITION`, and if the exit status
+is 0, then executes `COMMANDS`.
-If the exit status of \c CONDITION is non-zero on the first iteration,
-\c COMMANDS will not be executed at all.
+If the exit status of `CONDITION` is non-zero on the first iteration,
+`COMMANDS` will not be executed at all.
-Use <a href="#begin"><tt>begin; ...; end</tt></a> for complex conditions; more
-complex control can be achieved with <tt>while true</tt> containing a
+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
-<tt>while test -f foo.txt; echo file exists; sleep 10; end</tt>
+`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.