doc: api_info

This commit is contained in:
Justin M. Keyes 2016-06-18 14:12:54 -04:00
parent cf89160d6e
commit 8c28baa7c7
3 changed files with 8 additions and 7 deletions

View File

@ -2198,8 +2198,7 @@ and({expr}, {expr}) *and()*
api_info() *api_info()*
Return Dictionary containing api metadata.
See |api-metadata|.
Returns Dictionary of |api-metadata|.
append({lnum}, {expr}) *append()*

View File

@ -9,7 +9,7 @@ RPC API for Nvim *RPC* *rpc* *msgpack-rpc*
1. Introduction |rpc-intro|
2. API mapping |rpc-api|
3. Connecting |rpc-connecting|
4. Clients |rpc-client|
4. Clients |rpc-api-client|
5. Types |rpc-types|
6. Vimscript functions |rpc-vim-functions|
@ -51,11 +51,10 @@ There are three ways to obtain API metadata:
msgpack-rpc. This is best for clients written in dynamic languages which
can define functions at runtime.
2. Start Nvim with the `--api-info` command-line option, which dumps a blob
of msgpack metadata to standard output. This is useful for clients
written in statically-compiled languages.
2. Start Nvim with the |--api-info| option. Useful for clients written in
statically-compiled languages.
3. In vimscript the metadata is available as |api_info()|.
3. Use the |api_info()| vimscript function.
To get a human-readable list of API functions: >
:new|put =map(api_info().functions, 'v:val.name')

View File

@ -350,6 +350,9 @@ argument.
*-W*
-W {scriptout} Like -w, but do not append, overwrite an existing file.
*--api-info*
--api-info Print msgpack-encoded |api-metadata| and exit.
==============================================================================
2. Initialization *initialization* *startup*