diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2017-11-07 18:59:39 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-11-07 18:59:39 +0100 |
commit | ae569ea57b1df1b450803b6d23ab8c315dd72e72 (patch) | |
tree | 89cded2580f6e52dc9bb8b1394184b10c696547f /runtime/doc | |
parent | 06fd32b8ffc437d596a2d82a986220add4315869 (diff) | |
parent | 8c3377ee76e5cc4f5a4228f216bde1d03b496d69 (diff) | |
download | rneovim-ae569ea57b1df1b450803b6d23ab8c315dd72e72.tar.gz rneovim-ae569ea57b1df1b450803b6d23ab8c315dd72e72.tar.bz2 rneovim-ae569ea57b1df1b450803b6d23ab8c315dd72e72.zip |
Merge #7500 'vim-patch: runtime'
Diffstat (limited to 'runtime/doc')
-rw-r--r-- | runtime/doc/editing.txt | 3 | ||||
-rw-r--r-- | runtime/doc/eval.txt | 5 | ||||
-rw-r--r-- | runtime/doc/ft_rust.txt | 6 | ||||
-rw-r--r-- | runtime/doc/gui.txt | 3 | ||||
-rw-r--r-- | runtime/doc/intro.txt | 15 | ||||
-rw-r--r-- | runtime/doc/options.txt | 7 | ||||
-rw-r--r-- | runtime/doc/remote.txt | 2 | ||||
-rw-r--r-- | runtime/doc/syntax.txt | 10 | ||||
-rw-r--r-- | runtime/doc/usr_03.txt | 4 | ||||
-rw-r--r-- | runtime/doc/usr_07.txt | 2 | ||||
-rw-r--r-- | runtime/doc/usr_08.txt | 2 | ||||
-rw-r--r-- | runtime/doc/usr_09.txt | 4 | ||||
-rw-r--r-- | runtime/doc/usr_12.txt | 2 | ||||
-rw-r--r-- | runtime/doc/windows.txt | 10 |
14 files changed, 51 insertions, 24 deletions
diff --git a/runtime/doc/editing.txt b/runtime/doc/editing.txt index c478ad1bf3..1b9a1b38fb 100644 --- a/runtime/doc/editing.txt +++ b/runtime/doc/editing.txt @@ -1032,6 +1032,7 @@ The names can be in upper- or lowercase. window in the current tab page the current tab page is closed |tab-page|. Triggers the |QuitPre| autocommand event. + See |CTRL-W_q| for quitting another window. :conf[irm] q[uit] Quit, but give prompt when changes have been made, or the last file in the argument list has not been @@ -1541,7 +1542,7 @@ There are three different types of searching: This searches the same directories, but in a different order. Note that completion for ":find", ":sfind", and ":tabfind" commands do not - currently work with 'path' items that contain a url or use the double star + currently work with 'path' items that contain a URL or use the double star with depth limiter (/usr/**2) or upward search (;) notations. vim:tw=78:ts=8:ft=help:norl: diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 8ef26d28c5..6743ed4812 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -2119,7 +2119,8 @@ index({list}, {expr} [, {start} [, {ic}]]) Number index in {list} where {expr} appears input({prompt} [, {text} [, {completion}]]) String get input from the user -inputdialog({p} [, {t} [, {c}]]) String like input() but in a GUI dialog +inputdialog({prompt} [, {text} [, {completion}]]) + String like input() but in a GUI dialog inputlist({textlist}) Number let the user pick from a choice list inputrestore() Number restore typeahead inputsave() Number save and clear typeahead @@ -5659,7 +5660,6 @@ mode([expr]) Return a string that indicates the current mode. i Insert R Replace |R| Rv Virtual Replace |gR| - t Terminal c Command-line cv Vim Ex mode |gQ| ce Normal Ex mode |Q| @@ -5667,6 +5667,7 @@ mode([expr]) Return a string that indicates the current mode. rm The -- more -- prompt r? A |:confirm| query of some sort ! Shell or external command is executing + t Terminal mode: keys go to the job This is useful in the 'statusline' option or when used with |remote_expr()| In most other places it always returns "c" or "n". diff --git a/runtime/doc/ft_rust.txt b/runtime/doc/ft_rust.txt index c2e21e40bb..71e3027ceb 100644 --- a/runtime/doc/ft_rust.txt +++ b/runtime/doc/ft_rust.txt @@ -116,13 +116,13 @@ g:rustfmt_options~ *g:rust_playpen_url* g:rust_playpen_url~ - Set this option to override the url for the playpen to use: > + Set this option to override the URL for the playpen to use: > let g:rust_playpen_url = 'https://play.rust-lang.org/' < *g:rust_shortener_url* g:rust_shortener_url~ - Set this option to override the url for the url shortener: > + Set this option to override the URL for the URL shortener: > let g:rust_shortener_url = 'https://is.gd/' < @@ -199,7 +199,7 @@ COMMANDS *rust-commands* |g:rust_playpen_url| is the base URL to the playpen, by default "https://play.rust-lang.org/". - |g:rust_shortener_url| is the base url for the shorterner, by + |g:rust_shortener_url| is the base URL for the shorterner, by default "https://is.gd/" :RustFmt *:RustFmt* diff --git a/runtime/doc/gui.txt b/runtime/doc/gui.txt index fb05f178ad..b92b363efa 100644 --- a/runtime/doc/gui.txt +++ b/runtime/doc/gui.txt @@ -46,7 +46,8 @@ When the GUI starts up initializations are carried out, in this order: already set. NOTE: All but the first one are not carried out if Vim was started with -"-u NONE" and no "-U" argument was given, or when started with "-U NONE". +"-u NONE" or "-u DEFAULTS" and no "-U" argument was given, or when started +with "-U NONE". All this happens AFTER the normal Vim initializations, like reading your vimrc file. See |initialization|. diff --git a/runtime/doc/intro.txt b/runtime/doc/intro.txt index 93cc8be41f..7760df01e9 100644 --- a/runtime/doc/intro.txt +++ b/runtime/doc/intro.txt @@ -120,9 +120,14 @@ Report bugs on GitHub: https://github.com/neovim/neovim/issues Please be brief; all the time that is spent on answering mail is subtracted from the time that is spent on improving Vim! Always give a reproducible -example and try to find out which settings or other things influence the -appearance of the bug. Try different machines, if possible. Send me patches -if you can! +example and try to find out which settings or other things trigger the bug. + +Preferably start Vim with: > + vim --clean -u reproduce.vim +Where reproduce.vim is a script that reproduces the problem. Try different +machines, if relevant (is this an MS-Windows specific bug perhaps?). + +Send me patches if you can! It will help to include information about the version of Vim you are using and your setup. You can get the information with this command: > @@ -782,10 +787,12 @@ by Vim. ============================================================================== 8. Definitions *definitions* + buffer Contains lines of text, usually read from a file. screen The whole area that Vim uses to work in. This can be a terminal emulator window. Also called "the Vim window". - window A view on a buffer. + window A view on a buffer. There can be multiple windows for + one buffer. A screen contains one or more windows, separated by status lines and with the command line at the bottom. diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 3479336a1a..340be2368c 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -354,12 +354,13 @@ On Unix systems the form "${HOME}" can be used too. The name between {} can contain non-id characters then. Note that if you want to use this for the "gf" command, you need to add the '{' and '}' characters to 'isfname'. -On MS-Windows, if $HOME is not defined as an environment variable, then -at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. - NOTE: expanding environment variables and "~/" is only done with the ":set" command, not when assigning a value to an option with ":let". + *$HOME-windows* +On MS-Windows, if $HOME is not defined as an environment variable, then +at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. + Note the maximum length of an expanded option is limited. How much depends on the system, mostly it is something like 256 or 1024 characters. diff --git a/runtime/doc/remote.txt b/runtime/doc/remote.txt index 963d5f1972..039d8b582e 100644 --- a/runtime/doc/remote.txt +++ b/runtime/doc/remote.txt @@ -87,7 +87,7 @@ Tell the remote server "BLA" to write all files and exit: > vim --servername BLA --remote-send '<C-\><C-N>:wqa<CR>' -SERVER NAME +SERVER NAME *client-server-name* By default Vim will try to register the name under which it was invoked (gvim, egvim ...). This can be overridden with the --servername argument. If the diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt index eb8cd1a58b..611274b8d8 100644 --- a/runtime/doc/syntax.txt +++ b/runtime/doc/syntax.txt @@ -2108,6 +2108,16 @@ set "msql_minlines" to the value you desire. Example: > :let msql_minlines = 200 +N1QL *n1ql.vim* *ft-n1ql-syntax* + +N1QL is a SQL-like declarative language for manipulating JSON documents in +Couchbase Server databases. + +Vim syntax highlights N1QL statements, keywords, operators, types, comments, +and special values. Vim ignores syntactical elements specific to SQL or its +many dialects, like COLUMN or CHAR, that don't exist in N1QL. + + NCF *ncf.vim* *ft-ncf-syntax* There is one option for NCF syntax highlighting. diff --git a/runtime/doc/usr_03.txt b/runtime/doc/usr_03.txt index 5a7f0cb0e5..989914687f 100644 --- a/runtime/doc/usr_03.txt +++ b/runtime/doc/usr_03.txt @@ -353,7 +353,7 @@ The "?" command works like "/" but searches backwards: > ?word The "N" command repeats the last search the opposite direction. Thus using -"N" after a "/" command search backwards, using "N" after "?" searches +"N" after a "/" command searches backwards, using "N" after "?" searches forward. @@ -508,7 +508,7 @@ only if it is at the beginning of a line. The $ character matches the end of a line. Therefore, "was$" matches the word was only if it is at the end of a line. -Let's mark the places where "the" matches in this example line with "x"s: +Let's mark the places where "/the" matches in this example line with "x"s: the solder holding one of the chips melted and the ~ xxx xxx xxx diff --git a/runtime/doc/usr_07.txt b/runtime/doc/usr_07.txt index 3fc600d977..cbd81c6b91 100644 --- a/runtime/doc/usr_07.txt +++ b/runtime/doc/usr_07.txt @@ -355,7 +355,7 @@ a sentence to the f register (f for First): > "fyas The "yas" command yanks a sentence like before. It's the "f that tells Vim -the text should be place in the f register. This must come just before the +the text should be placed in the f register. This must come just before the yank command. Now yank three whole lines to the l register (l for line): > diff --git a/runtime/doc/usr_08.txt b/runtime/doc/usr_08.txt index 575921fc4f..ef91bf9c0a 100644 --- a/runtime/doc/usr_08.txt +++ b/runtime/doc/usr_08.txt @@ -45,7 +45,7 @@ top one: +----------------------------------+ What you see here is two windows on the same file. The line with "====" is -that status line. It displays information about the window above it. (In +the status line. It displays information about the window above it. (In practice the status line will be in reverse video.) The two windows allow you to view two parts of the same file. For example, you could make the top window show the variable declarations of a program, and diff --git a/runtime/doc/usr_09.txt b/runtime/doc/usr_09.txt index bf3399e379..d345116f08 100644 --- a/runtime/doc/usr_09.txt +++ b/runtime/doc/usr_09.txt @@ -60,7 +60,7 @@ THE WINDOW TITLE At the very top is the window title. This is drawn by your window system. Vim will set the title to show the name of the current file. First comes the name of the file. Then some special characters and the directory of the file -in parens. These special character can be present: +in parens. These special characters can be present: - The file cannot be modified (e.g., a help file) + The file contains changes @@ -202,7 +202,7 @@ the "real clipboard" are called clipboard, you'll have to get used to that. To put text on the real clipboard, select a few different words in one of the gVims you have running. Then use the Edit/Copy menu entry. Now the text has been copied to the real clipboard. You can't see this, unless you have -some application that shows the clipboard contents (e.g., KDE's klipper). +some application that shows the clipboard contents (e.g., KDE's Klipper). Now select the other gVim, position the cursor somewhere and use the Edit/Paste menu. You will see the text from the real clipboard is inserted. diff --git a/runtime/doc/usr_12.txt b/runtime/doc/usr_12.txt index 9078f4748a..e87ed81c97 100644 --- a/runtime/doc/usr_12.txt +++ b/runtime/doc/usr_12.txt @@ -278,7 +278,7 @@ command: > The line range "%" is used, thus this works on the whole file. The pattern that the ":substitute" command matches with is "\s\+$". This finds white space characters (\s), 1 or more of them (\+), before the end-of-line ($). -Later will be explained how you write patterns like this |usr_27.txt|. +Later will be explained how you write patterns like this, see |usr_27.txt|. The "to" part of the substitute command is empty: "//". Thus it replaces with nothing, effectively deleting the matched white space. diff --git a/runtime/doc/windows.txt b/runtime/doc/windows.txt index 9224fd59ff..6f371c7bc8 100644 --- a/runtime/doc/windows.txt +++ b/runtime/doc/windows.txt @@ -311,8 +311,9 @@ CTRL-W CTRL-C *CTRL-W_CTRL-C* *:hide* :hid[e] :{count}hid[e] - Quit the current window, unless it is the last window on the - screen. For {count} see |:quit|. + Without {count}: Quit the current window, unless it is the + last window on the screen. + If {count} is given quit the {count} window. The buffer becomes hidden (unless there is another window editing it or 'bufhidden' is `unload`, `delete` or `wipe`). @@ -994,6 +995,8 @@ list of buffers. |unlisted-buffer| displayed in a window |hidden-buffer| - a buffer with 'modifiable' off = a readonly buffer + R a terminal buffer with a running job + F a terminal buffer with a finished job + a modified buffer x a buffer with read errors @@ -1238,6 +1241,9 @@ help Contains a help file. Will only be created with the |:help| and can't be changed. The 'buflisted' option will be reset for a help buffer. +terminal A terminal window buffer, see |terminal|. The contents cannot + be read or changed until the job ends. + directory Displays directory contents. Can be used by a file explorer plugin. The buffer is created with these settings: > :setlocal buftype=nowrite |