fish-shell/doc_src/cmds/true.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

25 lines
347 B
ReStructuredText

.. _cmd-true:
true - return a successful result
=================================
Synopsis
--------
.. synopsis::
true
Description
-----------
``true`` sets the exit status to 0.
**:** (a single colon) is an alias for the ``true`` command.
See Also
--------
- :doc:`false <false>` command
- :ref:`$status <variables-status>` variable