doc_src/cmds/else.rst

.. _cmd-else:

else - execute command if a condition is not met
================================================

Synopsis
--------

**if** *CONDITION*; *COMMANDS_TRUE* ...; [**else**; *COMMANDS_FALSE* ...;] **end**

Description
-----------

:ref:`if <cmd-if>` will execute the command *CONDITION**.
If the condition's exit status is 0, the commands *COMMANDS_TRUE* will execute.
If it is not 0 and **else** is given, *COMMANDS_FALSE* will be executed.


Example
-------

The following code tests whether a file *foo.txt* exists as a regular file.

::

    if test -f foo.txt
        echo foo.txt exists
    else
        echo foo.txt does not exist
    end
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 11:05:09 +02:00			`.. _cmd-else:`

Switch command docs from \section to reStructuredText 2018-12-16 17:39:33 -08:00			`else - execute command if a condition is not met`
Fix command section separator line lengths 2019-01-02 20:10:47 -08:00			`================================================`
Switch command docs from \section to reStructuredText 2018-12-16 17:39:33 -08:00
Migrate the 'synopsis' sections to .rst format 2018-12-17 17:58:24 -08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 13:08:41 -08:00
docs synopses: add space before ellipsis This matches the style in man(1) (except that we use the … ligature). A previous iteration did the reverse (never use a space before the ellipsis). That would be a smaller change. 2022-01-09 09:49:51 +01:00			`if CONDITION; COMMANDS_TRUE ...; [else; COMMANDS_FALSE ...;] end`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 13:08:41 -08:00
Convert \\subsection sections into rst format 2018-12-18 18:44:30 -08:00			`Description`
Fix command section separator line lengths 2019-01-02 20:10:47 -08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 13:08:41 -08:00
doc_src: Continue the slog through the letter F. We are using only :: in a synopsis for fishscript examples given of the command being documented. 2021-12-17 15:16:47 -08:00			:ref:`if <cmd-if>` will execute the command CONDITION*.
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 13:58:38 -08:00			`If the condition's exit status is 0, the commands COMMANDS_TRUE will execute.`
doc_src: Continue the slog through the letter F. We are using only :: in a synopsis for fishscript examples given of the command being documented. 2021-12-17 15:16:47 -08:00			`If it is not 0 and else is given, COMMANDS_FALSE will be executed.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 13:08:41 -08:00

Convert \\subsection sections into rst format 2018-12-18 18:44:30 -08:00			`Example`
Fix command section separator line lengths 2019-01-02 20:10:47 -08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 13:08:41 -08:00
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 13:58:38 -08:00			`The following code tests whether a file foo.txt exists as a regular file.`
Switch \fish sections to rst format 2018-12-18 19:14:04 -08:00
			`::`

			`if test -f foo.txt`
			`echo foo.txt exists`
			`else`
			`echo foo.txt does not exist`
			`end`