runtime(doc): Whitespace updates
Use double sentence spacing and wrap lines at 'textwidth'. Code examples and tables were not wrapped unless this had already been done locally. closes: #18453 Signed-off-by: Doug Kearns <dougkearns@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Doug Kearns
committed by
Christian Brabandt
Christian Brabandt
parent
2a33b499a3
commit
c58f91c035
@ -1,4 +1,4 @@
|
||||
*map.txt* For Vim version 9.1. Last change: 2025 Aug 06
|
||||
*map.txt* For Vim version 9.1. Last change: 2025 Oct 12
|
||||
|
||||
|
||||
VIM REFERENCE MANUAL by Bram Moolenaar
|
||||
@ -105,7 +105,7 @@ modes.
|
||||
map command applies. The mapping may remain defined
|
||||
for other modes where it applies.
|
||||
It also works when {lhs} matches the {rhs} of a
|
||||
mapping. This is for when an abbreviation applied.
|
||||
mapping. This is for when an abbreviation applied.
|
||||
Note: Trailing spaces are included in the {lhs}.
|
||||
See |map-trailing-white|.
|
||||
|
||||
@ -295,7 +295,7 @@ In case you want the mapping to not do anything, you can have the expression
|
||||
evaluate to an empty string. If something changed that requires Vim to
|
||||
go through the main loop (e.g. to update the display), return "\<Ignore>".
|
||||
This is similar to "nothing" but makes Vim return from the loop that waits for
|
||||
input. Example: >
|
||||
input. Example: >
|
||||
func s:OpenPopup()
|
||||
call popup_create(... arguments ...)
|
||||
return "\<Ignore>"
|
||||
@ -330,7 +330,7 @@ For this reason the following is blocked:
|
||||
If you want the mapping to do any of these let the returned characters do
|
||||
that, or use a |<Cmd>| mapping instead.
|
||||
|
||||
You can use getchar(), it consumes typeahead if there is any. E.g., if you
|
||||
You can use getchar(), it consumes typeahead if there is any. E.g., if you
|
||||
have these mappings: >
|
||||
inoremap <expr> <C-L> nr2char(getchar())
|
||||
inoremap <expr> <C-L>x "foo"
|
||||
@ -542,7 +542,7 @@ it's just used here for this situation.
|
||||
The simplest way to load a set of related language mappings is by using the
|
||||
'keymap' option. See |45.5|.
|
||||
In Insert mode and in Command-line mode the mappings can be disabled with
|
||||
the CTRL-^ command |i_CTRL-^| |c_CTRL-^|. These commands change the value of
|
||||
the CTRL-^ command |i_CTRL-^| |c_CTRL-^|. These commands change the value of
|
||||
the 'iminsert' option. When starting to enter a normal command line (not a
|
||||
search pattern) the mappings are disabled until a CTRL-^ is typed. The state
|
||||
last used is remembered for Insert mode and Search patterns separately. The
|
||||
@ -590,7 +590,7 @@ e.g. from a timer callback. *E1309*
|
||||
|
||||
*:map-verbose*
|
||||
When 'verbose' is non-zero, the detected and used 'keyprotocol' value will be
|
||||
displayed in the first line. Also a key map will also display where it was
|
||||
displayed in the first line. Also a key map will also display where it was
|
||||
last defined. Example: >
|
||||
|
||||
:verbose map <C-W>*
|
||||
@ -748,7 +748,7 @@ Upper and lowercase differences are ignored.
|
||||
|
||||
*map-comments*
|
||||
It is not possible to put a comment after these commands, because the '"'
|
||||
character is considered to be part of the {lhs} or {rhs}. However, one can
|
||||
character is considered to be part of the {lhs} or {rhs}. However, one can
|
||||
use |", since this starts a new, empty command with a comment.
|
||||
|
||||
*map_bar* *map-bar*
|
||||
@ -827,7 +827,7 @@ Multiplying a count
|
||||
When you type a count before triggering a mapping, it's like the count was
|
||||
typed before the {lhs}. For example, with this mapping: >
|
||||
:map <F4> 3w
|
||||
Typing 2<F4> will result in "23w". Thus not moving 2 * 3 words but 23 words.
|
||||
Typing 2<F4> will result in "23w". Thus not moving 2 * 3 words but 23 words.
|
||||
If you want to multiply counts use the expression register: >
|
||||
:map <F4> @='3w'<CR>
|
||||
The part between quotes is the expression being executed. |@=|
|
||||
@ -960,7 +960,7 @@ configuration). For that, you can add the line: >
|
||||
|
||||
set convert-meta on
|
||||
|
||||
to your ~/.inputrc file. If you're creating the file, you might want to use: >
|
||||
to your ~/.inputrc file. If you're creating the file, you might want to use: >
|
||||
|
||||
$include /etc/inputrc
|
||||
|
||||
@ -991,8 +991,8 @@ in Insert mode: >
|
||||
1.12 MAPPING SUPER-KEYS or COMMAND-KEYS *:map-super-keys* *:map-cmd-key*
|
||||
|
||||
The Super modifier is available in GUI mode (when |gui_running| is 1) for gVim
|
||||
on Linux and MacVim on Mac OS. If you're on a Mac, this represents the Command
|
||||
key, on Linux with the GTK GUI it represents the Super key.
|
||||
on Linux and MacVim on Mac OS. If you're on a Mac, this represents the
|
||||
Command key, on Linux with the GTK GUI it represents the Super key.
|
||||
The character "D" is used for the Super / Command modifier.
|
||||
|
||||
For example, to map Command-b in Insert mode: >
|
||||
@ -1244,7 +1244,7 @@ an additional rule:
|
||||
full-id In front of the match is a non-keyword character, or this is where
|
||||
the line or insertion starts. Exception: When the abbreviation is
|
||||
only one character, it is not recognized if there is a non-keyword
|
||||
character in front of it, other than a space or a tab. However, for
|
||||
character in front of it, other than a space or a tab. However, for
|
||||
the command line "'<,'>" (or any other marks) is ignored, as if the
|
||||
command line starts after it.
|
||||
|
||||
@ -1502,8 +1502,8 @@ be the user command ":Cc2" without an argument, or the command ":Cc" with
|
||||
argument "2". It is advised to put a space between the command name and the
|
||||
argument to avoid these problems.
|
||||
|
||||
When using a user-defined command, the command can be abbreviated. However, if
|
||||
an abbreviation is not unique, an error will be issued. Furthermore, a
|
||||
When using a user-defined command, the command can be abbreviated. However,
|
||||
if an abbreviation is not unique, an error will be issued. Furthermore, a
|
||||
built-in command will always take precedence.
|
||||
|
||||
Example: >
|
||||
@ -1519,8 +1519,8 @@ It is recommended that full names for user-defined commands are used in
|
||||
scripts.
|
||||
|
||||
:com[mand] *:com* *:command*
|
||||
List all user-defined commands. When listing commands,
|
||||
the characters in the first columns are:
|
||||
List all user-defined commands. When listing
|
||||
commands, the characters in the first columns are:
|
||||
! Command has the -bang attribute
|
||||
" Command has the -register attribute
|
||||
| Command has the -bar attribute
|
||||
@ -1535,7 +1535,7 @@ scripts.
|
||||
|
||||
*:command-verbose*
|
||||
When 'verbose' is non-zero, listing a command will also display where it was
|
||||
last defined and any completion argument. Example: >
|
||||
last defined and any completion argument. Example: >
|
||||
|
||||
:verbose command TOhtml
|
||||
< Name Args Range Complete Definition ~
|
||||
@ -1571,10 +1571,10 @@ See |:verbose-cmd| for more information.
|
||||
|
||||
Command attributes ~
|
||||
*command-attributes*
|
||||
User-defined commands are treated by Vim just like any other Ex commands. They
|
||||
can have arguments, or have a range specified. Arguments are subject to
|
||||
completion as filenames, buffers, etc. Exactly how this works depends upon the
|
||||
command's attributes, which are specified when the command is defined.
|
||||
User-defined commands are treated by Vim just like any other Ex commands.
|
||||
They can have arguments, or have a range specified. Arguments are subject to
|
||||
completion as filenames, buffers, etc. Exactly how this works depends upon
|
||||
the command's attributes, which are specified when the command is defined.
|
||||
|
||||
When defining a user command in a script, it will be able to call functions
|
||||
local to the script and use mappings local to the script. When the user
|
||||
@ -1659,7 +1659,7 @@ completion can be enabled:
|
||||
-complete=scriptnames sourced script names
|
||||
-complete=shellcmd Shell command
|
||||
-complete=shellcmdline First is a shell command and subsequent ones
|
||||
are filenames. The same behavior as |:!cmd|
|
||||
are filenames. The same behavior as |:!cmd|
|
||||
-complete=sign |:sign| suboptions
|
||||
-complete=syntax syntax file names 'syntax'
|
||||
-complete=syntime |:syntime| suboptions
|
||||
@ -1684,8 +1684,8 @@ function with the following signature: >
|
||||
|
||||
:function {func}(ArgLead, CmdLine, CursorPos)
|
||||
|
||||
The function need not use all these arguments. The function should provide the
|
||||
completion candidates as the return value.
|
||||
The function need not use all these arguments. The function should provide
|
||||
the completion candidates as the return value.
|
||||
|
||||
For the "custom" argument, the function should return the completion
|
||||
candidates one per line in a newline separated string.
|
||||
@ -1701,7 +1701,7 @@ The function arguments are:
|
||||
The function may use these for determining context. For the "custom"
|
||||
argument, it is not necessary to filter candidates against the (implicit
|
||||
pattern in) ArgLead. Vim will filter the candidates with its regexp engine
|
||||
after function return, and this is probably more efficient in most cases. If
|
||||
after function return, and this is probably more efficient in most cases. If
|
||||
'wildoptions' contains "fuzzy", then the candidates will be filtered using
|
||||
|fuzzy-matching|. For the "customlist" argument, Vim will not
|
||||
filter the returned completion candidates and the user supplied function
|
||||
@ -1833,8 +1833,8 @@ The valid escape sequences are
|
||||
command was executed with a ! modifier, otherwise
|
||||
expands to nothing.
|
||||
*<mods>* *<q-mods>* *:command-modifiers*
|
||||
<mods> The command modifiers, if specified. Otherwise, expands to
|
||||
nothing. Supported modifiers are |:aboveleft|, |:belowright|,
|
||||
<mods> The command modifiers, if specified. Otherwise, expands to
|
||||
nothing. Supported modifiers are |:aboveleft|, |:belowright|,
|
||||
|:botright|, |:browse|, |:confirm|, |:hide|, |:horizontal|,
|
||||
|:keepalt|, |:keepjumps|, |:keepmarks|, |:keeppatterns|,
|
||||
|:leftabove|, |:lockmarks|, |:noautocmd|, |:noswapfile|,
|
||||
@ -1943,9 +1943,9 @@ A more substantial example: >
|
||||
:endfunction
|
||||
:command -nargs=+ -complete=command Allargs call Allargs(<q-args>)
|
||||
|
||||
The command Allargs takes any Vim command(s) as argument and executes it on all
|
||||
files in the argument list. Usage example (note use of the "e" flag to ignore
|
||||
errors and the "update" command to write modified buffers): >
|
||||
The command Allargs takes any Vim command(s) as argument and executes it on
|
||||
all files in the argument list. Usage example (note use of the "e" flag to
|
||||
ignore errors and the "update" command to write modified buffers): >
|
||||
:Allargs %s/foo/bar/ge|update
|
||||
This will invoke: >
|
||||
:call Allargs("%s/foo/bar/ge|update")
|
||||
|
||||
Reference in New Issue
Block a user