diff options
| author | Fred Cox <mcfedr@gmail.com> | 2021-11-01 14:18:45 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-01 22:18:45 +0100 |
| commit | c1f2d345aac0b0241ea1b6d99977fea20fa3f5bb (patch) | |
| tree | b6828442ee1aaef179b30d65007d79b9f47bfe9e /docs | |
| parent | 73277d37c62e6d3bff15e0125796a9cef6346318 (diff) | |
fix(escaping): move escaping to individual variables (#3107)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 579467e94..7739d1b61 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -3319,6 +3319,19 @@ If you have an interesting example not covered there, feel free to share it ther ::: +::: warning Command output is printed unescaped to the prompt + +Whatever output the command generates is printed unmodified in the prompt. This means if the output +contains special sequences that are interpreted by your shell they will be expanded when displayed. +These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, +e.g. `\h`, but this module will not work in a fish or zsh shell. + +Format strings can also contain shell specific prompt sequences, e.g. +[Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), +[Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). + +::: + ### Options | Option | Default | Description | |