diff options
| author | Josh Rahm <joshuarahm@gmail.com> | 2025-02-05 23:09:29 +0000 |
|---|---|---|
| committer | Josh Rahm <joshuarahm@gmail.com> | 2025-02-05 23:09:29 +0000 |
| commit | d5f194ce780c95821a855aca3c19426576d28ae0 (patch) | |
| tree | d45f461b19f9118ad2bb1f440a7a08973ad18832 /runtime/doc/channel.txt | |
| parent | c5d770d311841ea5230426cc4c868e8db27300a8 (diff) | |
| parent | 44740e561fc93afe3ebecfd3618bda2d2abeafb0 (diff) | |
| download | rneovim-rahm.tar.gz rneovim-rahm.tar.bz2 rneovim-rahm.zip | |
Diffstat (limited to 'runtime/doc/channel.txt')
| -rw-r--r-- | runtime/doc/channel.txt | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/runtime/doc/channel.txt b/runtime/doc/channel.txt index 7184151cda..c2d220041c 100644 --- a/runtime/doc/channel.txt +++ b/runtime/doc/channel.txt @@ -11,21 +11,20 @@ Nvim asynchronous IO *channel* ============================================================================== 1. Introduction *channel-intro* -Channels are nvim's way of communicating with external processes. +Channels are Nvim's way of communicating with external processes. There are several ways to open a channel: - 1. Through stdin/stdout when `nvim` is started with `--headless`, and a startup - script or --cmd command opens the stdio channel using |stdioopen()|. + 1. Through stdin/stdout when `nvim` is started with `--headless` and a startup + script or `--cmd` command opens the stdio channel using |stdioopen()|. 2. Through stdin, stdout and stderr of a process spawned by |jobstart()|. - 3. Through the PTY master end of a PTY opened with - `jobstart(..., {'pty': v:true})` or |termopen()|. + 3. Through the PTY master end opened with `jobstart(…, {'pty': v:true})`. 4. By connecting to a TCP/IP socket or named pipe with |sockconnect()|. - 5. By another process connecting to a socket listened to by nvim. This only + 5. By another process connecting to a socket listened to by Nvim. This only supports RPC channels, see |rpc-connecting|. Channels support multiple modes or protocols. In the most basic @@ -146,7 +145,7 @@ from the host TTY, or if Nvim is |--headless| it uses default values: >vim :echo system('nvim --headless +"te stty -a" +"sleep 1" +"1,/^$/print" +q') ============================================================================== -3. Communicating using msgpack-rpc *channel-rpc* +3. Communicating with msgpack RPC *channel-rpc* When channels are opened with the `rpc` option set to true, the channel can be used for remote method calls in both directions, see |msgpack-rpc|. Note that |