aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/break.txt
diff options
context:
space:
mode:
authorGravatar axel <axel@liljencrantz.se>2005-09-20 23:31:55 +1000
committerGravatar axel <axel@liljencrantz.se>2005-09-20 23:31:55 +1000
commit7ddecde54372c25fcf526e2d24807c5dac9800aa (patch)
tree1bff6e0ccd096836adb74529d53a6debcf45375b /doc_src/break.txt
parent149594f974350bb364a76c73b91b1d5ffddaa1fa (diff)
Add subdirectories
darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
Diffstat (limited to 'doc_src/break.txt')
-rw-r--r--doc_src/break.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc_src/break.txt b/doc_src/break.txt
new file mode 100644
index 00000000..03e8a416
--- /dev/null
+++ b/doc_src/break.txt
@@ -0,0 +1,21 @@
+
+\section break break - stop the innermost currently evaluated loop
+
+\subsection break-synopsis Synopsis
+ <tt>LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end</tt>
+
+\subsection break-description Description
+The \c break builtin is used to halt a currently running loop, such as a <a href="#for">for</a> loop or a <a href="#while">while</a> loop. It is usually added inside of a conditional block such as an <a href="#if">if</a> statement or a <a href="#switch">switch</a> statement.
+
+\subsection break-example Example
+The following code searches all .c files for smurfs, and halts at the first occurance.
+<p>
+<tt>for i in *.c;
+<br>&nbsp;&nbsp;&nbsp;&nbsp;if grep smurf $i;
+<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo Smurfs are present in $i;
+<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;
+<br>&nbsp;&nbsp;&nbsp;&nbsp;end;
+<br>end;
+</tt>
+</p>
+