fish-shell/sphinx_doc_src/cmds/prompt_pwd.rst

.. _cmd-prompt_pwd:

prompt_pwd - Print pwd suitable for prompt
==========================================

Synopsis
--------

prompt_pwd


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
    <outp>/home/alfa</outp>
    
    >_ prompt_pwd
    <outp>~</outp>
    
    >_ cd /tmp/banana/sausage/with/mustard
    >_ prompt_pwd
    <outp>/t/b/s/w/mustard</outp>
    
    >_ set -g fish_prompt_pwd_dir_length 3
    >_ prompt_pwd
    <outp>/tmp/ban/sau/wit/mustard</outp>
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:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`prompt_pwd - Print pwd suitable for prompt`
			`==========================================`

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
			`prompt_pwd`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
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
			`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.`

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`
			`<outp>/home/alfa</outp>`

			`>_ prompt_pwd`
			`<outp>~</outp>`

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

			`>_ set -g fish_prompt_pwd_dir_length 3`
			`>_ prompt_pwd`
			`<outp>/tmp/ban/sau/wit/mustard</outp>`