fish-shell/sphinx_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 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.

See also ``dirs`` and ``dirs -c``.

You may be interested in the :ref:`cdh <cmd-cdh>` command which provides a more intuitive way to navigate to recently visited directories.

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
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
			`pushd [DIRECTORY]`
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: Use more command labels 2019-03-31 09:24:04 +00:00			The ``pushd`` function adds ``DIRECTORY`` to the top of the 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-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
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			See also ``dirs`` and ``dirs -c``.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: More command labels [ci skip] 2019-03-31 09:28:13 +00:00			You may be interested in the :ref:`cdh <cmd-cdh>` command which provides a more intuitive way to navigate to recently visited directories.
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			`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

			`::`

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