summaryrefslogtreecommitdiffstats
path: root/runtime/doc/map.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2007-03-08 17:12:08 +0000
committerBram Moolenaar <Bram@vim.org>2007-03-08 17:12:08 +0000
commit552f8a1140a69491259cd8e4b7f1273be176c48f (patch)
tree25f5910530465fe538d6918d4b01256ae037ff9b /runtime/doc/map.txt
parent6417da604d684e4af5622dae3f295f36cd815f81 (diff)
updated for version 7.0-214v7.0.214
Diffstat (limited to 'runtime/doc/map.txt')
-rw-r--r--runtime/doc/map.txt20
1 files changed, 18 insertions, 2 deletions
diff --git a/runtime/doc/map.txt b/runtime/doc/map.txt
index 62515cc615..d81bc3f010 100644
--- a/runtime/doc/map.txt
+++ b/runtime/doc/map.txt
@@ -1,4 +1,4 @@
-*map.txt* For Vim version 7.0. Last change: 2006 May 03
+*map.txt* For Vim version 7.0. Last change: 2007 Mar 08
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1303,12 +1303,28 @@ If the first two characters of an escape sequence are "q-" (for example,
<q-args>) then the value is quoted in such a way as to make it a valid value
for use in an expression. This uses the argument as one single value.
When there is no argument <q-args> is an empty string.
-
+ *<f-args>*
To allow commands to pass their arguments on to a user-defined function, there
is a special form <f-args> ("function args"). This splits the command
arguments at spaces and Tabs, quotes each argument individually, and the
<f-args> sequence is replaced by the comma-separated list of quoted arguments.
See the Mycmd example below. If no arguments are given <f-args> is removed.
+ To embed whitespace into an argument of <f-args>, prepend a backslash.
+<f-args> replaces every pair of backslashes (\\) with one backslash. A
+backslash followed by a character other than white space or a backslash
+remains unmodified. Overview:
+
+ command <f-args> ~
+ XX ab 'ab'
+ XX a\b 'a\b'
+ XX a\ b 'a b'
+ XX a\ b 'a ', 'b'
+ XX a\\b 'a\b'
+ XX a\\ b 'a\', 'b'
+ XX a\\\b 'a\\b'
+ XX a\\\ b 'a\ b'
+ XX a\\\\b 'a\\b'
+ XX a\\\\ b 'a\\', 'b'
Examples >