diff options
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/deprecated.txt | 4 | ||||
| -rw-r--r-- | runtime/doc/eval.txt | 32 | ||||
| -rw-r--r-- | runtime/doc/insert.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/vim_diff.txt | 18 |
4 files changed, 37 insertions, 19 deletions
diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt index 2b69929cfe..6997d331e4 100644 --- a/runtime/doc/deprecated.txt +++ b/runtime/doc/deprecated.txt @@ -6,6 +6,10 @@ Nvim *deprecated* +The items listed below are "deprecated". This means they will be removed in +the future. They should not be used in new scripts, and old scripts should be +updated. + ============================================================================== Normal commands ~ diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 1eb5ec45c0..cfd62bacfe 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -6840,23 +6840,30 @@ system({cmd} [, {input}]) *system()* *E677* Get the output of the shell command {cmd} as a |string|. {cmd} will be run the same as in |jobstart()|. See |systemlist()| to get the output as a |List|. - - When {input} is given and is a string this string is written - to a file and passed as stdin to the command. The string is - written as-is, you need to take care of using the correct line - separators yourself. - If {input} is given and is a |List| it is written to the file - in a way |writefile()| does with {binary} set to "b" (i.e. - with a newline between each list item with newlines inside - list items converted to NULs). - Pipes are not used. + Not to be used for interactive commands. + + If {input} is a string it is written to a pipe and passed as + stdin to the command. The string is written as-is, line + separators are not changed. + If {input} is a |List| it is written to the pipe as + |writefile()| does with {binary} set to "b" (i.e. with + a newline between each list item, and newlines inside list + items converted to NULs). + *E5677* + Note: system() cannot write to or read from backgrounded ("&") + shell commands, e.g.: > + :echo system("cat - &", "foo")) +< which is equivalent to: > + $ echo foo | bash -c 'cat - &' +< The pipes are disconnected (unless overridden by shell + redirection syntax) before input can reach it. Use + |jobstart()| instead. Note: Use |shellescape()| or |::S| with |expand()| or |fnamemodify()| to escape special characters in a command argument. Newlines in {cmd} may cause the command to fail. The characters in 'shellquote' and 'shellxquote' may also cause trouble. - This is not to be used for interactive commands. The result is a String. Example: > :let files = system("ls " . shellescape(expand('%:h'))) @@ -6871,9 +6878,6 @@ system({cmd} [, {input}]) *system()* *E677* The command executed is constructed using several options when {cmd} is a string: 'shell' 'shellcmdflag' {cmd} - The command will be executed in "cooked" mode, so that a - CTRL-C will interrupt the command (on Unix at least). - The resulting error code can be found in |v:shell_error|. This function will fail in |restricted-mode|. diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index 818d6cf64c..a82e17c857 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -1436,7 +1436,7 @@ original HTML files completion of tags (and only tags) isn't context aware. RUBY *ft-ruby-omni* {Nvim} -NOTE: Completion for ruby code is not currently provided by Nvim. +NOTE: |compl-omni| for Ruby code requires |provider-ruby| to be installed. Ruby completion will parse your buffer on demand in order to provide a list of completions. These completions will be drawn from modules loaded by 'require' diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index 249208911b..bb1f993ab6 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -76,6 +76,15 @@ Python plugins |provider-python| Clipboard integration |provider-clipboard| +USER EXPERIENCE ~ + +A major goal of Nvim is to work intuitively and consistently. For example, +Nvim does not have `-X`, a platform-specific option available in some Vim +builds (with potential surprises: http://stackoverflow.com/q/14635295). Nvim +avoids features that cannot be provided on all platforms--instead that is +delegated to external plugins/extensions. + + OTHER FEATURES ~ |bracketed-paste-mode| is built-in and enabled by default. @@ -99,6 +108,7 @@ Options: Commands: |:CheckHealth| + |:drop| is available on all platforms |:Man| is available by default, with many improvements such as completion Functions: @@ -131,10 +141,10 @@ are always available and may be used simultaneously in separate plugins. The `neovim` pip package must be installed to use Python plugins in Nvim (see |provider-python|). -|:!| and |system()| do not support "interactive" commands; use |:terminal| for -that instead. Terminal Vim supports interactive |:!| and |system()|, but gui -Vim does not. See ":help gui-pty" in Vim: - http://vimdoc.sourceforge.net/htmldoc/gui_x11.html#gui-pty +|:!| does not support "interactive" commands. Use |:terminal| instead. +(GUI Vim has a similar limitation, see ":help gui-pty" in Vim.) + +|system()| does not support writing/reading "backgrounded" commands. |E5677| |mkdir()| behaviour changed: 1. Assuming /tmp/foo does not exist and /tmp can be written to |