diff options
| author | Marco Hinz <mh.codebro@gmail.com> | 2017-05-22 00:01:33 +0200 |
|---|---|---|
| committer | Marco Hinz <mh.codebro@gmail.com> | 2017-05-22 23:38:09 +0200 |
| commit | 156e6f274f7ecc65e07176a39eee9600d0beaaf1 (patch) | |
| tree | 88cb557fccb56947b8799659e8235fe0101c1227 | |
| parent | fd5e4e2e4c6b231980effc3055fb93300bd055b0 (diff) | |
| download | rneovim-156e6f274f7ecc65e07176a39eee9600d0beaaf1.tar.gz rneovim-156e6f274f7ecc65e07176a39eee9600d0beaaf1.tar.bz2 rneovim-156e6f274f7ecc65e07176a39eee9600d0beaaf1.zip | |
Doc: explain the format for serverstart()
| -rw-r--r-- | runtime/doc/eval.txt | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 44f2b3688c..a11f013950 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -6462,11 +6462,20 @@ serverlist() *serverlist()* nvim --cmd "echo serverlist()" --cmd "q" < serverstart([{address}]) *serverstart()* - Opens a named pipe or TCP socket at {address} for clients to - connect to and returns {address}. If no address is given, it - is equivalent to: > + Opens a TCP socket (IPv4/IPv6), Unix domain socket (Unix), + or named pipe (Windows) at {address} for clients to connect + to and returns {address}. + + If {address} contains `:`, a TCP socket is used. Everything in + front of the last occurrence of `:` is the IP or hostname, + everything after it the port. If the port is empty or `0`, + a random port will be assigned. + + If no address is given, it is equivalent to: > :call serverstart(tempname()) + < |$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')" |