mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-25 20:07:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify "pipe" mode for sockconnect

Browse Source 
Make it more clear that on unix the "pipe" mode of sockconnect uses unix
local domain sockets, not named pipes (FIFOs) which are not currently
supported.

See discussion in #22080.

Signed-off-by: Thayne McCombs
This commit is contained in:
Thayne McCombs
2023-02-01 23:26:26 -07:00
parent d63ad600e0
commit cb97d5425a
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
runtime/doc/builtin.txt
View File

@@ -1959,7 +1959,7 @@ exp({expr}) *exp()*
Compute()->exp() Compute()->exp()
expand({string} [, {nosuf} [, {list}]]) *expand()* expand({string} [, {nosuf} [, {list}]]) *expand()*
Expand wildcards and the following special keywords in Expand wildcards and the following special keywords in
{string}. 'wildignorecase' applies. {string}. 'wildignorecase' applies.
If {list} is given and it is |TRUE|, a List will be returned. 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()* sockconnect({mode}, {address} [, {opts}]) *sockconnect()*
Connect a socket to an address. If {mode} is "pipe" then Connect a socket to an address. If {mode} is "pipe" then
{address} should be the path of a named pipe. If {mode} is {address} should be the path of a local domain socket (on
"tcp" then {address} should be of the form "host:port" where unix) or named pipe (on Windows). If {mode} is "tcp" then
the host should be an ip adderess or host name, and port the {address} should be of the form "host:port" where the host
port number. 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()|. Returns a |channel| ID. Close the socket with |chanclose()|.
Use |chansend()| to send data over a bytes socket, and Use |chansend()| to send data over a bytes socket, and