fish-shell/doc_src/cmds/realpath.rst

.. _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. :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.

**-h** or **--help**
    Displays help about using this command.
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-12 17:02:56 +00:00			`.. _cmd-realpath:`
Long march towards more structured text 2021-11-12 12:20:51 +00: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 09:05:09 +00:00
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 synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the *, , and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/\|\| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [\|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750 2022-01-09 14:09:46 +00:00			`.. synopsis::`

docs synopsis: make all placeholder arguments uppercase man(1) uses lowercase placeholders but we usually don't. Additionally, the new synopsis autoformatting only recognizes placeholders if they are uppercase. Use uppercase for all placeholders. 2022-01-17 04:29:49 +00:00			`realpath [OPTIONS] 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: Readd note about the command to realpath 2021-11-12 17:28:35 +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: 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-12 17:02:56 +00: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 12:48:22 +00:00
Remove imperialist sabotage to previous commit Juche! 2021-11-12 12:34:16 +00: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-12 17:26:04 +00:00
			`The following options are available:`

docs: standardise on definition lists for options Harmonizes the option listing including formatting in a similar manner to the synopsis of each entry. 2022-03-11 15:56:20 +00:00			`-s or --no-symlinks`
			`Don't resolve symlinks, only make paths absolute, squash multiple slashes and remove trailing slashes.`
docs: omnibus cleanup Includes harmonizing the display of options and arguments, standardising terminology, using the envvar directive more broadly, adding help options to all commands that support them, simplifying some language, and tidying up multiple formatting issues. string documentation is not changed. 2022-03-11 16:18:41 +00:00
			`-h or --help`
			`Displays help about using this command.`