fish-shell/doc_src/cmds/pwd.rst
Johannes Altmanninger 414d9a1eb1 Reference more non-fish shell builtins that have relevant differences
When writing scripts for other shells, it can be confusing and annoying
that our `man` function shadows other manual pages, for example `exec(1p)`
from [Linux man-pages]. I almost never want to see the fish variant for such
contended cases (which obviuosly don't include fish-specific commands like
`string`, only widely-known shell builtins).

For the contented cases like `exec`, the POSIX documentation is more
substantial and useful, since it describes a (sub)set of languages widely
used for scripting.

Because of this I think we should stop overriding the system's man pages.
Nowadays we offer `exec -h` as intuitive way to show the documentation for
the fish-specific command (note that `help` is not a good replacement because
it uses a web browser).

Looking through the contended commands, it seems like for most of them,
the fish version is not substantially different from the system version.
A notable exception is `read` but I don't think it's a very important one.

So I think we should can sacrifice a bit of the native fish-scripting
experience in exchange for playing nicer with other shells. I think the
latter is more important because scripting is not our focus, the way I see it.
So maybe put our manpath at the end.

In lieu of that, let's at least have `exec.rst` reference the system variant.

[Linux man-pages]: https://www.kernel.org/doc/man-pages/

Closes #10376
2024-04-20 13:34:08 +02:00

39 lines
896 B
ReStructuredText

.. _cmd-pwd:
pwd - output the current working directory
==========================================
Synopsis
--------
.. synopsis::
pwd [-P | --physical]
pwd [-L | --logical]
Description
-----------
.. only:: builder_man
NOTE: This page documents the fish builtin ``pwd``.
To see the documentation on any non-fish versions, use ``command man pwd``.
``pwd`` outputs (prints) the current working directory.
The following options are available:
**-L** or **--logical**
Output the logical working directory, without resolving symlinks (default behavior).
**-P** or **--physical**
Output the physical working directory, with symlinks resolved.
**-h** or **--help**
Displays help about using this command.
See Also
--------
Navigate directories using the :ref:`directory history <directory-history>` or the :ref:`directory stack <directory-stack>`