Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-27 05:13:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/doc_src/prompt_pwd.txt

32 lines
888 B
Text
Raw Normal View History

Document prompt_pwd Fixes #253
2015-12-17 14:17:28 +00:00
\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
update lexicon for latest docs Closes #2699 Fixes issues with: * 'string' function synopsis * Redirection display issues * Better file & path detection * Rendering of % & @ chars in both html and man * @ symbol in tutorial Improves robustness by implementing an @EOL marker to prevent hold buffer dumping extra chars after the end of an expression. Added new '{{' and '}}' meta-chars for when you want curly braces in a regexp that was previously tripping up the lexicon. Improve man/html presentation consistency for * string * printf * prompt_pwd * type Use cli-styling for 'practical' examples. Add <bs> tag for presenting content with preceding backslash. Signed-off-by: Mark Griffiths <mark@thebespokepixel.com>
2016-04-04 12:43:37 +00:00
\fish{cli-dark}
Document prompt_pwd Fixes #253
2015-12-17 14:17:28 +00:00
>_ cd ~/
>_ echo $PWD
replace <outp> command with \outp in docs 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.
2016-04-24 04:14:00 +00:00
\outp{/home/alfa}
update lexicon for latest docs Closes #2699 Fixes issues with: * 'string' function synopsis * Redirection display issues * Better file & path detection * Rendering of % & @ chars in both html and man * @ symbol in tutorial Improves robustness by implementing an @EOL marker to prevent hold buffer dumping extra chars after the end of an expression. Added new '{{' and '}}' meta-chars for when you want curly braces in a regexp that was previously tripping up the lexicon. Improve man/html presentation consistency for * string * printf * prompt_pwd * type Use cli-styling for 'practical' examples. Add <bs> tag for presenting content with preceding backslash. Signed-off-by: Mark Griffiths <mark@thebespokepixel.com>
2016-04-04 12:43:37 +00:00
Document prompt_pwd Fixes #253
2015-12-17 14:17:28 +00:00
>_ prompt_pwd
replace <outp> command with \outp in docs 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.
2016-04-24 04:14:00 +00:00
\outp{~}
update lexicon for latest docs Closes #2699 Fixes issues with: * 'string' function synopsis * Redirection display issues * Better file & path detection * Rendering of % & @ chars in both html and man * @ symbol in tutorial Improves robustness by implementing an @EOL marker to prevent hold buffer dumping extra chars after the end of an expression. Added new '{{' and '}}' meta-chars for when you want curly braces in a regexp that was previously tripping up the lexicon. Improve man/html presentation consistency for * string * printf * prompt_pwd * type Use cli-styling for 'practical' examples. Add <bs> tag for presenting content with preceding backslash. Signed-off-by: Mark Griffiths <mark@thebespokepixel.com>
2016-04-04 12:43:37 +00:00
Document prompt_pwd Fixes #253
2015-12-17 14:17:28 +00:00
>_ cd /tmp/banana/sausage/with/mustard
>_ prompt_pwd
replace <outp> command with \outp in docs 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.
2016-04-24 04:14:00 +00:00
\outp{/t/b/s/w/mustard}
update lexicon for latest docs Closes #2699 Fixes issues with: * 'string' function synopsis * Redirection display issues * Better file & path detection * Rendering of % & @ chars in both html and man * @ symbol in tutorial Improves robustness by implementing an @EOL marker to prevent hold buffer dumping extra chars after the end of an expression. Added new '{{' and '}}' meta-chars for when you want curly braces in a regexp that was previously tripping up the lexicon. Improve man/html presentation consistency for * string * printf * prompt_pwd * type Use cli-styling for 'practical' examples. Add <bs> tag for presenting content with preceding backslash. Signed-off-by: Mark Griffiths <mark@thebespokepixel.com>
2016-04-04 12:43:37 +00:00
Document prompt_pwd Fixes #253
2015-12-17 14:17:28 +00:00
>_ set -g fish_prompt_pwd_dir_length 3
>_ prompt_pwd
replace <outp> command with \outp in docs 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.
2016-04-24 04:14:00 +00:00
\outp{/tmp/ban/sau/wit/mustard}
Document prompt_pwd Fixes #253
2015-12-17 14:17:28 +00:00
\endfish
Reference in a new issue Copy permalink