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.
This commit is contained in:
Mark Griffiths
2014-08-01 03:37:32 +01:00
parent 1c4223889b
commit d282bc4625
86 changed files with 9212 additions and 4813 deletions

View File

@@ -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