fish-shell/doc_src/cmds/cdh.rst

.. _cmd-cdh:

cdh - change to a recently visited directory
============================================

Synopsis
--------

.. synopsis::

    cdh [DIRECTORY]

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

``cdh`` with no arguments presents a list of :ref:`recently visited directories <directory-history>`.
You can then select one of the entries by letter or number.
You can also press :kbd:`tab` to use the completion pager to select an item from the list.
If you give it a single argument it is equivalent to ``cd DIRECTORY``.

Note that the ``cd`` command limits directory history to the 25 most recently visited directories.
The history is stored in the :envvar:`dirprev` and :envvar:`dirnext` variables, which this command manipulates.
If you make those universal variables, your ``cd`` history is shared among all fish instances.

See Also
--------

- the :doc:`dirh <dirh>` command to print the directory history
- the :doc:`prevd <prevd>` command to move backward
- the :doc:`nextd <nextd>` command to move forward
complete synopsis should just be a synopsis. 2021-12-11 16:41:09 +08:00			`.. _cmd-cdh:`
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
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`cdh - change to a recently visited directory`
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`
			`--------`

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 22:09:46 +08:00			`.. synopsis::`

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-12 00:18:41 +08:00			`cdh [DIRECTORY]`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +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
cd, cdh, command, commandline Documentation. 2021-12-09 20:45:10 +08:00			``cdh`` with no arguments presents a list of :ref:`recently visited directories <directory-history>`.
			`You can then select one of the entries by letter or number.`
docs: use canonical key names in :kbd: tags This seems a bit better because it's what bind uses. To makes sure that something like :kbd:`ctrl-x` looks good in HTML, remove the border from the kbd style. Else both "ctrl" and "x" get small boxes which looks weird. 2024-04-14 02:30:07 +08:00			You can also press :kbd:`tab` to use the completion pager to select an item from the list.
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-12 00:18:41 +08:00			If you give it a single argument it is equivalent to ``cd DIRECTORY``.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
cd, cdh, command, commandline Documentation. 2021-12-09 20:45:10 +08:00			Note that the ``cd`` command limits directory history to the 25 most recently visited directories.
docs: Add some more envvars to reference (and fix a couple of references) 2022-12-02 01:00:06 +08:00			The history is stored in the :envvar:`dirprev` and :envvar:`dirnext` variables, which this command manipulates.
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-12 00:18:41 +08:00			If you make those universal variables, your ``cd`` history is shared among all fish instances.
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			`See Also`
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
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-24 01:57:49 +08:00			- the :doc:`dirh <dirh>` command to print the directory history
			- the :doc:`prevd <prevd>` command to move backward
			- the :doc:`nextd <nextd>` command to move forward