fish-shell/doc_src/cmds/pushd.rst

.. _cmd-pushd:

pushd - push directory to directory stack
=========================================

Synopsis
--------

.. synopsis::

    pushd DIRECTORY

Description
-----------

The ``pushd`` function adds *DIRECTORY* to the top of the :ref:`directory stack <directory-stack>` and makes it the current working directory. :doc:`popd <popd>` will pop it off and return to the original directory.

Without arguments, it exchanges the top two directories in the stack.

``pushd +NUMBER`` rotates the stack counter-clockwise i.e. from bottom to top

``pushd -NUMBER`` rotates clockwise i.e. top to bottom.

The **-h** or **--help** option displays help about using this command.

Example
-------

::

    cd ~/dir1
    pushd ~/dir2
    pushd ~/dir3
    # Working directory is now ~/dir3
    # Directory stack contains ~/dir2 ~/dir1

    pushd /tmp
    # Working directory is now /tmp
    # Directory stack contains ~/dir3 ~/dir2 ~/dir1

    pushd +1
    # Working directory is now ~/dir3
    # Directory stack contains ~/dir2 ~/dir1 /tmp

    popd
    # Working directory is now ~/dir2
    # Directory stack contains ~/dir1 /tmp

See Also
--------

- the :doc:`dirs <dirs>` command to print the directory stack
- the :doc:`cdh <cdh>` command which provides a more intuitive way to navigate to recently visited directories.
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-pushd:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`pushd - push directory to directory stack`
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::`

			`pushd DIRECTORY`
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: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands. 2022-09-23 17:57:49 +00:00			The ``pushd`` function adds DIRECTORY to the top of the :ref:`directory stack <directory-stack>` and makes it the current working directory. :doc:`popd <popd>` will pop it off and return to the original directory.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`Without arguments, it exchanges the top two directories in the stack.`

Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``pushd +NUMBER`` rotates the stack counter-clockwise i.e. from bottom to top
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``pushd -NUMBER`` rotates clockwise i.e. top to bottom.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +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			`The -h or --help option displays help about using this command.`

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
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
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`::`

Improve the documentation for pushd Correct the examples so that the directory stack is correct. Fixes #7940 2021-05-04 20:21:06 +00:00			`cd ~/dir1`
			`pushd ~/dir2`
			`pushd ~/dir3`
			`# Working directory is now ~/dir3`
			`# Directory stack contains ~/dir2 ~/dir1`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 08:50:52 +00:00
Improve the documentation for pushd Correct the examples so that the directory stack is correct. Fixes #7940 2021-05-04 20:21:06 +00:00			`pushd /tmp`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`# Working directory is now /tmp`
Improve the documentation for pushd Correct the examples so that the directory stack is correct. Fixes #7940 2021-05-04 20:21:06 +00:00			`# Directory stack contains ~/dir3 ~/dir2 ~/dir1`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 08:50:52 +00:00
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`pushd +1`
Improve the documentation for pushd Correct the examples so that the directory stack is correct. Fixes #7940 2021-05-04 20:21:06 +00:00			`# Working directory is now ~/dir3`
			`# Directory stack contains ~/dir2 ~/dir1 /tmp`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 08:50:52 +00:00
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`popd`
Improve the documentation for pushd Correct the examples so that the directory stack is correct. Fixes #7940 2021-05-04 20:21:06 +00:00			`# Working directory is now ~/dir2`
			`# Directory stack contains ~/dir1 /tmp`
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`
			`--------`

docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands. 2022-09-23 17:57:49 +00:00			- the :doc:`dirs <dirs>` command to print the directory stack
			- the :doc:`cdh <cdh>` command which provides a more intuitive way to navigate to recently visited directories.