fish-shell/doc_src/cmds/dirs.rst
David Adam e23e52a8e9 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-12 00:21:12 +08:00

28 lines
576 B
ReStructuredText

.. _cmd-dirs:
dirs - print directory stack
============================
Synopsis
--------
.. synopsis::
dirs [-c]
Description
-----------
``dirs`` prints the current :ref:`directory stack <directory-stack>`, as created by :ref:`pushd <cmd-pushd>` and modified by :ref:`popd <cmd-popd>`.
The following options are available:
**-c**:
Clear the directory stack instead of printing it.
``dirs`` does not accept any parameters.
See Also
--------
- the :ref:`cdh <cmd-cdh>` command which provides a more intuitive way to navigate to recently visited directories.