fish-shell/doc_src/cmds/false.rst
Fabian Boehm 38b24c2325 docs: Use :doc: role when linking to commands
This makes it so we link to the very top of the document instead of a
special anchor we manually include.

So clicking e.g. :doc:`string <cmds/string>` will link you to
cmds/string.html instead of cmds/string.html#cmd-string.

I would love to have a way to say "this document from the root of the
document path", but that doesn't appear to work, I tried
`/cmds/string`.

So we'll just have to use cmds/string in normal documents and plain
`string` from other commands.
2022-09-24 10:56:43 +02:00

22 lines
294 B
ReStructuredText

.. _cmd-false:
false - return an unsuccessful result
=====================================
Synopsis
--------
.. synopsis::
false
Description
-----------
``false`` sets the exit status to 1.
See Also
--------
- :doc:`true <true>` command
- :ref:`$status <variables-status>` variable