fish-shell/doc_src/cmds/realpath.rst

.. _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.
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 09:05:09 +00:00			`.. _cmd-realpath:`

doc: homogenize commands titles 2020-03-31 15:37:38 +00:00			`realpath - convert a path to an absolute path without symlinks`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`==============================================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00: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 09:59:04 +00:00			`::`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00: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 09:59:04 +00:00			`realpath PATH`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
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 16:21:41 +00:00			`.. 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``.

docs: improve realpath documentation 2019-09-17 12:48:22 +00:00			``realpath`` resolves a path to its absolute path.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
builtin realpath: Add --no-symlinks option Taken from GNU realpath, this one makes realpath not resolve symlinks. It still makes paths absolute and handles duplicate and trailing slashes. (useful in fish_add_path) 2020-09-12 17:26:04 +00:00			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.
docs: improve realpath documentation 2019-09-17 12:48:22 +00:00
builtin realpath: Add --no-symlinks option Taken from GNU realpath, this one makes realpath not resolve symlinks. It still makes paths absolute and handles duplicate and trailing slashes. (useful in fish_add_path) 2020-09-12 17:26:04 +00:00			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:`

fish_add_path: Don't resolve symlinks The case for symlinked directories being duplicated a lot isn't there, but there is a usecase for adding the symlink rather than the target, and that's homebrew. E.g. homebrew installs ruby into /usr/local/Cellar/ruby/2.7.1_2/bin, and links to it from /usr/local/opt/ruby/bin. If we add the target, we would miss updates. Having path entries that point to the same location isn't a big problem - it's a path lookup, so it takes a teensy bit longer. The canonicalization is mainly so paths don't end up duplicated via weird spelling and so relative paths can be used. 2020-09-12 17:28:01 +00:00			- ``-s`` or ``--no-symlinks``: Don't resolve symlinks, only make paths absolute, squash multiple slashes and remove trailing slashes.