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 17:05:09 +08:00			`.. _cmd-false:`

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

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