diff options
Diffstat (limited to 'runtime/doc')
-rw-r--r-- | runtime/doc/autocmd.txt | 1 | ||||
-rw-r--r-- | runtime/doc/builtin.txt | 17 | ||||
-rw-r--r-- | runtime/doc/cmdline.txt | 1 | ||||
-rw-r--r-- | runtime/doc/eval.txt | 2 | ||||
-rw-r--r-- | runtime/doc/filetype.txt | 5 | ||||
-rw-r--r-- | runtime/doc/if_pyth.txt | 2 | ||||
-rw-r--r-- | runtime/doc/index.txt | 4 | ||||
-rw-r--r-- | runtime/doc/insert.txt | 6 | ||||
-rw-r--r-- | runtime/doc/map.txt | 27 | ||||
-rw-r--r-- | runtime/doc/options.txt | 16 | ||||
-rw-r--r-- | runtime/doc/pattern.txt | 16 | ||||
-rw-r--r-- | runtime/doc/pi_netrw.txt | 38 | ||||
-rw-r--r-- | runtime/doc/remote.txt | 2 | ||||
-rw-r--r-- | runtime/doc/repeat.txt | 20 | ||||
-rw-r--r-- | runtime/doc/sign.txt | 2 | ||||
-rw-r--r-- | runtime/doc/syntax.txt | 28 | ||||
-rw-r--r-- | runtime/doc/uganda.txt | 2 | ||||
-rw-r--r-- | runtime/doc/userfunc.txt | 7 | ||||
-rw-r--r-- | runtime/doc/usr_02.txt | 2 | ||||
-rw-r--r-- | runtime/doc/usr_05.txt | 2 | ||||
-rw-r--r-- | runtime/doc/usr_22.txt | 40 |
21 files changed, 142 insertions, 98 deletions
diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index 8cc4754880..89252145f2 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -380,6 +380,7 @@ CmdlineChanged After a change was made to the text inside CmdlineEnter After entering the command-line (including non-interactive use of ":" in a mapping: use |<Cmd>| instead to avoid this). + The pattern is matched against |cmdline-char|. <afile> expands to the |cmdline-char|. Sets these |v:event| keys: cmdlevel diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 2fc7dce7fc..60a1035da3 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -225,7 +225,7 @@ gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) gettagstack([{nr}]) Dict get the tag stack of window {nr} gettext({text}) String lookup translation of {text} getwininfo([{winid}]) List list of info about each window -getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window +getwinpos([{timeout}]) List X and Y coord in pixels of Vim window getwinposx() Number X coord in pixels of Vim window getwinposy() Number Y coord in pixels of Vim window getwinvar({nr}, {varname} [, {def}]) @@ -326,7 +326,7 @@ max({expr}) Number maximum value of items in {expr} menu_get({path} [, {modes}]) List description of |menus| matched by {path} menu_info({name} [, {mode}]) Dict get menu item information min({expr}) Number minimum value of items in {expr} -mkdir({name} [, {path} [, {prot}]]) +mkdir({name} [, {flags} [, {prot}]]) Number create directory {name} mode([expr]) String current editing mode msgpackdump({list} [, {type}]) List/Blob dump objects to msgpack @@ -5432,11 +5432,14 @@ min({expr}) Return the minimum value of all items in {expr}. Example: > mylist->min() < *mkdir()* *E739* -mkdir({name} [, {path} [, {prot}]]) +mkdir({name} [, {flags} [, {prot}]]) Create directory {name}. - If {path} is "p" then intermediate directories are created as - necessary. Otherwise it must be "". + When {flags} is present it must be a string. An empty string + has no effect. + + If {flags} is "p" then intermediate directories are created as + necessary. If {prot} is given it is used to set the protection bits of the new directory. The default is 0o755 (rwxr-xr-x: r/w for @@ -5449,7 +5452,7 @@ mkdir({name} [, {path} [, {prot}]]) < This function is not available in the |sandbox|. - If you try to create an existing directory with {path} set to + If you try to create an existing directory with {flags} set to "p" mkdir() will silently exit. The function result is a Number, which is TRUE if the call was @@ -6957,7 +6960,7 @@ setcellwidths({list}) *setcellwidths()* {width} must be either 1 or 2, indicating the character width in screen cells. *E1112* An error is given if the argument is invalid, also when a - range overlaps with another. *E1113* + range overlaps with another. *E1113* If the new value causes 'fillchars' or 'listchars' to become invalid it is rejected and an error is given. diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt index e0c4e14b01..844aab6fa3 100644 --- a/runtime/doc/cmdline.txt +++ b/runtime/doc/cmdline.txt @@ -584,6 +584,7 @@ followed by another Vim command: :registers :read ! :sign + :tabdo :terminal :vglobal :windo diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 49d4546f95..af67e2b67d 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -1445,7 +1445,7 @@ See below |functions|. ------------------------------------------------------------------------------ lambda expression *expr-lambda* *lambda* -{args -> expr1} lambda expression +{args -> expr1} lambda expression *E451* A lambda expression creates a new unnamed function which returns the result of evaluating |expr1|. Lambda expressions differ from |user-function|s in diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt index a53c287d48..f69ffeabfe 100644 --- a/runtime/doc/filetype.txt +++ b/runtime/doc/filetype.txt @@ -634,7 +634,10 @@ MARKDOWN *ft-markdown-plugin* To enable folding use this: > let g:markdown_folding = 1 -< + +'expandtab' will be set by default. If you do not want that use this: > + let g:markdown_recommended_style = 0 + PDF *ft-pdf-plugin* diff --git a/runtime/doc/if_pyth.txt b/runtime/doc/if_pyth.txt index 4c184ddf94..45accc2e03 100644 --- a/runtime/doc/if_pyth.txt +++ b/runtime/doc/if_pyth.txt @@ -629,7 +629,7 @@ You can test if Python is available with: >vim if has('pythonx') echo 'there is Python' endif - if has('python3') + if has('python3') echo 'there is Python 3.x' endif diff --git a/runtime/doc/index.txt b/runtime/doc/index.txt index a6aa036b55..174683a8c3 100644 --- a/runtime/doc/index.txt +++ b/runtime/doc/index.txt @@ -220,7 +220,7 @@ tag char note action in Normal mode ~ |CTRL-\_CTRL-N| CTRL-\ CTRL-N go to Normal mode (no-op) |CTRL-\_CTRL-G| CTRL-\ CTRL-G go to Normal mode (no-op) CTRL-\ a - z reserved for extensions - CTRL-\ others not used + CTRL-\ others not used |CTRL-]| CTRL-] :ta to ident under cursor |CTRL-^| CTRL-^ edit Nth alternate file (equivalent to ":e #N") @@ -233,7 +233,7 @@ tag char note action in Normal mode ~ 2 filter Nmove text through the {filter} command |!!| !!{filter} 2 filter N lines through the {filter} command -|quote| "{register} use {register} for next delete, yank or put +|quote| "{register} use {register} for next delete, yank or put ({.%#:} only work with put) |#| # 1 search backward for the Nth occurrence of the ident under the cursor diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index e608b431f2..84aee43af4 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -1101,8 +1101,8 @@ cursor column will be replaced with the matches. If the returned value is larger than the cursor column, the cursor column is used. Negative return values: - -2 To cancel silently and stay in completion mode. - -3 To cancel silently and leave completion mode. + -2 To cancel silently and stay in completion mode. + -3 To cancel silently and leave completion mode. Another negative value: completion starts at the cursor column On the second invocation the arguments are: @@ -1154,7 +1154,7 @@ items: item with the same word is already present. empty when non-zero this match will be added even when it is an empty string - user_data custom data which is associated with the item and + user_data custom data which is associated with the item and available in |v:completed_item|; it can be any type; defaults to an empty string diff --git a/runtime/doc/map.txt b/runtime/doc/map.txt index cb8b162eb6..ad0570e9f7 100644 --- a/runtime/doc/map.txt +++ b/runtime/doc/map.txt @@ -764,7 +764,7 @@ option). After that it assumes that the 'q' is to be interpreted as such. If you type slowly, or your system is slow, reset the 'timeout' option. Then you might want to set the 'ttimeout' option. - *map-precedence* + *map-precedence* Buffer-local mappings (defined using |:map-<buffer>|) take precedence over global mappings. When a buffer-local mapping is the same as a global mapping, Vim will use the buffer-local mapping. In addition, Vim will use a complete @@ -838,6 +838,11 @@ in the original Vi, you would get back the text before the first undo). 1.10 MAPPING ALT-KEYS *:map-alt-keys* +For a readable mapping command the <A-k> form can be used. Note that <A-k> +and <A-K> are different, the latter will use an upper case letter. Actually, +<A-K> and <A-S-K> are the same. Instead of "A" you can use "M". If you have +an actual Meta modifier key, please see |:map-meta-keys|. + In the GUI Nvim handles the |ALT| key itself, thus mapping keys with ALT should always work. But in a terminal Nvim gets a sequence of bytes and has to figure out whether ALT was pressed. Terminals may use ESC to indicate that @@ -847,7 +852,21 @@ milliseconds, the ESC is interpreted as: otherwise it is interpreted as two key presses: <ESC> {key} -1.11 MAPPING AN OPERATOR *:map-operator* +1.11 MAPPING META-KEYS *:map-meta-keys* + +Mapping keys with the Meta modifier works very similar to using the Alt key. +What key on your keyboard produces the Meta modifier depends on your keyboard +and configuration. + +Note that mapping <M-a> actually is for using the Alt key. That can be +confusing! It cannot be changed, it would not be backwards compatible. + +For the Meta modifier the "T" character is used. For example, to map Meta-b +in Insert mode: > + :imap <T-b> terrible + + +1.12 MAPPING AN OPERATOR *:map-operator* An operator is used before a {motion} command. To define your own operator you must create a mapping that first sets the 'operatorfunc' option and then @@ -984,7 +1003,7 @@ non-id The "non-id" type ends in a non-keyword character, the other Examples of strings that cannot be abbreviations: "a.b", "#def", "a b", "_$r" An abbreviation is only recognized when you type a non-keyword character. -This can also be the <Esc> that ends insert mode or the <CR> that ends a +This can also be the <Esc> that ends Insert mode or the <CR> that ends a command. The non-keyword character which ends the abbreviation is inserted after the expanded abbreviation. An exception to this is the character <C-]>, which is used to expand an abbreviation without inserting any extra @@ -1484,7 +1503,7 @@ which by default correspond to the current line, last line and the whole buffer, relate to arguments, (loaded) buffers, windows or tab pages. Possible values are (second column is the short name used in listing): - -addr=lines Range of lines (this is the default for -range) + -addr=lines Range of lines (this is the default for -range) -addr=arguments arg Range for arguments -addr=buffers buf Range for buffers (also not loaded buffers) -addr=loaded_buffers load Range for loaded buffers diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index e4106358f1..d13ab8c393 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1186,7 +1186,7 @@ A jump table for the options with a short description can be found at |Q_op|. case mapping, the current locale is not effective. This probably only matters for Turkish. - *'cdhome'* *'cdh'* + *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'* 'cdhome' 'cdh' boolean (default: off) global When on, |:cd|, |:tcd| and |:lcd| without an argument changes the @@ -4291,7 +4291,7 @@ A jump table for the options with a short description can be found at |Q_op|. The 'mousemodel' option is set by the |:behave| command. - *'mousemoveevent'* *'mousemev'* + *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'* 'mousemoveevent' 'mousemev' boolean (default off) global When on, mouse move events are delivered to the input queue and are @@ -5550,7 +5550,7 @@ A jump table for the options with a short description can be found at |Q_op|. A don't give the "ATTENTION" message when an existing *shm-A* swap file is found I don't give the intro message when starting Vim, *shm-I* - see |:intro| + see |:intro| c don't give |ins-completion-menu| messages; for *shm-c* example, "-- XXX completion (YYY)", "match 1 of 2", "The only match", "Pattern not found", "Back at original", etc. @@ -5559,8 +5559,8 @@ A jump table for the options with a short description can be found at |Q_op|. q use "recording" instead of "recording @a" *shm-q* F don't give the file info when editing a file, like *shm-F* `:silent` was used for the command - S do not show search count message when searching, e.g. *shm-S* - "[1/5]" + S do not show search count message when searching, e.g. *shm-S* + "[1/5]" This gives you the opportunity to avoid that a change between buffers requires you to hit <Enter>, but still gives as useful a message as @@ -5709,7 +5709,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'signcolumn' 'scl' string (default "auto") local to window When and how to draw the signcolumn. Valid values are: - "auto" only when there is a sign to display + "auto" only when there is a sign to display "auto:[1-9]" resize to accommodate multiple signs up to the given number (maximum 9), e.g. "auto:4" "auto:[1-8]-[2-9]" @@ -5718,8 +5718,8 @@ A jump table for the options with a short description can be found at |Q_op|. at least the given minimum (maximum 8) fixed space. The minimum number should always be less than the maximum number, e.g. "auto:2-5" - "no" never - "yes" always + "no" never + "yes" always "yes:[1-9]" always, with fixed space for signs up to the given number (maximum 9), e.g. "yes:3" "number" display signs in the 'number' column. If the number diff --git a/runtime/doc/pattern.txt b/runtime/doc/pattern.txt index 5357aaa3f1..625e1f95e1 100644 --- a/runtime/doc/pattern.txt +++ b/runtime/doc/pattern.txt @@ -97,6 +97,8 @@ g# Like "#", but don't put "\<" and "\>" around the word. *gd* gd Goto local Declaration. When the cursor is on a local variable, this command will jump to its declaration. + This was made to work for C code, in other languages + it may not work well. First Vim searches for the start of the current function, just like "[[". If it is not found the search stops in line 1. If it is found, Vim goes back @@ -1129,21 +1131,21 @@ x A single character, with no special meaning, matches itself are supported: Name Func Contents ~ *[:alnum:]* [:alnum:] isalnum ASCII letters and digits -*[:alpha:]* [:alpha:] isalpha ASCII letters -*[:blank:]* [:blank:] space and tab -*[:cntrl:]* [:cntrl:] iscntrl ASCII control characters -*[:digit:]* [:digit:] decimal digits '0' to '9' +*[:alpha:]* [:alpha:] isalpha ASCII letters +*[:blank:]* [:blank:] space and tab +*[:cntrl:]* [:cntrl:] iscntrl ASCII control characters +*[:digit:]* [:digit:] decimal digits '0' to '9' *[:graph:]* [:graph:] isgraph ASCII printable characters excluding space *[:lower:]* [:lower:] (1) lowercase letters (all letters when 'ignorecase' is used) -*[:print:]* [:print:] (2) printable characters including space +*[:print:]* [:print:] (2) printable characters including space *[:punct:]* [:punct:] ispunct ASCII punctuation characters -*[:space:]* [:space:] whitespace characters: space, tab, CR, +*[:space:]* [:space:] whitespace characters: space, tab, CR, NL, vertical tab, form feed *[:upper:]* [:upper:] (3) uppercase letters (all letters when 'ignorecase' is used) -*[:xdigit:]* [:xdigit:] hexadecimal digits: 0-9, a-f, A-F +*[:xdigit:]* [:xdigit:] hexadecimal digits: 0-9, a-f, A-F *[:return:]* [:return:] the <CR> character *[:tab:]* [:tab:] the <Tab> character *[:escape:]* [:escape:] the <Esc> character diff --git a/runtime/doc/pi_netrw.txt b/runtime/doc/pi_netrw.txt index 5167b4baf7..d3d5e4605a 100644 --- a/runtime/doc/pi_netrw.txt +++ b/runtime/doc/pi_netrw.txt @@ -1085,8 +1085,8 @@ QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2 <c-tab> Shrink/expand a netrw/explore window |netrw-c-tab| - Makes Netrw go up one directory |netrw--| a Cycles between normal display, |netrw-a| - hiding (suppress display of files matching g:netrw_list_hide) - and showing (display only files which match g:netrw_list_hide) + hiding (suppress display of files matching g:netrw_list_hide) + and showing (display only files which match g:netrw_list_hide) cd Make browsing directory the current directory |netrw-cd| C Setting the editing window |netrw-C| d Make a directory |netrw-d| @@ -1118,7 +1118,7 @@ QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2 mX Apply arbitrary shell command to marked files en bloc|netrw-mX| mz Compress/decompress marked files |netrw-mz| o Enter the file/directory under the cursor in a new |netrw-o| - browser window. A horizontal split is used. + browser window. A horizontal split is used. O Obtain a file specified by cursor |netrw-O| p Preview the file |netrw-p| P Browse in the previously used window |netrw-P| @@ -1134,7 +1134,7 @@ QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2 u Change to recently-visited directory |netrw-u| U Change to subsequently-visited directory |netrw-U| v Enter the file/directory under the cursor in a new |netrw-v| - browser window. A vertical split is used. + browser window. A vertical split is used. x View file with an associated program |netrw-x| X Execute filename under cursor via |system()| |netrw-X| @@ -2271,7 +2271,7 @@ Example: ... -MARKED FILES, ARBITRARY SHELL COMMAND, EN BLOC *netrw-mX* {{{2 +MARKED FILES, ARBITRARY SHELL COMMAND, EN BLOC *netrw-mX* {{{2 (See |netrw-mf| and |netrw-mr| for how to mark files) (uses the global marked-file list) @@ -2611,7 +2611,7 @@ your browsing preferences. (see also: |netrw-settings|) Used to change access permission for a file. *g:netrw_clipboard* =1 - By default, netrw will attempt to insure that + By default, netrw will attempt to insure that the clipboard's values will remain unchanged. However, some users report that they have speed problems with this; consequently, this @@ -2759,7 +2759,7 @@ your browsing preferences. (see also: |netrw-settings|) escaped before applying glob() *g:netrw_gx* ="<cfile>" - This option controls how gx (|netrw-gx|) picks + This option controls how gx (|netrw-gx|) picks up the text under the cursor. See |expand()| for possibilities. @@ -2824,11 +2824,11 @@ your browsing preferences. (see also: |netrw-settings|) directory (|netrw-mt|, |netrw-mc|) *g:netrw_localcopycmdopt* ='' Linux/Unix/MacOS/Cygwin - =' \c copy' Windows + =' \c copy' Windows Options for the |g:netrw_localcopycmd| *g:netrw_localcopydircmd* ="cp" Linux/Unix/MacOS/Cygwin - =expand("$COMSPEC") Windows + =expand("$COMSPEC") Windows Copies directories to target directory. (|netrw-mc|, |netrw-mt|) @@ -2854,7 +2854,7 @@ your browsing preferences. (see also: |netrw-settings|) Options for |g:netrw_localmovecmd| *g:netrw_localrmdir* ="rmdir" Linux/Unix/MacOS/Cygwin - =expand("$COMSPEC") Windows + =expand("$COMSPEC") Windows Remove directory command (rmdir) This variable is only used if your vim is earlier than 7.4 or if your vim doesn't @@ -2890,10 +2890,10 @@ your browsing preferences. (see also: |netrw-settings|) (see |'ballooneval'|) *g:netrw_sizestyle* not defined: actual bytes (default) - ="b" : actual bytes (default) - ="h" : human-readable (ex. 5k, 4m, 3g) + ="b" : actual bytes (default) + ="h" : human-readable (ex. 5k, 4m, 3g) uses 1000 base - ="H" : human-readable (ex. 5K, 4M, 3G) + ="H" : human-readable (ex. 5K, 4M, 3G) uses 1024 base The long listing (|netrw-i|) and query-file maps (|netrw-qf|) will display file size @@ -2941,7 +2941,7 @@ your browsing preferences. (see also: |netrw-settings|) default: "NETRWSERVER" *g:netrw_sort_by* sort by "name", "time", "size", or - "exten". + "exten". default: "name" *g:netrw_sort_direction* sorting direction: "normal" or "reverse" @@ -2998,7 +2998,7 @@ your browsing preferences. (see also: |netrw-settings|) .vim/after/syntax/netrw.vim. < The netrwGray highlighting is set up by netrw when > - * netrwGray has not been previously + * netrwGray has not been previously defined * the gui is running < As an example, I myself use a dark-background @@ -3256,7 +3256,7 @@ If there are marked files: (see |netrw-mf|) name, applying that substitute, and renaming each file to the result. As an example : > - mr [query: reply with *.c] + mr [query: reply with *.c] R [query: reply with s/^\(.*\)\.c$/\1.cpp/] < This example will mark all "*.c" files and then rename them to "*.cpp" @@ -3265,7 +3265,7 @@ If there are marked files: (see |netrw-mf|) The ctrl-X character has special meaning for renaming files: > - <c-x> : a single ctrl-x tells netrw to ignore the portion of the response + <c-x> : a single ctrl-x tells netrw to ignore the portion of the response lying between the last '/' and the ctrl-x. <c-x><c-x> : a pair of contiguous ctrl-x's tells netrw to ignore any @@ -3833,7 +3833,7 @@ netrw: Decho.vim is provided as a "vimball". You should edit the Decho.vba.gz file and source it in: > - vim Decho.vba.gz + vim Decho.vba.gz :so % :q < @@ -3875,7 +3875,7 @@ netrw: To save the file: under linux, the output will be in a separate remote server window; in it, just save the file with > - :w! DBG + :w! DBG < Under a vim that doesn't support clientserver, your debugging output will appear in another tab: > diff --git a/runtime/doc/remote.txt b/runtime/doc/remote.txt index 4610088ab0..804645f774 100644 --- a/runtime/doc/remote.txt +++ b/runtime/doc/remote.txt @@ -46,7 +46,7 @@ The following command line arguments are available: new tabpage. *--remote-send* --remote-send {keys} Send {keys} to server and exit. The {keys} - are not mapped. Special key names are + are not mapped. Special key names are recognized, e.g., "<CR>" results in a CR character. *--remote-expr* diff --git a/runtime/doc/repeat.txt b/runtime/doc/repeat.txt index bf77aacdc0..23030761dd 100644 --- a/runtime/doc/repeat.txt +++ b/runtime/doc/repeat.txt @@ -214,7 +214,7 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|. When [where] is omitted only 'runtimepath' is used. Other values: START search only under "start" in 'packpath' - OPT search only under "opt" in 'packpath' + OPT search only under "opt" in 'packpath' PACK search under "start" and "opt" in 'packpath' ALL first use 'runtimepath', then search @@ -641,15 +641,15 @@ up-to-date easily, but it requires a program like "git" to be available. You can do both, github can automatically create an archive for a release. Your directory layout would be like this: - start/foobar/plugin/foo.vim " always loaded, defines commands - start/foobar/plugin/bar.vim " always loaded, defines commands - start/foobar/autoload/foo.vim " loaded when foo command used - start/foobar/doc/foo.txt " help for foo.vim - start/foobar/doc/tags " help tags - opt/fooextra/plugin/extra.vim " optional plugin, defines commands - opt/fooextra/autoload/extra.vim " loaded when extra command used - opt/fooextra/doc/extra.txt " help for extra.vim - opt/fooextra/doc/tags " help tags + start/foobar/plugin/foo.vim " always loaded, defines commands + start/foobar/plugin/bar.vim " always loaded, defines commands + start/foobar/autoload/foo.vim " loaded when foo command used + start/foobar/doc/foo.txt " help for foo.vim + start/foobar/doc/tags " help tags + opt/fooextra/plugin/extra.vim " optional plugin, defines commands + opt/fooextra/autoload/extra.vim " loaded when extra command used + opt/fooextra/doc/extra.txt " help for extra.vim + opt/fooextra/doc/tags " help tags This allows for the user to do: > mkdir ~/.local/share/nvim/site/pack diff --git a/runtime/doc/sign.txt b/runtime/doc/sign.txt index d09d0f226f..53ef03eb63 100644 --- a/runtime/doc/sign.txt +++ b/runtime/doc/sign.txt @@ -610,7 +610,7 @@ sign_placelist({list}) be placed. For the accepted values, see |line()|. name name of the sign to place. See |sign_define()| - for more information. + for more information. priority priority of the sign. When multiple signs are placed on a line, the sign with the highest priority is used. If not specified, the diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt index bd5a4f1926..7102e93f0a 100644 --- a/runtime/doc/syntax.txt +++ b/runtime/doc/syntax.txt @@ -1271,18 +1271,32 @@ When not set 4 is used. DOSBATCH *dosbatch.vim* *ft-dosbatch-syntax* -There is one option with highlighting DOS batch files. This covers new -extensions to the Command Interpreter introduced with Windows 2000 and -is controlled by the variable dosbatch_cmdextversion. For Windows NT -this should have the value 1, and for Windows 2000 it should be 2. +Select the set of Windows Command interpreter extensions that should be +supported with the variable dosbatch_cmdextversion. For versions of Windows +NT (before Windows 2000) this should have the value of 1. For Windows 2000 +and later it should be 2. Select the version you want with the following line: > :let dosbatch_cmdextversion = 1 If this variable is not defined it defaults to a value of 2 to support -Windows 2000. +Windows 2000 and later. -A second option covers whether *.btm files should be detected as type +The original MS-DOS supports an idiom of using a double colon (::) as an +alternative way to enter a comment line. This idiom can be used with the +current Windows Command Interpreter, but it can lead to problems when used +inside ( ... ) command blocks. You can find a discussion about this on +Stack Overflow - + +https://stackoverflow.com/questions/12407800/which-comment-style-should-i-use-in-batch-files + +To allow the use of the :: idiom for comments in the Windows Command +Interpreter or working with MS-DOS bat files, set the +dosbatch_colons_comment variable to anything: > + + :let dosbatch_colons_comment = 1 + +There is an option that covers whether *.btm files should be detected as type "dosbatch" (MS-DOS batch files) or type "btm" (4DOS batch files). The latter is used by default. You may select the former with the following line: > @@ -3784,7 +3798,7 @@ SYNTAX ISKEYWORD SETTING *:syn-iskeyword* clear: Syntax specific iskeyword setting is disabled and the buffer-local 'iskeyword' setting is used. - {option} Set the syntax 'iskeyword' option to a new value. + {option} Set the syntax 'iskeyword' option to a new value. Example: > :syntax iskeyword @,48-57,192-255,$,_ diff --git a/runtime/doc/uganda.txt b/runtime/doc/uganda.txt index d8fc26ad17..fc38f5b73c 100644 --- a/runtime/doc/uganda.txt +++ b/runtime/doc/uganda.txt @@ -246,7 +246,7 @@ Credit Card: You can use PayPal to send money with a Credit card. This is Bram@iccf-holland.org Others: Transfer to this account if possible: - ING bank: IBAN: NL95 INGB 0004 5487 74 + ING bank: IBAN: NL95 INGB 0004 5487 74 Swift code: INGBNL2A under the name "stichting ICCF Holland", Amersfoort Checks are not accepted. diff --git a/runtime/doc/userfunc.txt b/runtime/doc/userfunc.txt index 9c428175bb..ce6f2fc2e9 100644 --- a/runtime/doc/userfunc.txt +++ b/runtime/doc/userfunc.txt @@ -234,9 +234,10 @@ Example: > call Something('key', 20) "key: 20" The argument default expressions are evaluated at the time of the function -call, not definition. Thus it is possible to use an expression which is -invalid the moment the function is defined. The expressions are also only -evaluated when arguments are not specified during a call. +call, not when the function is defined. Thus it is possible to use an +expression which is invalid the moment the function is defined. The +expressions are also only evaluated when arguments are not specified during a +call. *E989* Optional arguments with default expressions must occur after any mandatory diff --git a/runtime/doc/usr_02.txt b/runtime/doc/usr_02.txt index 11afe39742..259bb41200 100644 --- a/runtime/doc/usr_02.txt +++ b/runtime/doc/usr_02.txt @@ -495,7 +495,7 @@ You can use the error ID at the start to find help about it: > :help E37 -Summary: *help-summary* > +Summary: *help-summary* > 1) Use Ctrl-D after typing a topic and let Vim show all available topics. Or press Tab to complete: > diff --git a/runtime/doc/usr_05.txt b/runtime/doc/usr_05.txt index 24d6185eae..d8fb2acedb 100644 --- a/runtime/doc/usr_05.txt +++ b/runtime/doc/usr_05.txt @@ -273,7 +273,7 @@ an archive or as a repository. For an archive you can follow these steps: package. 2. unpack the archive in that directory. This assumes the top directory in the archive is "start": > - cd ~/.local/share/nvim/site/pack/fancy + cd ~/.local/share/nvim/site/pack/fancy unzip /tmp/fancy.zip < If the archive layout is different make sure that you end up with a path like this: diff --git a/runtime/doc/usr_22.txt b/runtime/doc/usr_22.txt index 539bda3980..d977b20ecc 100644 --- a/runtime/doc/usr_22.txt +++ b/runtime/doc/usr_22.txt @@ -77,25 +77,25 @@ browser. This is what you get: > 9. Directory Browsing netrw-browse netrw-dir netrw-list netrw-help MAPS netrw-maps - <F1>.............Help.......................................|netrw-help| - <cr>.............Browsing...................................|netrw-cr| - <del>............Deleting Files or Directories..............|netrw-delete| - -................Going Up...................................|netrw--| - a................Hiding Files or Directories................|netrw-a| - mb...............Bookmarking a Directory....................|netrw-mb| - gb...............Changing to a Bookmarked Directory.........|netrw-gb| - cd...............Make Browsing Directory The Current Dir....|netrw-c| - d................Make A New Directory.......................|netrw-d| - D................Deleting Files or Directories..............|netrw-D| - <c-h>............Edit File/Directory Hiding List............|netrw-ctrl-h| - i................Change Listing Style.......................|netrw-i| - <c-l>............Refreshing the Listing.....................|netrw-ctrl-l| - o................Browsing with a Horizontal Split...........|netrw-o| - p................Use Preview Window.........................|netrw-p| - P................Edit in Previous Window....................|netrw-p| - q................Listing Bookmarks and History..............|netrw-qb| - r................Reversing Sorting Order....................|netrw-r| -< (etc) + <F1>.............Help.......................................|netrw-help| + <cr>.............Browsing...................................|netrw-cr| + <del>............Deleting Files or Directories..............|netrw-delete| + -................Going Up...................................|netrw--| + a................Hiding Files or Directories................|netrw-a| + mb...............Bookmarking a Directory....................|netrw-mb| + gb...............Changing to a Bookmarked Directory.........|netrw-gb| + cd...............Make Browsing Directory The Current Dir....|netrw-c| + d................Make A New Directory.......................|netrw-d| + D................Deleting Files or Directories..............|netrw-D| + <c-h>............Edit File/Directory Hiding List............|netrw-ctrl-h| + i................Change Listing Style.......................|netrw-i| + <c-l>............Refreshing the Listing.....................|netrw-ctrl-l| + o................Browsing with a Horizontal Split...........|netrw-o| + p................Use Preview Window.........................|netrw-p| + P................Edit in Previous Window....................|netrw-p| + q................Listing Bookmarks and History..............|netrw-qb| + r................Reversing Sorting Order....................|netrw-r| +< (etc) The <F1> key thus brings you to a netrw directory browsing contents help page. It's a regular help page; use the usual |CTRL-]| to jump to tagged help items @@ -106,7 +106,7 @@ To select files for display and editing: (with the cursor is atop a filename) <enter> Open the file in the current window. |netrw-cr| o Horizontally split window and display file |netrw-o| v Vertically split window and display file |netrw-v| - p Use the |preview-window| |netrw-p| + p Use the |preview-window| |netrw-p| P Edit in the previous window |netrw-P| t Open file in a new tab |netrw-t| |