Document prompt_pwd

Fixes #253

1 files changed, 28 insertions, 0 deletions

diff --git a/doc_src/prompt_pwd.txt b/doc_src/prompt_pwd.txt
new file mode 100644
index 00000000..7161d8aa
--- /dev/null
+++ b/doc_src/prompt_pwd.txt
@@ -0,0 +1,28 @@
+\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
+>_ 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
+\endfish