mirror of
https://github.com/fish-shell/fish-shell
synced 2024-11-14 17:07:44 +00:00
5df8fab463
Doxygen has been warning that `<outp>` and `</outp>` are not valid XML/HTML commands since commit cb6d5d76 on 20016-04-04. That's primarily because there is at present no way to tell Doxygen to recognize new XML/HTML tags. The actual errors look like this:
```
.../string.doxygen:187: warning: Unsupported xml/html tag </outp> found
```
I hate build errors since they a) cause needless concern, and b) make it harder to notice when I've introduced a new error. So switch from XML/C## style markup to Doxygen style markup for the "outp" annotation.
31 lines
888 B
Text
31 lines
888 B
Text
\section prompt_pwd prompt_pwd - Print pwd suitable for prompt
|
|
|
|
\subsection prompt_pwd-synopsis Synopsis
|
|
\fish{synopsis}
|
|
prompt_pwd
|
|
\endfish
|
|
|
|
\subsection prompt_pwd-description 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.
|
|
|
|
\subsection prompt_pwd-example Examples
|
|
|
|
\fish{cli-dark}
|
|
>_ cd ~/
|
|
>_ echo $PWD
|
|
\outp{/home/alfa}
|
|
|
|
>_ prompt_pwd
|
|
\outp{~}
|
|
|
|
>_ cd /tmp/banana/sausage/with/mustard
|
|
>_ prompt_pwd
|
|
\outp{/t/b/s/w/mustard}
|
|
|
|
>_ set -g fish_prompt_pwd_dir_length 3
|
|
>_ prompt_pwd
|
|
\outp{/tmp/ban/sau/wit/mustard}
|
|
\endfish
|