fish-shell/sphinx_doc_src/cmds/or.rst
David Adam 02d82dcf85 docs: update all command synopsis formatting
Adds synopses for those commands missing them.

Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as
fish code may not be the ideal appearance.
2019-09-17 17:59:04 +08:00

34 lines
1005 B
ReStructuredText

.. _cmd-or:
or - conditionally execute a command
====================================
Synopsis
--------
::
COMMAND1; or COMMAND2
Description
-----------
``or`` is used to execute a command if the previous command was not successful (returned a status of something other than 0).
``or`` statements may be used as part of the condition in an :ref:`and <cmd-if>` or :ref:`while <cmd-while>` block. See the documentation
for :ref:`if <cmd-if>` and :ref:`while <cmd-while>` for examples.
``or`` does not change the current exit status itself, but the command it runs most likely will. The exit status of the last foreground command to exit can always be accessed using the :ref:`$status <variables-status>` variable.
Example
-------
The following code runs the ``make`` command to build a program. If the build succeeds, the program is installed. If either step fails, ``make clean`` is run, which removes the files created by the build process.
::
make; and make install; or make clean