fish-shell/doc_src/cmds/prompt_pwd.rst

.. _cmd-prompt_pwd:

prompt_pwd - print pwd suitable for prompt
==========================================

Synopsis
--------

::

    function fish_prompt
        echo -n (prompt_pwd) '$ '
    end

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

``prompt_pwd`` is a function to print the current working directory in a way suitable for prompts. It will replace the home directory with "~" and shorten every path component but the last to a default of one character.

To change the number of characters per path component, set ``$fish_prompt_pwd_dir_length`` to the number of characters. Setting it to 0 or an invalid value will disable shortening entirely.

Examples
--------

::

    >_ cd ~/
    >_ echo $PWD
    /home/alfa

    >_ prompt_pwd
    ~

    >_ cd /tmp/banana/sausage/with/mustard
    >_ prompt_pwd
    /t/b/s/w/mustard

    >_ set -g fish_prompt_pwd_dir_length 3
    >_ prompt_pwd
    /tmp/ban/sau/wit/mustard
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-prompt_pwd:`

doc: homogenize commands titles 2020-03-31 23:37:38 +08:00			`prompt_pwd - print pwd suitable for prompt`
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			`function fish_prompt`
			`echo -n (prompt_pwd) '$ '`
			`end`
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
docs: fix formatting in prompt_pwd manual 2019-09-17 17:31:47 +08:00			``prompt_pwd`` is a function to print the current working directory in a way suitable for prompts. It will replace the home directory with "~" and shorten every path component but the last to a default of one character.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: fix formatting in prompt_pwd manual 2019-09-17 17:31:47 +08:00			To change the number of characters per path component, set ``$fish_prompt_pwd_dir_length`` to the number of characters. Setting it to 0 or an invalid value will disable shortening entirely.
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			`Examples`
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			`::`

			`>_ cd ~/`
			`>_ echo $PWD`
docs: Remove <outp> tags fish_indent_lexer formats lines not starting with a prompt indicator as output, as long as there is a prompt indicator elsewhere. So these tags are useless and wrong. See #5696. [ci skip] 2019-04-30 18:19:04 +08:00			`/home/alfa`
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			`>_ prompt_pwd`
docs: Remove <outp> tags fish_indent_lexer formats lines not starting with a prompt indicator as output, as long as there is a prompt indicator elsewhere. So these tags are useless and wrong. See #5696. [ci skip] 2019-04-30 18:19:04 +08:00			`~`
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			`>_ cd /tmp/banana/sausage/with/mustard`
			`>_ prompt_pwd`
docs: Remove <outp> tags fish_indent_lexer formats lines not starting with a prompt indicator as output, as long as there is a prompt indicator elsewhere. So these tags are useless and wrong. See #5696. [ci skip] 2019-04-30 18:19:04 +08:00			`/t/b/s/w/mustard`
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			`>_ set -g fish_prompt_pwd_dir_length 3`
			`>_ prompt_pwd`
docs: Remove <outp> tags fish_indent_lexer formats lines not starting with a prompt indicator as output, as long as there is a prompt indicator elsewhere. So these tags are useless and wrong. See #5696. [ci skip] 2019-04-30 18:19:04 +08:00			`/tmp/ban/sau/wit/mustard`