mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-01-08 07:44:12 +01:00
document <Leader> and <CR>
This commit is contained in:
@@ -2,18 +2,46 @@ HEADER
|
|||||||
|
|
||||||
|key-mapping| |abbreviations| |user-commands| +
|
|key-mapping| |abbreviations| |user-commands| +
|
||||||
|
|
||||||
INTRO TO BE WRITTEN...
|
|
||||||
|
|
||||||
section:Key{nbsp}mapping[key-mapping,mapping,macro]
|
section:Key{nbsp}mapping[key-mapping,mapping,macro]
|
||||||
|
|
||||||
|
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 sequence of keys,
|
||||||
|
which are translated to a string of characters. Example:
|
||||||
|
|
||||||
|
:map <F2> :echo new Date().toDateString()<CR>
|
||||||
|
|
||||||
|
will echo the current date to the command line when [m]<F2>[m] is pressed.
|
||||||
|
|
||||||
|
There are separate key mapping tables for each of the Normal, and Insert,
|
||||||
|
Command-line modes.
|
||||||
|
|
||||||
|
|:map-special-chars| +
|
||||||
|
|
||||||
|<Nop>| +
|
|<Nop>| +
|
||||||
||<Nop>||
|
||<Nop>||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Do nothing. This command is useful for disabling a specific mapping. [c]:map
|
Do nothing. This command is useful for disabling a specific mapping. [c]:map
|
||||||
<C-n> <Nop>[c] will prevent [m]<C-n>[m] from doing anything.
|
<C-n> <Nop>[c] will prevent [m]<C-n>[m] from doing anything.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|
|<CR>| |map_return| +
|
||||||
|
||<CR>||
|
||||||
|
________________________________________________________________________________
|
||||||
|
Expand to a line terminator in a key mapping. An Ex command in the {rhs} of a
|
||||||
|
mapping requires a a line terminator after it so that it is executed when the
|
||||||
|
mapping is expanded. [m]<CR>[m] should be used for this purpose.
|
||||||
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|
|<Leader>| |mapleader| +
|
||||||
|
||<Leader>||
|
||||||
|
________________________________________________________________________________
|
||||||
|
Expands to the value of the "mapleader" variable in key mapping. If
|
||||||
|
"mapleader" is unset or empty then "\" is used.
|
||||||
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:map|
|
|:map|
|
||||||
||:map {lhs} {rhs}|| +
|
||:map {lhs} {rhs}|| +
|
||||||
||:map {lhs}|| +
|
||:map {lhs}|| +
|
||||||
@@ -30,7 +58,7 @@ ________________________________________________________________________________
|
|||||||
||:cmap {lhs}|| +
|
||:cmap {lhs}|| +
|
||||||
||:cmap||
|
||:cmap||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Map the key sequence {lhs} to {rhs} (in command-line mode). The {rhs} is
|
Map the key sequence {lhs} to {rhs} (in Command-line mode). The {rhs} is
|
||||||
remapped, allowing for nested and recursive mappings. Mappings are NOT saved
|
remapped, allowing for nested and recursive mappings. Mappings are NOT saved
|
||||||
during sessions, make sure you put them in your vimperatorrc file!
|
during sessions, make sure you put them in your vimperatorrc file!
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
@@ -58,7 +86,7 @@ ________________________________________________________________________________
|
|||||||
|:cmapc| |:cmapclear| +
|
|:cmapc| |:cmapclear| +
|
||||||
||:cmapc[lear]||
|
||:cmapc[lear]||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Remove all mappings (in command-line mode). All user-defined mappings which
|
Remove all mappings (in Command-line mode). All user-defined mappings which
|
||||||
were set by [c]:cmap[c] or [c]:cnoremap[c] are cleared.
|
were set by [c]:cmap[c] or [c]:cnoremap[c] are cleared.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
@@ -85,7 +113,7 @@ ________________________________________________________________________________
|
|||||||
||:cno[remap] {lhs}|| +
|
||:cno[remap] {lhs}|| +
|
||||||
||:cno[remap]||
|
||:cno[remap]||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Map the key sequence {lhs} to {rhs} (in command-line mode). No remapping of
|
Map the key sequence {lhs} to {rhs} (in Command-line mode). No remapping of
|
||||||
the {rhs} is performed.
|
the {rhs} is performed.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
@@ -100,21 +128,21 @@ Map the key sequence {lhs} to {rhs} (in insert mode). No remapping of the
|
|||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:unm| |:unmap|
|
|:unm| |:unmap| +
|
||||||
||:unm[ap] {lhs}||
|
||:unm[ap] {lhs}||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Remove the mapping of {lhs}.
|
Remove the mapping of {lhs}.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:cunm| |:cunmap|
|
|:cunm| |:cunmap| +
|
||||||
||:cunm[ap] {lhs}||
|
||:cunm[ap] {lhs}||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Remove the mapping of {lhs} (in command-line mode).
|
Remove the mapping of {lhs} (in Command-line mode).
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:iunm| |:iunmap|
|
|:iunm| |:iunmap| +
|
||||||
||:iunm[ap] {lhs}||
|
||:iunm[ap] {lhs}||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Remove the mapping of {lhs} (in insert mode).
|
Remove the mapping of {lhs} (in insert mode).
|
||||||
@@ -130,7 +158,6 @@ ________________________________________________________________________________
|
|||||||
Abbreviate a key sequence. Abbreviate {lhs} to {rhs}.
|
Abbreviate a key sequence. Abbreviate {lhs} to {rhs}.
|
||||||
If only {lhs} given, list that particular abbreviation.
|
If only {lhs} given, list that particular abbreviation.
|
||||||
List all abbreviations, if no arguments to are given.
|
List all abbreviations, if no arguments to are given.
|
||||||
|
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
@@ -140,7 +167,7 @@ ________________________________________________________________________________
|
|||||||
||:ca[bbrev]||
|
||:ca[bbrev]||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Abbreviate a key sequence for Command-line mode. Same as [c]:ab[reviate][c],
|
Abbreviate a key sequence for Command-line mode. Same as [c]:ab[reviate][c],
|
||||||
but for command-line mode only.
|
but for Command-line mode only.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
@@ -177,21 +204,21 @@ Insert mode only.
|
|||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:abc| |:abclear|
|
|:abc| |:abclear| +
|
||||||
||:abc[lear]||
|
||:abc[lear]||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Remove all abbreviations.
|
Remove all abbreviations.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:cabc| |:cabclear|
|
|:cabc| |:cabclear| +
|
||||||
||:cabc[lear]||
|
||:cabc[lear]||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Remove all abbreviations for Command-line mode.
|
Remove all abbreviations for Command-line mode.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:iabc| |:iabclear|
|
|:iabc| |:iabclear| +
|
||||||
||:iabc[lear]||
|
||:iabc[lear]||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Remove all abbreviations for Insert mode.
|
Remove all abbreviations for Insert mode.
|
||||||
@@ -226,14 +253,14 @@ is then executed as an Ex command.
|
|||||||
The valid escape sequences are:
|
The valid escape sequences are:
|
||||||
`--------`----------------------------------------------------------------------
|
`--------`----------------------------------------------------------------------
|
||||||
*<args>* The command arguments exactly as supplied
|
*<args>* The command arguments exactly as supplied
|
||||||
*<lt>* A literal '<' character to allow for a literal copy of one of the escape sequences. Eg. <lt>args> will expand to a literal <args>
|
*<lt>* A literal '<' character to allow for a literal copy of one of the escape sequences. E.g. <lt>args> will expand to a literal <args>
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
Note: {attr} not implemented yet.
|
Note: {attr} not implemented yet.
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
|
|
||||||
|:comc| |:comclear|
|
|:comc| |:comclear| +
|
||||||
||:comc[lear]||
|
||:comc[lear]||
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
Delete all user-defined commands.
|
Delete all user-defined commands.
|
||||||
|
|||||||
Reference in New Issue
Block a user