diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index 674c034017..7dd0962c49 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -179,7 +179,7 @@ or . See |autocmd-buflocal|. *:autocmd-verbose* When 'verbose' is non-zero, listing an autocommand will also display where it -was last defined. Example: > +was last defined. Example: > :verbose autocmd BufEnter FileExplorer BufEnter @@ -439,7 +439,7 @@ ColorScheme After loading a color scheme. |:colorscheme| Not triggered if the color scheme is not found. The pattern is matched against the - colorscheme name. can be used for the + colorscheme name. can be used for the name of the actual file where this option was set, and for the new colorscheme name. @@ -772,13 +772,13 @@ MenuPopup Just before showing the popup menu (under the c Command line tl Terminal *ModeChanged* -ModeChanged After changing the mode. The pattern is +ModeChanged After changing the mode. The pattern is matched against `'old_mode:new_mode'`, for - example match against `*:c` to simulate + example match against `*:c*` to simulate |CmdlineEnter|. The following values of |v:event| are set: - old_mode The mode before it changed. - new_mode The new mode as also returned + old_mode The mode before it changed. + new_mode The new mode as also returned by |mode()| called with a non-zero argument. When ModeChanged is triggered, old_mode will @@ -834,7 +834,7 @@ OptionSet After setting an option (except during |v:option_oldlocal| is only set when |:set| or |:setlocal| or a |modeline| was used to set - the option. Similarly |v:option_oldglobal| is + the option. Similarly |v:option_oldglobal| is only set when |:set| or |:setglobal| was used. This does not set ||, you could use @@ -842,7 +842,7 @@ OptionSet After setting an option (except during Note that when setting a |global-local| option with |:set|, then |v:option_old| is the old - global value. However, for all options that + global value. However, for all options that are not global-local it is the old local value. @@ -852,7 +852,7 @@ OptionSet After setting an option (except during exist yet. Note: Do not reset the same option during this - autocommand, that may break plugins. You can + autocommand, that may break plugins. You can always use |:noautocmd| to prevent triggering OptionSet. @@ -885,7 +885,7 @@ QuickFixCmdPre Before a quickfix command is run (|:make|, *QuickFixCmdPost* QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix command is run, before jumping to the first - location. For |:cfile| and |:lfile| commands + location. For |:cfile| and |:lfile| commands it is run after the error file is read and before moving to the first error. See |QuickFixCmdPost-example|. @@ -1507,8 +1507,8 @@ option will not cause any commands to be executed. ** After applying the autocommands the modelines are processed, so that their settings overrule the - settings from autocommands when editing a file. This - is skipped if is specified. You probably + settings from autocommands when editing a file. This + is skipped if is specified. You probably want to use for events not used when loading a buffer, such as |User|. Modelines are also skipped when no matching @@ -1520,7 +1520,7 @@ option will not cause any commands to be executed. loaded buffer. The current buffer is done last. Note that [fname] is used to select the autocommands, - not the buffers to which they are applied. Example: > + not the buffers to which they are applied. Example: > augroup mine autocmd! autocmd FileType * echo expand('') diff --git a/runtime/doc/change.txt b/runtime/doc/change.txt index 7ebeb86331..4a2c3b7d7a 100644 --- a/runtime/doc/change.txt +++ b/runtime/doc/change.txt @@ -82,12 +82,12 @@ For inserting text see |insert.txt|. These commands delete text. You can repeat them with the `.` command (except `:d`) and undo them. Use Visual mode to delete blocks of text. See |registers| for an explanation of registers. - + *d-special* An exception for the d{motion} command: If the motion is not linewise, the start and end of the motion are not in the same line, and there are only blanks before the start and there are no non-blanks after the end of the motion, the delete becomes linewise. This means that the delete also removes -the line of blanks that you might expect to remain. Use the |o_v| operator to +the line of blanks that you might expect to remain. Use the |o_v| operator to force the motion to be charwise. Trying to delete an empty region of text (e.g., "d0" in the first column) @@ -366,7 +366,7 @@ CTRL-A Add [count] to the number or alphabetic character at *v_g_CTRL-A* {Visual}g CTRL-A Add [count] to the number or alphabetic character in - the highlighted text. If several lines are + the highlighted text. If several lines are highlighted, each one will be incremented by an additional [count] (so effectively creating a [count] incrementing sequence). @@ -392,7 +392,7 @@ CTRL-X Subtract [count] from the number or alphabetic *v_g_CTRL-X* {Visual}g CTRL-X Subtract [count] from the number or alphabetic - character in the highlighted text. If several lines + character in the highlighted text. If several lines are highlighted, each value will be decremented by an additional [count] (so effectively creating a [count] decrementing sequence). @@ -839,7 +839,7 @@ the |substitute()| function with the following exceptions: - magic is always set without regard to 'magic'. - A ~ inserts a tilde literally. - and \r inserts a carriage-return (CTRL-M). - - \ does not have a special meaning. It's just one of \x. + - \ does not have a special meaning. It's just one of \x. Examples: > :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx" @@ -851,7 +851,7 @@ Examples: > Note: "\L\u" can be used to capitalize the first letter of a word. This is not compatible with Vi and older versions of Vim, where the "\u" would cancel -out the "\L". Same for "\U\l". +out the "\L". Same for "\U\l". Note: In previous versions CTRL-V was handled in a special way. Since this is not Vi compatible, this was removed. Use a backslash instead. @@ -923,7 +923,7 @@ real character (which will be a NUL in the file). The "\=" notation can also be used inside the third argument {sub} of |substitute()| function. In this case, the special meaning for characters as -mentioned at |sub-replace-special| does not apply at all. Especially, and +mentioned at |sub-replace-special| does not apply at all. Especially, and are interpreted not as a line break but as a carriage-return and a new-line respectively. @@ -1128,9 +1128,9 @@ inside of strings can change! Also see 'softtabstop' option. > or 'a'. ["x]zp or *zp* *zP* -["x]zP Like "p" and "P", except without adding trailing spaces - when pasting a block. Thus the inserted text will not - always be a rectangle. Especially useful in +["x]zP Like "p" and "P", except without adding trailing + spaces when pasting a block. Thus the inserted text + will not always be a rectangle. Especially useful in combination with |v_zy|. You can use these commands to copy text from one place to another. Do this @@ -1165,7 +1165,7 @@ putting the register after the selection and then deleting the selection.) selection, or clipboard) to the previously-selected text. Useful if you want to put that text somewhere else. But you cannot repeat the same change. *v_P* -|P| in Visual mode puts text without setting the default register. You can +|P| in Visual mode puts text without setting the default register. You can repeat the change, but the deleted text cannot be used. If you do need it you can use |p| with another register. E.g., yank the text to copy, Visually select the text to replace and use "0p . You can repeat this as many times as @@ -1244,8 +1244,8 @@ text is less than one line (the small delete register is used then). An exception is made for the delete operator with these movement commands: |%|, |(|, |)|, |`|, |/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi compatible). The "- register is -used as well if the delete is within a line. Note that these characters may be -mapped. E.g. |%| is mapped by the matchit plugin. +used as well if the delete is within a line. Note that these characters may +be mapped. E.g. |%| is mapped by the matchit plugin. With each successive deletion or change, Vim shifts the previous contents of register 1 into register 2, 2 into 3, and so forth, losing the previous contents of register 9. @@ -1550,11 +1550,11 @@ type of comment string. A part consists of: e End of a three-piece comment - l Left align. Used together with 's' or 'e', the leftmost character of + l Left align. Used together with 's' or 'e', the leftmost character of start or end will line up with the leftmost character from the middle. - This is the default and can be omitted. See below for more details. + This is the default and can be omitted. See below for more details. - r Right align. Same as above but rightmost instead of leftmost. See + r Right align. Same as above but rightmost instead of leftmost. See below for more details. O Don't consider this comment for the "O" command. @@ -1566,8 +1566,8 @@ type of comment string. A part consists of: {digits} When together with 's' or 'e': add {digit} amount of offset to an - automatically inserted middle or end comment leader. The offset begins - from a left alignment. See below for more details. + automatically inserted middle or end comment leader. The offset + begins from a left alignment. See below for more details. -{digits} Like {digits} but reduce the indent. This only works when there is @@ -1606,18 +1606,18 @@ part which is longer, the end part is used. This makes a C style comment work without requiring the middle part to end with a space. Here is an example of alignment flags at work to make a comment stand out -(kind of looks like a 1 too). Consider comment string: >vim +(kind of looks like a 1 too). Consider comment string: >vim :set comments=sr:/***,m:**,ex-2:******/ > - /*** ~ - **<--right aligned from "r" flag ~ - ** ~ - offset 2 spaces for the "-2" flag-->** ~ - ******/ ~ + /*** + **<--right aligned from "r" flag + ** + offset 2 spaces for the "-2" flag-->** + ******/ In this case, the first comment was typed, then return was pressed 4 times, then "/" was pressed to end the comment. -Here are some finer points of three part comments. There are three times when +Here are some finer points of three part comments. There are three times when alignment and offset flags are taken into consideration: opening a new line after a start-comment, opening a new line before an end-comment, and automatically ending a three-piece comment. The end alignment flag has a @@ -1628,11 +1628,11 @@ will override the "r" and "l" flag. Enabling 'cindent' will override the alignment flags in many cases. Reindenting using a different method like |gq| or |=| will not consult -alignment flags either. The same behaviour can be defined in those other -formatting options. One consideration is that 'cindent' has additional options -for context based indenting of comments but cannot replicate many three piece -indent alignments. However, 'indentexpr' has the ability to work better with -three piece comments. +alignment flags either. The same behaviour can be defined in those other +formatting options. One consideration is that 'cindent' has additional +options for context based indenting of comments but cannot replicate many +three piece indent alignments. However, 'indentexpr' has the ability to work +better with three piece comments. Other examples: > "b:*" Includes lines starting with "*", but not if the "*" is @@ -1728,7 +1728,7 @@ B When joining lines, don't insert a space between two multibyte 1 Don't break a line after a one-letter word. It's broken before it instead (if possible). *fo-]* -] Respect 'textwidth' rigorously. With this flag set, no line can be +] Respect 'textwidth' rigorously. With this flag set, no line can be longer than 'textwidth', unless line-break-prohibition rules make this impossible. Mainly for CJK scripts and works only if 'encoding' is "utf-8". @@ -1764,8 +1764,8 @@ Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but does insert comment leaders according to the 'comments' option). An exception is when the 'a' flag is present. |auto-format| -Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping; -'textwidth' is still useful for formatting with "gq". +Note that 'textwidth' can be non-zero even if Vim never performs +auto-wrapping; 'textwidth' is still useful for formatting with "gq". If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some built in stuff to treat these types of comments a bit more cleverly. @@ -1852,8 +1852,8 @@ Also see |:uniq|. *:sort-l* With [l] sort uses the current collation locale. Implementation details: strcoll() is used to compare - strings. See |:language| to check or set the collation - locale. Example: > + strings. See |:language| to check or set the collation + locale. Example: > :language collate en_US.UTF-8 :%sort l < |v:collate| can also used to check the current locale. diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt index ff60c06434..7ddd472ef0 100644 --- a/runtime/doc/cmdline.txt +++ b/runtime/doc/cmdline.txt @@ -157,7 +157,8 @@ CTRL-R {register} *c_CTRL-R* *c_* the last delete or yank '%' the current file name '#' the alternate file name - "*" the clipboard contents (X11: primary selection) + "*" the clipboard contents (X11: primary + selection) '+' the clipboard contents '/' the last search pattern ':' the last command-line @@ -416,7 +417,8 @@ CTRL-D List names that match the pattern in front of the cursor. then go to the previous match. *c_CTRL-N* CTRL-N After using 'wildchar' which got multiple matches, go to next - match. Otherwise recall more recent command-line from history. + match. Otherwise recall more recent command-line from + history. *c_CTRL-P* CTRL-P After using 'wildchar' which got multiple matches, go to previous match. Otherwise recall older command-line from @@ -684,9 +686,9 @@ See also |`=|. *:_!* The '!' (bang) character after an Ex command makes the command behave in a -different way. The '!' should be placed immediately after the command, without -any blanks in between. If you insert blanks the '!' will be seen as an -argument for the command, which has a different meaning. For example: +different way. The '!' should be placed immediately after the command, +without any blanks in between. If you insert blanks the '!' will be seen as +an argument for the command, which has a different meaning. For example: :w! name write the current buffer to file "name", overwriting any existing file :w !name send the current buffer as standard input to command @@ -1024,8 +1026,10 @@ Note: these are typed literally, they are not special keys! *filename-modifiers* *:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs* *::S* *%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs* *%:S* -The file name modifiers can be used after "%", "#", "#n", "", "