diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/or.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (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/or.txt')
| -rw-r--r-- | doc_src/or.txt | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/doc_src/or.txt b/doc_src/or.txt index 3567917f..39c3d95a 100644 --- a/doc_src/or.txt +++ b/doc_src/or.txt @@ -1,14 +1,16 @@ \section or or - conditionally execute a command \subsection or-synopsis Synopsis - <tt>COMMAND1; or COMMAND2</tt> +\fish{syn} +COMMAND1; or COMMAND2 +\endfish \subsection or-description Description -\c or is used to execute a command if the current exit +`or` is used to execute a command if the current exit status (as set by the last previous command) is not 0. -\c or does not change the current exit status. +`or` does not change the current exit status. The exit status of the last foreground command to exit can always be accessed using the <a href="index.html#variables-status">$status</a> @@ -16,12 +18,12 @@ variable. \subsection or-example Example -The following code runs the \c make command to build a program. If the +The following code runs the `make` command to build a program. If the build succeeds, the program is installed. If either step fails, -<tt>make clean</tt> is run, which removes the files created by the +`make clean` is run, which removes the files created by the build process. -<pre> +\fish make; and make install; or make clean -</pre> +\endfish |