fish-shell/doc_src/cmds/realpath.rst
Fabian Homborg 801d7e3e11 docs: Document that the man pages are for our builtins
For builtins that have the same name as common commands, it might not
be entirely obvious that there is another page.

So, for those builtins, we add a note, but only in the man pages.

(exception is true and false because the note would be longer than the
page, and it's fridging true and false)

Fixes #8077.
2021-07-16 18:21:41 +02:00

31 lines
942 B
ReStructuredText

.. _cmd-realpath:
realpath - convert a path to an absolute path without symlinks
==============================================================
Synopsis
--------
::
realpath PATH
Description
-----------
.. only:: builder_man
NOTE: This page documents the fish builtin ``realpath``.
To see the documentation on the ``realpath`` command you might have,
use ``command man realpath``.
``realpath`` resolves a path to its absolute path.
fish provides a ``realpath`` builtin as a fallback for systems where there is no ``realpath`` command, your OS might provide a version with more features.
If a ``realpath`` command exists, it will be preferred, so if you want to use the builtin you should use ``builtin realpath`` explicitly.
The following options are available:
- ``-s`` or ``--no-symlinks``: Don't resolve symlinks, only make paths absolute, squash multiple slashes and remove trailing slashes.