diff options
| author | Thiago de Arruda <tpadilha84@gmail.com> | 2014-09-15 10:12:12 -0300 |
|---|---|---|
| committer | Thiago de Arruda <tpadilha84@gmail.com> | 2014-09-15 10:12:12 -0300 |
| commit | 3ec4e18cd00700abdffb564835dd4cd7e68a0093 (patch) | |
| tree | 6010e814bb0d10681aaf1369b664a041d8aab2e4 /runtime/doc/eval.txt | |
| parent | 5d35484203cb950a7ba0ed0d9428cb58b37212ff (diff) | |
| parent | e0beb6d0c4b5f0b573f09418b5e02b1ba5eeaeb9 (diff) | |
| download | rneovim-3ec4e18cd00700abdffb564835dd4cd7e68a0093.tar.gz rneovim-3ec4e18cd00700abdffb564835dd4cd7e68a0093.tar.bz2 rneovim-3ec4e18cd00700abdffb564835dd4cd7e68a0093.zip | |
Merge PR #1175 'Some fixes to nvim initial documentation'
Diffstat (limited to 'runtime/doc/eval.txt')
| -rw-r--r-- | runtime/doc/eval.txt | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index bbd43f9b9a..ec2086e3eb 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -4019,7 +4019,12 @@ jobsend({job}, {data}) {Nvim} *jobsend()* jobstart({name}, {prog}[, {argv}]) {Nvim} *jobstart()* Spawns {prog} as a job and associate it with the {name} string, which will be used to match the "filename pattern" in - |JobActivity| events. See |job-control| for more information. + |JobActivity| events. It returns: + - The job id on success, which is used by |jobsend()| and + |jobstop()| + - 0 when the job table is full or on invalid arguments + - -1 when {prog} is not executable + See |job-control| for more information. jobstop({job}) {Nvim} *jobstop()* Stop a job created with |jobstart| by sending a `SIGTERM` @@ -5083,10 +5088,12 @@ rpcrequest({channel}, {method}[, {args}...]) {Nvim} *rpcrequest()* rpcstart({prog}[, {argv}]) {Nvim} *rpcstart()* Spawns {prog} as a job(optionally passing the {argv} list), - and open a |msgpack-rpc| channel with the spawned process - stdin/stdout. Returns the channel id, which is used by - |rpcrequest()|, |rpcnotify()| and |rpcstop()| - It expects the rpc channel id as argument. Example: > + and opens a |msgpack-rpc| channel with the spawned process + stdin/stdout. It returns: + - The channel id on success, which is used by |rpcrequest()|, + |rpcnotify()| and |rpcstop()| + - 0 on failure. + Example: > :let rpc_chan = rpcstart('prog', ['arg1', 'arg2']) rpcstop({channel}) {Nvim} *rpcstop()* |