fish-shell/doc_src/cmds/false.rst

.. _cmd-false:

false - return an unsuccessful result
=====================================

Synopsis
--------

**false**

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

``false`` sets the exit status to 1.

See Also
--------

- :ref:`true <cmd-true>` command
- :ref:`$status <variables-status>` variable
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 09:05:09 +00:00			`.. _cmd-false:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`false - return an unsuccessful result`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`=====================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Long march towards more structured text 2021-11-12 12:20:51 +00:00			`false`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``false`` sets the exit status to 1.
doc: add interlinks between `true` ←→ `false` and `and` ←→ `or` cmds 2020-02-23 11:41:18 +00:00
			`See Also`
			`--------`

			- :ref:`true <cmd-true>` command
			- :ref:`$status <variables-status>` variable