fish-shell/doc_src/cmds/pwd.rst

.. _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 the ``pwd`` command you might have,
          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>`
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			`.. _cmd-pwd:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`pwd - output the current working directory`
			`==========================================`

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::`

			`pwd [-P \| --physical]`
			`pwd [-L \| --logical]`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
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: Document that the man pages are for our builtins For builtins that have the same name as common commands, it might not be entirely obvious that there is another page. So, for those builtins, we add a note, but only in the man pages. (exception is true and false because the note would be longer than the page, and it's fridging true and false) Fixes #8077. 2021-07-16 16:21:41 +00:00			`.. only:: builder_man`

			NOTE: This page documents the fish builtin ``pwd``.
			To see the documentation on the ``pwd`` command you might have,
			use ``command man pwd``.

Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``pwd`` outputs (prints) the current working directory.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +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			`-L or --logical`
			`Output the logical working directory, without resolving symlinks (default behavior).`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
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			`-P or --physical`
			`Output the physical working directory, with symlinks resolved.`
doc: add section about directory history / stack This PR also adds "See Also" section in the related commands. 2020-04-04 11:01:53 +00:00
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.`

doc: add section about directory history / stack This PR also adds "See Also" section in the related commands. 2020-04-04 11:01:53 +00:00			`See Also`
			`--------`

			Navigate directories using the :ref:`directory history <directory-history>` or the :ref:`directory stack <directory-stack>`