aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/while.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc_src/while.txt')
-rw-r--r--doc_src/while.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc_src/while.txt b/doc_src/while.txt
new file mode 100644
index 00000000..3a59afc5
--- /dev/null
+++ b/doc_src/while.txt
@@ -0,0 +1,13 @@
+\section while while - perform a command multiple times
+
+\subsection while-synopsis Synopsis
+<tt>while CONDITION; COMMANDS; end</tt>
+
+\subsection while-synopsis Synopsis
+The <tt>while</tt> builtin causes fish to continually execute the command COMMANDS while the command CONDITION returns with status 0.
+
+\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 the file foo.txt exists.