fish-shell/doc_src/cmds/pushd.rst

.. _cmd-pushd:

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

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. :ref:`popd <cmd-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.

Example
-------

::

    pushd /usr/src
    # Working directory is now /usr/src
    # Directory stack contains /usr/src

    pushd /usr/src/fish-shell
    # Working directory is now /usr/src/fish-shell
    # Directory stack contains /usr/src /usr/src/fish-shell

    pushd /tmp/
    # Working directory is now /tmp
    # Directory stack contains /tmp /usr/src /usr/src/fish-shell

    pushd +1
    # Working directory is now /usr/src
    # Directory stack contains /usr/src /usr/src/fish-shell /tmp

    popd
    # Working directory is now /usr/src/fish-shell
    # Directory stack contains /usr/src/fish-shell /tmp

See Also
--------

- the :ref:`dirs <cmd-dirs>` command to print the directory stack
- the :ref:`cdh <cmd-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 17:05:09 +08:00			`.. _cmd-pushd:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`pushd - push directory to directory stack`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`=========================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
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			`::`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
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			`pushd [DIRECTORY]`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
doc: add section about directory history / stack This PR also adds "See Also" section in the related commands. 2020-04-04 19:01:53 +08:00			The ``pushd`` function adds ``DIRECTORY`` to the top of the :ref:`directory stack <directory-stack>` and makes it the current working directory. :ref:`popd <cmd-popd>` will pop it off and return to the original directory.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`Without arguments, it exchanges the top two directories in the stack.`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08: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-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``pushd -NUMBER`` rotates clockwise i.e. top to bottom.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`::`

			`pushd /usr/src`
			`# Working directory is now /usr/src`
			`# Directory stack contains /usr/src`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 16:50:52 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`pushd /usr/src/fish-shell`
			`# Working directory is now /usr/src/fish-shell`
			`# Directory stack contains /usr/src /usr/src/fish-shell`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 16:50:52 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`pushd /tmp/`
			`# Working directory is now /tmp`
			`# Directory stack contains /tmp /usr/src /usr/src/fish-shell`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 16:50:52 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`pushd +1`
			`# Working directory is now /usr/src`
			`# Directory stack contains /usr/src /usr/src/fish-shell /tmp`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 16:50:52 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`popd`
			`# Working directory is now /usr/src/fish-shell`
			`# Directory stack contains /usr/src/fish-shell /tmp`
doc: add section about directory history / stack This PR also adds "See Also" section in the related commands. 2020-04-04 19:01:53 +08:00
			`See Also`
			`--------`

			- the :ref:`dirs <cmd-dirs>` command to print the directory stack
			- the :ref:`cdh <cmd-cdh>` command which provides a more intuitive way to navigate to recently visited directories.