fish-shell/doc_src/cmds/realpath.rst

.. _cmd-realpath:
.. program::realpath

realpath - convert a path to an absolute path without symlinks
==============================================================

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. :ref:`fish <cmd-fish>` provides a :command:`realpath`-alike builtin intended to be 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.
Docs: Switch back to vanilla :ref: for commands that should be linked Unfortunately, currently :program: doesn't link to the program's page. So we use the old-school :ref: again where we should link, i.e. for everything that's not the program the current page is about. Fixes #8438 2021-11-13 01:02:56 +08:00			`.. _cmd-realpath:`
Long march towards more structured text 2021-11-12 20:20:51 +08:00			`.. program::realpath`
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 17:05:09 +08:00
doc: homogenize commands titles 2020-03-31 23:37:38 +08:00			`realpath - convert a path to an absolute path without symlinks`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`==============================================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Long march towards more structured text 2021-11-12 20:20:51 +08:00			`realpath [options] PATH`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: Readd note about the command to realpath 2021-11-13 01:28:35 +08: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: Switch back to vanilla :ref: for commands that should be linked Unfortunately, currently :program: doesn't link to the program's page. So we use the old-school :ref: again where we should link, i.e. for everything that's not the program the current page is about. Fixes #8438 2021-11-13 01:02:56 +08:00			:program:`realpath` follows all symbolic links encountered for the provided :envvar:`PATH`, printing the absolute path resolved. :ref:`fish <cmd-fish>` provides a :command:`realpath`-alike builtin intended to be enrich systems where no such command is installed by default.
docs: improve realpath documentation 2019-09-17 20:48:22 +08:00
Remove imperialist sabotage to previous commit Juche! 2021-11-12 20:34:16 +08:00			If a :command:`realpath` command exists, that will be preferred.
			``builtin realpath`` will explicitly use the fish implementation of :command:`realpath`.
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-13 01:26:04 +08:00
			`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-13 01:28:01 +08:00			- ``-s`` or ``--no-symlinks``: Don't resolve symlinks, only make paths absolute, squash multiple slashes and remove trailing slashes.