commit 0ea4156464c982f0451cd486e2152934c3dd2204
parent c05b3c3bbdef4018ce70f0c822c4a55654a9c186
Author: bfredl <bjorn.linse@gmail.com>
Date: Thu, 2 Feb 2023 19:09:02 +0100
Merge pull request #22098 from tmccombs/sockopen-docs
docs: clarify "pipe" mode for sockconnect
Diffstat:
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
@@ -1959,7 +1959,7 @@ exp({expr}) *exp()*
Compute()->exp()
expand({string} [, {nosuf} [, {list}]]) *expand()*
- Expand wildcards and the following special keywords in
+ Expand wildcards and the following special keywords in
{string}. 'wildignorecase' applies.
If {list} is given and it is |TRUE|, a List will be returned.
@@ -7569,10 +7569,14 @@ sinh({expr}) *sinh()*
sockconnect({mode}, {address} [, {opts}]) *sockconnect()*
Connect a socket to an address. If {mode} is "pipe" then
- {address} should be the path of a named pipe. If {mode} is
- "tcp" then {address} should be of the form "host:port" where
- the host should be an ip adderess or host name, and port the
- port number.
+ {address} should be the path of a local domain socket (on
+ unix) or named pipe (on Windows). If {mode} is "tcp" then
+ {address} should be of the form "host:port" where the host
+ should be an ip adderess or host name, and port the port
+ number.
+
+ For "pipe" mode, see |luv-pipe-handle|. For "tcp" mode, see
+ |luv-tcp-handle|.
Returns a |channel| ID. Close the socket with |chanclose()|.
Use |chansend()| to send data over a bytes socket, and
