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

34 lines
1.1 KiB
ReStructuredText

.. _cmd-realpath:
.. program::realpath
realpath - convert a path to an absolute path without symlinks
==============================================================
Synopsis
--------
.. synopsis::
realpath [OPTIONS] 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``.
:program:`realpath` follows all symbolic links encountered for the provided :envvar:`PATH`, printing the absolute path resolved. :doc:`fish <fish>` provides a :command:`realpath`-alike builtin intended to enrich systems where no such command is installed by default.
If a :command:`realpath` command exists, that will be preferred.
``builtin realpath`` will explicitly use the fish implementation of :command:`realpath`.
The following options are available:
**-s** or **--no-symlinks**
Don't resolve symlinks, only make paths absolute, squash multiple slashes and remove trailing slashes.
**-h** or **--help**
Displays help about using this command.