aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/while.txt
diff options
context:
space:
mode:
authorGravatar David Adam (zanchey) <zanchey@ucc.gu.uwa.edu.au>2013-05-12 15:56:01 +0800
committerGravatar ridiculousfish <corydoras@ridiculousfish.com>2013-05-13 01:48:20 -0700
commit1287b9d82382bf22e16edda67eae755f07397f2e (patch)
tree811814b029d65ac11a193e616ca4a71d216dbe0c /doc_src/while.txt
parent91aab03b90a6b583a3c0ecff5b015c6066d34f28 (diff)
Help cleanup
Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
Diffstat (limited to 'doc_src/while.txt')
-rw-r--r--doc_src/while.txt14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc_src/while.txt b/doc_src/while.txt
index 1ec643d2..496c36c2 100644
--- a/doc_src/while.txt
+++ b/doc_src/while.txt
@@ -4,16 +4,18 @@
<tt>while CONDITION; COMMANDS...; end</tt>
\subsection while-description Description
-The <tt>while</tt> builtin causes fish to continually execute CONDITION and
-execute COMMANDS as long as CONDITION returned with status 0. If CONDITION is
-false on the first time, COMMANDS will not be executed at all. Hints: use
-<a href="#begin"><tt>begin; ...; end</tt></a> for complex conditions; more
+<tt>while</tt> repeatedly executes <tt>CONDITION</tt>, and if the exit status
+is 0, then executes <tt>COMMANDS</tt>.
+
+If the exit status of \c CONDITION is non-zero on the first iteration,
+\c 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
<a href="#break">break</a>.
\subsection while-example Example
<tt>while test -f foo.txt; echo file exists; sleep 10; end</tt>
-
-causes fish to print the line 'file exists' at 10 second intervals as long as
+outputs 'file exists' at 10 second intervals as long as
the file foo.txt exists.