diff options
| author | Enno <Konfekt@users.noreply.github.com> | 2024-05-15 21:54:19 +0200 |
|---|---|---|
| committer | Christian Brabandt <cb@256bit.org> | 2024-05-15 21:54:19 +0200 |
| commit | 5faeb60480c6efba5c0468c01275120b6ace5a09 (patch) | |
| tree | 90259cd143d80c27a9b49c8506f892deec5941d8 /runtime/doc | |
| parent | 8314de8fd4aa4d18fc524f960f5d683a2d8cba32 (diff) | |
runtime(doc): clarify {special} argument for shellescape()
closes: #14770
Signed-off-by: Enno <Konfekt@users.noreply.github.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/builtin.txt | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index b37170ce72..edc018fe7a 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -1,4 +1,4 @@ -*builtin.txt* For Vim version 9.1. Last change: 2024 May 07 +*builtin.txt* For Vim version 9.1. Last change: 2024 May 15 VIM REFERENCE MANUAL by Bram Moolenaar @@ -8991,11 +8991,12 @@ shellescape({string} [, {special}]) *shellescape()* Otherwise it will enclose {string} in single quotes and replace all "'" with "'\''". - When the {special} argument is present and it's a non-zero - Number or a non-empty String (|non-zero-arg|), then special - items such as "!", "%", "#" and "<cword>" will be preceded by - a backslash. This backslash will be removed again by the |:!| - command. + The {special} argument adds additional escaping of keywords + used in Vim commands. When it is not omitted and a non-zero + number or a non-empty String (|non-zero-arg|), then special + items such as "!", "%", "#" and "<cword>" (as listed in + |expand()|) will be preceded by a backslash. + This backslash will be removed again by the |:!| command. The "!" character will be escaped (again with a |non-zero-arg| {special}) when 'shell' contains "csh" in the tail. That is |