fish-shell/sphinx_doc_src/cmds/realpath.rst
David Adam 02d82dcf85 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 17:59:04 +08:00

19 lines
810 B
ReStructuredText

.. _cmd-realpath:
realpath - Convert a path to an absolute path without symlinks
==============================================================
Synopsis
--------
::
realpath PATH
Description
-----------
This is implemented as a function and a builtin. The function will attempt to use an external realpath command if one can be found. Otherwise it falls back to the builtin. The builtin does not support any options. It's meant to be used only by scripts which need to be portable. The builtin implementation behaves like GNU realpath when invoked without any options (which is the most common use case). In general scripts should not invoke the builtin directly. They should just use ``realpath``.
If the path is invalid no translated path will be written to stdout and an error will be reported.