The key mapping commands can be used to either redefine the standard key bindings or define new ones. A mapping consists of a key, or key-sequence, which is translated to a string of characters. Example:
:map :echo new Date().toDateString()
will echo the current date to the command line when <F2> is pressed.
Keys can be mapped in four distinct modes:
Map the key-sequence {lhs} to {rhs} for the applicable mode(s). The {rhs} is remapped, allowing for nested and recursive mappings.
Map the key-sequence {lhs} to {rhs} for the applicable mode(s). No remapping of the {rhs} is performed.
Remove the mapping of {lhs} for the applicable mode(s).
Remove all mappings for the applicable mode(s). All user-defined mappings are cleared.
List all mappings for the applicable mode(s).
List all mappings starting with {lhs} for the applicable mode(s).
When the first argument to one of the mapping commands is <silent>, {rhs} is not echoed to the command line, nor, for that matter, anything else until the command has completed.
Below is an overview of which modes each map command applies to:
:map :noremap :unmap :mapclear – both Normal and Visual modes :nmap :nnoremap :nunmap :nmapclear – Normal mode :vmap :vnoremap :vunmap :vmapclear – Visual mode :imap :inoremap :iunmap :imapclear – Insert mode :cmap :cnoremap :cunmap :cmapclear – Command-line mode
For most keys, the key-sequence is the same as the character you see when you type that key, however there are some exceptions which allow for a much larger number of keys to be used in mappings.
Most keyboards have some modifiers such as the control, alt or meta keys. In order to create a mapping that uses these keys the correct prefix must be used within the angle brackets.
These prefixes can be combined however you see fit, though you should note that within angle brackets all alphabetic characters are read as lowercase. In order to force them to be uppercase, you must specify the S- prefix as well. Additionally, you should never use the S- prefix with a number or piece of punctuation, even if you require a shift to type that character; doing so will give you a mapping that cannot be typed. With non-character keys, tab and space, the S- modifier works just like C- A- and M-. Some examples may clarify the situation:
Expand to a line terminator in a key mapping. An Ex command in the {rhs} of a mapping requires a line terminator after it so that it is executed when the mapping is expanded. <CR> should be used for this purpose.
Expands to the value of the "mapleader" variable in key mapping. If "mapleader" is unset or empty then \ is used. Example:
:map h :echo Hello
works like
:map \h :echo Hello
but after
let mapleader = ,
it works like
:map ,h :echo Hello
Vimperator can automatically replace words identified as abbreviations, which may be used to save typing or to correct commonly misspelled words. An abbreviation can be one of three types that are defined by the types of constituent characters. Whitespace and quotes are non-keyword types, and all other characters are keyword types.
Strings that cannot be abbreviations include "a'b" and "a b".
An abbreviation is recognized when a space, quote character, or <C-]> is typed after the abbreviation. There are no default abbreviations, and abbreviations are never recursive.
Abbreviate a key sequence. Abbreviate {lhs} to {rhs}. If only {lhs} is given, list all abbreviations that start with {lhs}. If no arguments are given, list all abbreviations.
Abbreviate a key sequence for Command-line mode. Same as :abbreviate, but for Command-line mode only.
Abbreviate a key sequence for Insert mode. Same as :abbreviate but for Insert mode only.
Remove an abbreviation for Command-line mode. Same as :unabbreviate, but for Command-line mode only.
Remove an abbreviation for Insert mode. Same as :unabbreviate but for Insert mode only.
List all user-defined commands that start with {cmd}.
Define a new user command. The name of the command is {cmd} and its replacement text is {rep}. The command's attributes are {attr}. If a command with this name already exists an error is reported unless [!] is specified, in which case the command is redefined. Unlike Vim, the command may start with a lowercase letter.
The command's behavior can be specified by providing attributes when the command is defined.
Argument handlingBy default user commands accept no arguments. This can be changed by specifying the -nargs attribute.
The valid values are:
Completion for arguments to user defined commands is not available by default. Completion can be enabled by specifying one of the following arguments to the -complete option when defining the command.
Custom completion can be provided by specifying the custom,{func} argument to -complete. The {func} is called with two arguments, a completion context, and an object describing the command's arguments. It should set the context's completions property, or return an object, with items and start properties, describing the completions and where the replacement is to start.
start is the index into the word being completed at which the returned values should be applied and completions is a two dimensional array of the form: [[arg1, description1], [arg2, description2], …]
Count handlingBy default user commands do not accept a count. Use the -count attribute if you'd like to have a count passed to your user command. This will then be available for expansion as <count> in the argument.
Special casesBy default a user command does not have a special version, i.e. a version executed with the ! modifier. Providing the -bang attribute will enable this and <bang> will be available in the argument.
Command descriptionThe command's description text can be set with -description. Otherwise it will default to "User-defined command".
Replacement textThe replacement text {rep} is scanned for escape sequences and these are replaced with values from the user-entered command line. The resulting string is then executed as an Ex command.
The valid escape sequences are:
"q-" can be prefixed to the escape sequence so that the value is quoted, making it suitable for expression evaluation. Example: <q-args>
Add a :Google command to search via google:
:command -nargs=* Google open google <args>