doc: language tidyups and a few minor refinements.
Some additional detail was warranted in several places, though the
listconfigs is better off simply referring to lightningd-config.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Fixed: doc: Many missing manual pages were completed
@ -7,7 +7,7 @@ lightning-getinfo - Command to receive all information about the c-lightning nod
.SHDESCRIPTION
.SHDESCRIPTION
The \fBgetinfo\fRis a RPC command which is possible receive all node informations\.
The \fBgetinfo\fRgives a summary of the current running node\.
.SHEXAMPLEJSONREQUEST
.SHEXAMPLEJSONREQUEST
.nf
.nf
@ -26,38 +26,38 @@ On success, an object with the following information is returned:
.RS
.RS
.IP\[bu]
.IP\[bu]
\fIid\fR: A string that rappresents the public key of the node\. It will rappresent the node on the public network\.
\fIid\fR: A string that represents the public key of the node\. It will represents the node on the public network\.
.IP\[bu]
.IP\[bu]
\fIalias\fR: A string that rappresents the alias of the node, by default is calculate from the public key (node id)\.
\fIalias\fR: A string that represents the alias of the node, by default is calculate from the public key (node id)\. This is just for fun; the name can be anything and is not unique!
.IP\[bu]
.IP\[bu]
\fIcolor\fR: A string that rappresents the color of the node\.
\fIcolor\fR: A string that represents the preferred color of the node\.
.IP\[bu]
.IP\[bu]
\fInum_peers\fR: An integer that rappresents the number of peer connect to the node\.
\fInum_peers\fR: An integer that represents the number of peer connect to the node\.
.IP\[bu]
.IP\[bu]
\fInum_pending_channels\fR: An integer that rappresents the number of channel with pending status\.
\fInum_pending_channels\fR: An integer that represents the number of channel which are still awaiting opening confirmation\.
.IP\[bu]
.IP\[bu]
\fInum_active_channels\fR: A integer that rappresents the number of channel with the active status\.
\fInum_active_channels\fR: A integer that represents the number of channel which are currently open\.
.IP\[bu]
.IP\[bu]
\fInum_inactive_channels\fR: A integer that rappresents the number of channel with the inactive status\.
\fInum_inactive_channels\fR: A integer that represents the number of channel which are closing\.
.IP\[bu]
.IP\[bu]
\fIaddress\fR: An array that rappresents all addresses of the node, each object inside the array contains the following proprieties:.RS
\fIaddress\fR: An array that represents all published addresses of the node, each object inside the array contains the following proprieties:.RS
.IP\[bu]
.IP\[bu]
\fItype\fR: A string that rappresents the type of the address (ipv4 or ipv6)\.
\fItype\fR: A string that represents the type of the address (currently \fBipv4\fR, \fBipv6\fR, \fBtorv3\fR or \fBtorv4\fR)\.
.IP\[bu]
.IP\[bu]
\fIaddress\fR: A string that rappresents the value of the address\.
\fIaddress\fR: A string that represents the value of the address\.
.IP\[bu]
.IP\[bu]
\fIport\fR: An integer that rappresents the port where the node are listening with this address\.
\fIport\fR: An integer that represents the port where the node is listening with this address\.
.RE
.RE
.IP\[bu]
.IP\[bu]
\fIbinding\fR: An array that rappresents all addresses where the node is binded\. Each object contains the same object type of the address propriety above\.
\fIbinding\fR: An array that represents all addresses where the node is binded\. Each object contains the same object type of the address propriety above\.
.IP\[bu]
.IP\[bu]
\fIversion\fR: A string that rappresents the version of the node\.
\fIversion\fR: A string that represents the version of the node\.
.IP\[bu]
.IP\[bu]
\fIblockheight\fR: An integer that rappresents the blockchain height\.
\fIblockheight\fR: An integer that represents the blockchain height\.
.IP\[bu]
.IP\[bu]
\fInetwork\fR: A string that rappresents the type of network on the node are working (i\.e: bitcoin, testnet, regtest)\.
\fInetwork\fR: A string that represents the type of network on the node are working (e\.g: \fBbitcoin\fR, \fBtestnet\fR, or \fBregtest\fR)\.
.RE
.RE
@ -120,3 +120,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
The **getinfo**is a RPC command which is possible receive all node informations.
The **getinfo**gives a summary of the current running node.
EXAMPLE JSON REQUEST
EXAMPLE JSON REQUEST
@ -27,21 +27,21 @@ RETURN VALUE
On success, an object with the following information is returned:
On success, an object with the following information is returned:
- *id*: A string that rappresents the public key of the node. It will rappresent the node on the public network.
- *id*: A string that represents the public key of the node. It will represents the node on the public network.
- *alias*: A string that rappresents the alias of the node, by default is calculate from the public key (node id).
- *alias*: A string that represents the alias of the node, by default is calculate from the public key (node id). This is just for fun; the name can be anything and is not unique!
- *color*: A string that rappresents the color of the node.
- *color*: A string that represents the preferred color of the node.
- *num_peers*: An integer that rappresents the number of peer connect to the node.
- *num_peers*: An integer that represents the number of peer connect to the node.
- *num_pending_channels*: An integer that rappresents the number of channel with pending status.
- *num_pending_channels*: An integer that represents the number of channel which are still awaiting opening confirmation.
- *num_active_channels*: A integer that rappresents the number of channel with the active status.
- *num_active_channels*: A integer that represents the number of channel which are currently open.
- *num_inactive_channels*: A integer that rappresents the number of channel with the inactive status.
- *num_inactive_channels*: A integer that represents the number of channel which are closing.
- *address*: An array that rappresents all addresses of the node, each object inside the array contains the following proprieties:
- *address*: An array that represents all published addresses of the node, each object inside the array contains the following proprieties:
- *type*: A string that rappresents the type of the address (ipv4 or ipv6).
- *type*: A string that represents the type of the address (currently `ipv4`, `ipv6`, `torv3` or `torv4`).
- *address*: A string that rappresents the value of the address.
- *address*: A string that represents the value of the address.
- *port*: An integer that rappresents the port where the node are listening with this address.
- *port*: An integer that represents the port where the node is listening with this address.
- *binding*: An array that rappresents all addresses where the node is binded. Each object contains the same object type of the address propriety above.
- *binding*: An array that represents all addresses where the node is binded. Each object contains the same object type of the address propriety above.
- *version*: A string that rappresents the version of the node.
- *version*: A string that represents the version of the node.
- *blockheight*: An integer that rappresents the blockchain height.
- *blockheight*: An integer that represents the blockchain height.
- *network*: A string that rappresents the type of network on the node are working (i.e: bitcoin, testnet, regtest).
- *network*: A string that represents the type of network on the node are working (e.g: `bitcoin`, `testnet`, or `regtest`).
On failure, one of the following error codes may be returned:
On failure, one of the following error codes may be returned:
@ -7,7 +7,7 @@ lightning-listconfigs - Command to list all configuration options\.
.SHDESCRIPTION
.SHDESCRIPTION
The \fBlistconfigs\fRteh RPC command to list all configuration options, or with \fIconfig\fR, just that one\.
The \fBlistconfigs\fR RPC command to list all configuration options, or with \fIconfig\fR, just that one\.
.SHEXAMPLEJSONREQUEST
.SHEXAMPLEJSONREQUEST
.nf
.nf
@ -24,100 +24,29 @@ The \fBlistconfigs\fR teh RPC command to list all configuration options, or with
.fi
.fi
.SHRETURNVALUE
.SHRETURNVALUE
On success, an object with the following proprieties is returned:
On success, an object is returned with members reflecting the
corresponding \fBlightningd-config\fR(5) options which were specified in
the configuration file(s) and command line\.
Additional members include:
.RS
.RS
.IP\[bu]
.IP\[bu]
\fI# version\fR: A string that rappresents the version of node\.
\fI# version\fR: A string that represents the version of node\.
.IP\[bu]
\fIlightning-dir\fR: A string that rappresents the work dir of the node\.
.IP\[bu]
\fInetwork\fR: A string that rappresents the network (e\.g: bitcoin)\.
.IP\[bu]
\fIallow-deprecated-apis\fR: A boolean value that rappresent if the deprecated api are avaible on the node\.
.IP\[bu]
.IP\[bu]
\fIrpc-file\fR: A string that rappresent the location of the rpc file\.
\fIplugins\fR: A array that represents the non-important plugin registered\. Each object contains the following members:.RS
.IP\[bu]
.IP\[bu]
\fIplugins\fR: A array that rappresent the no important plugin registered\. Each object contains the following proprieties:.RS
\fIpath\fR: A string that represents the path of plugin\.
.IP\[bu]
.IP\[bu]
\fIpath\fR: A string that rappresent the path of plugin\.
\fIname\fR: A string that represents the name of plugin\.
.IP\[bu]
.IP\[bu]
\fIname\fR: A string that rappresent the name of plugin\.
\fIoptions\fR: A object that contains all options accepted from command line or configuration file, if the plugin has opitions
.IP\[bu]
\fIoptions\fR: A object that contains all options accepted from comand line, if the plugin accepted parameters from command line\.
.RE
.RE
.IP\[bu]
.IP\[bu]
\fIimportant-plugins\fR: An array that rappresent all important pluging registered to the node\. Each object contains the same proprieties of \fIplugin\fR array\.
\fIimportant-plugins\fR: An array that represents all important plugins registered to the node\. Each object contains the same members as the \fIplugin\fR array\.
.IP\[bu]
\fIdisable-plugin\fR: An array of string that rappresent the name of plugin disabled\.
.IP\[bu]
\fIalways-use-proxy\fR: A boolean value that rappresent if the node utilize always the proxy\.
.IP\[bu]
\fIdaemon\fR: A boolean value is the node have the daemon propriety enabled\.
.IP\[bu]
\fIwallet\fR: A string that rappresent the location of wallet with database url convention\.
.IP\[bu]
\fIwumbo\fR: A boolean value that rappresent the value of wumbo propriety\.
.IP\[bu]
\fIrgb\fR: A string that rappresent the color of the node\.
.IP\[bu]
\fIalias\fR: A string that rappresent the alias of the node\.
.IP\[bu]
\fIpid-file\fR: A string that rappresent the location of the pid file\.
.IP\[bu]
\fIignore-fee-limits\fR: A boolean value that rappresent is the node ignore the fee limit\.
.IP\[bu]
\fIwatchtime-blocks\fR: An integer that rappresent the watchtime of the blocks\.
.IP\[bu]
\fImax-locktime-blocks\fR: A integer that rappresent that max locktime for blocks\.
.IP\[bu]
\fIfunding-confirms\fR: An integer that rappresent the number of funding transaction confermation\.
.IP\[bu]
\fIcommit-fee-min\fR: A integer that rappresent the minimum commit fee\.
.IP\[bu]
\fIcommit-fee-max\fR: A integer that rappresent the maximum commit fee\.
.IP\[bu]
\fIcltv-delta\fR: An integer that rappresent the value of cltv delta\.
.IP\[bu]
\fIcltv-final\fR: An integer that rappresent the value of cltv final\.
.IP\[bu]
\fIcommit-time\fR: An integer that rappresent the value of commit time\.
.IP\[bu]
\fIfee-base\fR: A integer that rappresent the value of fee base\.
.IP\[bu]
\fIrescan\fR: A integer that rappresent the number of block that the node must rescan before to run\.
.IP\[bu]
\fIfee-per-satoshi\fR: An integer that rappresent the fee for satoshi\.
.IP\[bu]
\fImax-concurrent-htlcs\fR: A integer that rappresent the number of HTLCs one channel can handle concurrently in each direction\.
.IP\[bu]
\fImin-capacity-sat\fR: A integer that rappresent the minimal effective channel capacity in satoshi to accept for channel opening requests\.
.IP\[bu]
\fIaddr\fR: A string that rappresent the address where the node are listen\.
.IP\[bu]
\fIbind-addr\fR: A string that rappresent the address or UNIX domine socket where the node are listen\.
.IP\[bu]
\fIannounce-addr\fR: A string that rappresent the address where the node is annunced\.
.IP\[bu]
\fIoffline\fR: A boolean value that rappresent if the node is offline\.
.IP\[bu]
\fIautolisten\fR: A boolean value that rappresent if the autolisten is enabled\.
.IP\[bu]
\fIproxy\fR: A string that rappresent the proxy address\.
.IP\[bu]
\fIdisable-dns\fR: A boolean value that rappresent if the dns is disabled\.
.IP\[bu]
\fIenable-autotor-v2-mode\fR: A boolean value that rappresent if the Tor v2 is enabled\.
.IP\[bu]
\fIencrypted-hsm\fR: A boolean value that rappresent if the wallet is encrypted\.
.IP\[bu]
\fIrpc-file-mode\fR: A string that rappresent the value rpc-file-mode\.
.IP\[bu]
\fIlog-level\fR: A string that rappresent the level of log\.
.IP\[bu]
\fIlog-prefix\fR: A string that rappresent the log prefix\.i
.RE
.RE
@ -229,9 +158,10 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
The **listconfigs**teh RPC command to list all configuration options, or with *config*, just that one.
The **listconfigs** RPC command to list all configuration options, or with *config*, just that one.
EXAMPLE JSON REQUEST
EXAMPLE JSON REQUEST
--------------------
--------------------
@ -27,53 +27,18 @@ EXAMPLE JSON REQUEST
RETURN VALUE
RETURN VALUE
------------
------------
On success, an object with the following proprieties is returned:
On success, an object is returned with members reflecting the
corresponding lightningd-config(5) options which were specified in
- *# version*: A string that rappresents the version of node.
the configuration file(s) and command line.
- *lightning-dir*: A string that rappresents the work dir of the node.
- *network*: A string that rappresents the network (e.g: bitcoin).
- *allow-deprecated-apis*: A boolean value that rappresent if the deprecated api are avaible on the node.
- *rpc-file*: A string that rappresent the location of the rpc file.
- *plugins*: A array that rappresent the no important plugin registered. Each object contains the following proprieties:
- *path*: A string that rappresent the path of plugin.
- *name*: A string that rappresent the name of plugin.
- *options*: A object that contains all options accepted from comand line, if the plugin accepted parameters from command line.
- *important-plugins*: An array that rappresent all important pluging registered to the node. Each object contains the same proprieties of *plugin* array.
- *disable-plugin*: An array of string that rappresent the name of plugin disabled.
- *always-use-proxy*: A boolean value that rappresent if the node utilize always the proxy.
- *daemon*: A boolean value is the node have the daemon propriety enabled.
- *wallet*: A string that rappresent the location of wallet with database url convention.
- *wumbo*: A boolean value that rappresent the value of wumbo propriety.
- *rgb*: A string that rappresent the color of the node.
- *alias*: A string that rappresent the alias of the node.
- *pid-file*: A string that rappresent the location of the pid file.
- *ignore-fee-limits*: A boolean value that rappresent is the node ignore the fee limit.
- *watchtime-blocks*: An integer that rappresent the watchtime of the blocks.
- *max-locktime-blocks*: A integer that rappresent that max locktime for blocks.
- *funding-confirms*: An integer that rappresent the number of funding transaction confermation.
- *commit-fee-min*: A integer that rappresent the minimum commit fee.
- *commit-fee-max*: A integer that rappresent the maximum commit fee.
- *cltv-delta*: An integer that rappresent the value of cltv delta.
- *cltv-final*: An integer that rappresent the value of cltv final.
- *commit-time*: An integer that rappresent the value of commit time.
- *fee-base*: A integer that rappresent the value of fee base.
- *rescan*: A integer that rappresent the number of block that the node must rescan before to run.
- *fee-per-satoshi*: An integer that rappresent the fee for satoshi.
- *max-concurrent-htlcs*: A integer that rappresent the number of HTLCs one channel can handle concurrently in each direction.
- *min-capacity-sat*: A integer that rappresent the minimal effective channel capacity in satoshi to accept for channel opening requests.
- *addr*: A string that rappresent the address where the node are listen.
- *bind-addr*: A string that rappresent the address or UNIX domine socket where the node are listen.
- *announce-addr*: A string that rappresent the address where the node is annunced.
- *offline*: A boolean value that rappresent if the node is offline.
- *autolisten*: A boolean value that rappresent if the autolisten is enabled.
- *proxy*: A string that rappresent the proxy address.
- *disable-dns*: A boolean value that rappresent if the dns is disabled.
- *enable-autotor-v2-mode*: A boolean value that rappresent if the Tor v2 is enabled.
- *encrypted-hsm*: A boolean value that rappresent if the wallet is encrypted.
- *rpc-file-mode*: A string that rappresent the value rpc-file-mode.
- *log-level*: A string that rappresent the level of log.
- *log-prefix*: A string that rappresent the log prefix.i
Additional members include:
- *# version*: A string that represents the version of node.
- *plugins*: A array that represents the non-important plugin registered. Each object contains the following members:
- *path*: A string that represents the path of plugin.
- *name*: A string that represents the name of plugin.
- *options*: A object that contains all options accepted from command line or configuration file, if the plugin has opitions
- *important-plugins*: An array that represents all important plugins registered to the node. Each object contains the same members as the *plugin* array.
On failure, one of the following error codes may be returned:
On failure, one of the following error codes may be returned:
@ -183,7 +148,7 @@ Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version o
Rusty Russell
4 years ago