github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2025-02-01 10:12:02 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: improve realpath documentation

Browse Source
This commit is contained in:
David Adam 2019-09-17 20:48:22 +08:00
parent 02d82dcf85
commit e6d6c5c5c7
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx_doc_src/cmds/realpath.rst
View File

@ -13,6 +13,8 @@ Synopsis
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``.
``realpath`` resolves a path to its absolute path.
If the path is invalid no translated path will be written to stdout and an error will be reported.
fish provides a ``realpath`` builtin as a fallback for systems where there is no ``realpath`` command. fish's implementation always resolves its first argument, and does not support any options.
If the operation fails, an error will be reported.