aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2018-04-08 13:06:26 +0200
committerJustin M. Keyes <justinkz@gmail.com>2018-04-11 01:58:41 +0200
commit9f598e57656fe072114b9f1e73d3051423e13234 (patch)
tree79cc699ed4cb2b4ef33a9faa2a6d972e2504d052 /runtime
parentb11b681289582472340e3af72ea116c4ba354066 (diff)
downloadrneovim-9f598e57656fe072114b9f1e73d3051423e13234.tar.gz
rneovim-9f598e57656fe072114b9f1e73d3051423e13234.tar.bz2
rneovim-9f598e57656fe072114b9f1e73d3051423e13234.zip
serverstop(): return FALSE for invalid address
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/eval.txt24
1 files changed, 9 insertions, 15 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 767fc133d8..084936e9d2 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1789,8 +1789,10 @@ v:scrollstart String describing the script or function that caused the
*v:servername* *servername-variable*
*$NVIM_LISTEN_ADDRESS*
-v:servername Default Nvim server address. Equivalent to
- |$NVIM_LISTEN_ADDRESS| on startup. |serverstop()|
+v:servername Primary listen address of the current Nvim instance, the first
+ item returned by |serverlist()|. Can be set by
+ |--listen| or |$NVIM_LISTEN_ADDRESS| on startup.
+ See also |serverstart()| and |serverstop()|.
Read-only.
@@ -6638,15 +6640,11 @@ server2client({clientid}, {string}) *server2client()*
:echo server2client(expand("<client>"), "HELLO")
<
serverlist() *serverlist()*
- Returns a list of available server names in a list.
- When there are no servers an empty string is returned.
+ Returns a list of server addresses, or empty if all servers
+ were stopped. |serverstart()| |serverstop()|
Example: >
:echo serverlist()
-< {Nvim} *--serverlist*
- The Vim command-line option `--serverlist` was removed from
- Nvim, but it can be imitated: >
- nvim --cmd "echo serverlist()" --cmd "q"
-<
+
serverstart([{address}]) *serverstart()*
Opens a socket or named pipe at {address} and listens for
|RPC| messages. Clients can send |API| commands to the address
@@ -6674,13 +6672,9 @@ serverstart([{address}]) *serverstart()*
< |$NVIM_LISTEN_ADDRESS| is set to {address} if not already set.
- *--servername*
- The Vim command-line option `--servername` can be imitated: >
- nvim --cmd "let g:server_addr = serverstart('foo')"
-<
serverstop({address}) *serverstop()*
- Closes the pipe or socket at {address}. Does nothing if
- {address} is empty or invalid.
+ Closes the pipe or socket at {address}.
+ Returns TRUE if {address} is valid, else FALSE.
If |$NVIM_LISTEN_ADDRESS| is stopped it is unset.
If |v:servername| is stopped it is set to the next available
address returned by |serverlist()|.