diff --git a/doc/lightning-autocleaninvoice.7 b/doc/lightning-autocleaninvoice.7 index 4f3d504ee..77643c4e5 100644 --- a/doc/lightning-autocleaninvoice.7 +++ b/doc/lightning-autocleaninvoice.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-AUTOCLEANINVOICE" "7" "" "" "lightning-autocleaninvoice" .SH NAME lightning-autocleaninvoice - Set up auto-delete of expired invoice - -lightning-autocleaninvoice - Set up auto-delete of expired invoice - .SH SYNOPSIS \fBautocleaninvoice\fR [\fIcycle_seconds\fR] [\fIexpired_by\fR] diff --git a/doc/lightning-decodepay.7 b/doc/lightning-decodepay.7 index 859a5a7de..190a5a898 100644 --- a/doc/lightning-decodepay.7 +++ b/doc/lightning-decodepay.7 @@ -15,6 +15,7 @@ specified by the BOLT 11 specification\. On success, an object is returned with the following fields, as specified by BOLT11: +.RS .IP \[bu] \fIcurrency\fR: the BIP173 name for the currency\. .IP \[bu] @@ -31,9 +32,11 @@ specified by BOLT11: \fIdescription\fR: the description of the purpose of the purchase (see below) +.RE The following fields are optional: +.RS .IP \[bu] \fImsatoshi\fR: the number of millisatoshi requested (if any)\. .IP \[bu] @@ -50,6 +53,7 @@ each containing \fIpubkey\fR, \fIshort_channel_id\fR, \fIfee_base_msat\fR, \fIextra\fR: an array of objects representing unknown fields, each with one-character \fItag\fR and a \fIdata\fR bech32 string\. +.RE Technically, the \fIdescription\fR field is optional if a \fIdescription_hash\fR field is given, but in this case \fBdecodepay\fR will diff --git a/doc/lightning-dev-sendcustommsg.7 b/doc/lightning-dev-sendcustommsg.7 index e69de29bb..450307bbc 100644 --- a/doc/lightning-dev-sendcustommsg.7 +++ b/doc/lightning-dev-sendcustommsg.7 @@ -0,0 +1,62 @@ +.TH "LIGHTNING-DEV-SENDCUSTOMMSG" "7" "" "" "lightning-dev-sendcustommsg" +.SH NAME +lightning-dev-sendcustommsg - Low-level interface to send protocol messages to peers +.SH SYNOPSIS + +\fBdev-sendcustommsg\fR \fInode_id\fR \fImsg\fR + +.SH DESCRIPTION + +The \fBdev-sendcustommsg\fR RPC method allows the user to inject a custom message +into the communication with the peer with the given \fBnode_id\fR\. This is +intended as a low-level interface to implement custom protocol extensions on +top, not for direct use by end-users\. + + +The message must be a hex encoded well-formed message, including the 2-byte +type prefix, but excluding the length prefix which will be added by the RPC +method\. The messages must not use even-numbered types, since these may require +synchronous handling on the receiving side, and can cause the connection to be +dropped\. The message types may also not use one of the internally handled +types, since that may cause issues with the internal state tracking of +c-lightning\. + + +The node specified by \fBnode_id\fR must be a peer, i\.e\., it must have a direct +connection with the node receiving the RPC call, and the connection must be +established\. For a method to send arbitrary messages over multiple hops, +including hops that do not understand the custom message, see the +\fBcreateonion\fR and \fBsendonion\fR RPC methods\. Messages can only be injected if +the connection is handled by \fBopeningd\fR or \fBchanneld\fR\. Messages cannot be +injected when the peer is handled by \fBonchaind\fR or \fBclosingd\fR since these do +not have a connection, or are synchronous daemons that do not handle +spontaneous messages\. + + +On the reveiving end a plugin may implement the \fBcustommsg\fR plugin hook and +get notified about incoming messages\. + +.SH RETURN VALUE + +The method will validate the arguments and queue the message for delivery +through the daemon that is currently handling the connection\. Queuing provides +best effort guarantees and the message may not be delivered if the connection +is terminated while the message is queued\. The RPC method will return as soon +as the message is queued\. + + +If any of the above limitations is not respected the method returns an +explicit error message stating the issue\. + +.SH AUTHOR + +Christian Decker \fI is mainly responsible\. + +.SH SEE ALSO + +\fBlightning-createonion\fR(7), \fBlightning-sendonion\fR(7) + +.SH RESOURCES + +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR + diff --git a/doc/lightning-listforwards.7 b/doc/lightning-listforwards.7 index 7a8bf82b6..19359fc69 100644 --- a/doc/lightning-listforwards.7 +++ b/doc/lightning-listforwards.7 @@ -18,6 +18,7 @@ been processed Each entry in \fIforwards\fR will include: +.RS .IP \[bu] \fIin_channel\fR: the short_channel_id of the channel that recieved the incoming htlc\. .IP \[bu] @@ -28,10 +29,12 @@ Each entry in \fIforwards\fR will include: .IP \[bu] \fIreceived_time\fR: timestamp when incoming htlc was received\. +.RE The following additional fields are usually present, but will not be for some variants of status \fIlocal_failed\fR (if it failed before we determined these): +.RS .IP \[bu] \fIout_channel\fR: the short_channel_id of to which the outgoing htlc is supposed to be forwarded\. .IP \[bu] @@ -39,18 +42,23 @@ variants of status \fIlocal_failed\fR (if it failed before we determined these): .IP \[bu] \fIout_msatoshi\fR, \fIout_msat\fR - amount of msatoshis to be forwarded\. +.RE The following fields may be offered, but for old forgotten HTLCs they will be omitted: +.RS .IP \[bu] \fIpayment_hash\fR - the payment_hash belonging to the HTLC\. +.RE If the status is not 'offered', the following additional fields are present: +.RS .IP \[bu] \fIresolved_time\fR - timestamp when htlc was resolved (settled or failed)\. +.RE .SH AUTHOR Rene Pickhardt \fI is mainly responsible\. @@ -63,7 +71,3 @@ Rene Pickhardt \fI is mainly responsible\. Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -.HL - -Last updated 2019-07-23 00:53:16 CEST - diff --git a/doc/lightning-pay.7 b/doc/lightning-pay.7 index 714585710..d9ec86e50 100644 --- a/doc/lightning-pay.7 +++ b/doc/lightning-pay.7 @@ -21,7 +21,7 @@ The \fIlabel\fR field is used to attach a label to payments, and is returned in \fBlightning-listpays\fR(7) and \fBlightning-listsendpays\fR(7)\. The \fIriskfactor\fR is described in detail in \fBlightning-getroute\fR(7), and defaults to 10\. The \fImaxfeepercent\fR limits the money paid in fees, and defaults to 0\.5\. The -\fBmaxfeepercent' is a percentage of the amount that is to be paid. The `exemptfee\fR +\fBmaxfeepercent\fR is a percentage of the amount that is to be paid\. The \fBexemptfee\fR option can be used for tiny payments which would be dominated by the fee leveraged by forwarding nodes\. Setting \fBexemptfee\fR allows the \fBmaxfeepercent\fR check to be skipped on fees that are smaller than diff --git a/doc/lightning-plugin.7 b/doc/lightning-plugin.7 index f1e86968f..9473ade06 100644 --- a/doc/lightning-plugin.7 +++ b/doc/lightning-plugin.7 @@ -48,7 +48,7 @@ plugin is returned\. .SH AUTHOR -Antoine Poinsot (\fIdarosior@protonmail.com\fR) is mainly responsible\. +Antoine Poinsot \fI is mainly responsible\. .SH RESOURCES diff --git a/doc/lightning-setchannelfee.7 b/doc/lightning-setchannelfee.7 index 6c7d41750..97270aa97 100644 --- a/doc/lightning-setchannelfee.7 +++ b/doc/lightning-setchannelfee.7 @@ -43,12 +43,14 @@ array \fIchannels\fR which contains objects with fields \fIpeer_id\fR, The following error codes may occur: +.RS .IP \[bu] -1: Channel is in incorrect state, i\.e\. Catchall nonspecific error\. .IP \[bu] -32602: JSONRPC2_INVALID_PARAMS, i\.e\. Given id is not a channel ID or short channel ID\. +.RE .SH AUTHOR Michael Schmoock \fI is the author of this @@ -64,7 +66,3 @@ responsible for the c-lightning project\. Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -.HL - -Last updated 2019-04-30 17:34:18 CEST - diff --git a/doc/lightning-txdiscard.7 b/doc/lightning-txdiscard.7 index 80b016f14..6abda8ee9 100644 --- a/doc/lightning-txdiscard.7 +++ b/doc/lightning-txdiscard.7 @@ -24,9 +24,11 @@ implicitly calls \fBtxdiscard\fR on all outputs\. The following error codes may occur: +.RS .IP \[bu] -1: An unknown \fItxid\fR\. +.RE .SH AUTHOR Rusty Russell \fI is mainly responsible\. @@ -39,7 +41,3 @@ Rusty Russell \fI is mainly responsible\. Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -.HL - -Last updated 2019-06-08 16:03:59 CEST - diff --git a/doc/lightning-txsend.7 b/doc/lightning-txsend.7 index 119dafc3c..c3647fb1d 100644 --- a/doc/lightning-txsend.7 +++ b/doc/lightning-txsend.7 @@ -25,9 +25,11 @@ the transaction are unreserved\. The following error codes may occur: +.RS .IP \[bu] -1: Catchall nonspecific error\. +.RE .SH AUTHOR Rusty Russell \fI is mainly responsible\. diff --git a/doc/lightning-waitblockheight.7 b/doc/lightning-waitblockheight.7 index 72f88f796..e5bf78b63 100644 --- a/doc/lightning-waitblockheight.7 +++ b/doc/lightning-waitblockheight.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-WAITBLOCKHEIGHT" "7" "" "" "lightning-waitblockheight" .SH NAME -lightning-waitblockheight -- Command for waiting for blocks on the blockchain - -lightning-waitblockheight -- Command for waiting for blocks on the blockchain - +lightning-waitblockheight - Command for waiting for blocks on the blockchain .SH SYNOPSIS \fBwaitblockheight\fR \fIblockheight\fR [\fItimeout\fR] @@ -11,24 +8,26 @@ lightning-waitblockheight -- Command for waiting for blocks on the blockchain .SH DESCRIPTION The \fBwaitblockheight\fR RPC command waits until the blockchain -has reached the specified \fIblockheight\fR. -It will only wait up to \fItimeout\fR seconds (default 60). +has reached the specified \fIblockheight\fR\. +It will only wait up to \fItimeout\fR seconds (default 60)\. + If the \fIblockheight\fR is a present or past block height, then this -command returns immediately. +command returns immediately\. .SH RETURN VALUE Once the specified block height has been achieved by the blockchain, an object with the single field \fIblockheight\fR is returned, which is -the block height at the time the command returns. +the block height at the time the command returns\. + If \fItimeout\fR seconds is reached without the specified blockheight -being reached, this command will fail. +being reached, this command will fail\. .SH AUTHOR -ZmnSCPxj <\fIZmnSCPxj@protonmail.com\fR> is mainly responsible. +ZmnSCPxj \fI is mainly responsible\. .SH RESOURCES diff --git a/doc/lightning-withdraw.7 b/doc/lightning-withdraw.7 index 29e8d6bbc..e4a2317b1 100644 --- a/doc/lightning-withdraw.7 +++ b/doc/lightning-withdraw.7 @@ -1,6 +1,6 @@ .TH "LIGHTNING-WITHDRAW" "7" "" "" "lightning-withdraw" .SH NAME - +lightning-withdraw - Command for withdrawing funds from the internal wallet .SH SYNOPSIS \fBwithdraw\fR \fIdestination\fR \fIsatoshi\fR [\fIfeerate\fR] [\fIminconf\fR] [\fIutxos\fR] @@ -68,7 +68,7 @@ fees) to create the transaction\. .RE .SH AUTHOR -Felix \fBNone\fR (\fI is mainly responsible\. +Felix \fI is mainly responsible\. .SH SEE ALSO @@ -77,5 +77,5 @@ Felix \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR