aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2022-06-17 01:23:48 +0200
committerGitHub <noreply@github.com>2022-06-17 01:23:48 +0200
commitc57f6b28d71df1eb6e967381a44a1c038a75698d (patch)
tree02a46f56a250d5f59b767ab3af09cf2b72c60d34 /runtime
parent279bc71f3c24928de7d46034168fa105592eb1fa (diff)
parent1f2c2a35ad14cfac002d87073471bd84a52860bf (diff)
downloadrneovim-c57f6b28d71df1eb6e967381a44a1c038a75698d.tar.gz
rneovim-c57f6b28d71df1eb6e967381a44a1c038a75698d.tar.bz2
rneovim-c57f6b28d71df1eb6e967381a44a1c038a75698d.zip
Merge #8519 feat: name, test ids, sockets in stdpath(state)
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/builtin.txt41
1 files changed, 20 insertions, 21 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 57b45f33c1..0b32b3a420 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -6628,30 +6628,29 @@ serverlist() *serverlist()*
serverstart([{address}]) *serverstart()*
Opens a socket or named pipe at {address} and listens for
- |RPC| messages. Clients can send |API| commands to the address
- to control Nvim.
-
- Returns the address string.
-
- If {address} does not contain a colon ":" it is interpreted as
- a named pipe or Unix domain socket path.
-
- Example: >
+ |RPC| messages. Clients can send |API| commands to the
+ returned address to control Nvim.
+
+ Returns the address string (may differ from the requested
+ {address}).
+
+ - If {address} contains a colon ":" it is interpreted as
+ a TCP/IPv4/IPv6 address where the last ":" separates host
+ and port (empty or zero assigns a random port).
+ - Else it is interpreted as a named pipe or Unix domain socket
+ path. If there are no slashes it is treated as a name and
+ appended to a generated path.
+ - If {address} is empty it generates a path.
+
+ Example named pipe: >
if has('win32')
- call serverstart('\\.\pipe\nvim-pipe-1234')
+ echo serverstart('\\.\pipe\nvim-pipe-1234')
else
- call serverstart('nvim.sock')
+ echo serverstart('nvim.sock')
endif
<
- If {address} contains a colon ":" it is interpreted as a TCP
- address where the last ":" separates the host and port.
- Assigns a random port if it is empty or 0. Supports IPv4/IPv6.
-
- Example: >
- :call serverstart('::1:12345')
-<
- If no address is given, it is equivalent to: >
- :call serverstart(tempname())
+ Example TCP/IP address: >
+ echo serverstart('::1:12345')
serverstop({address}) *serverstop()*
Closes the pipe or socket at {address}.
@@ -7545,7 +7544,7 @@ stdpath({what}) *stdpath()* *E6100*
data_dirs List Other data directories.
log String Logs directory (for use by plugins too).
state String Session state directory: storage for file
- drafts, undo history, shada, etc.
+ drafts, undo, shada, named pipes, ...
Example: >
:echo stdpath("config")