diff --git a/doc/lightning-close.7 b/doc/lightning-close.7 index a5535c773..86ecd7e21 100644 --- a/doc/lightning-close.7 +++ b/doc/lightning-close.7 @@ -3,12 +3,13 @@ lightning-close - Command for closing channels with direct peers .SH SYNOPSIS -\fBclose\fR \fIid\fR [\fIunilateraltimeout\fR] +\fBclose\fR \fIid\fR [\fIunilateraltimeout\fR] [\fIdestination\fR] .SH DESCRIPTION The \fBclose\fR RPC command attempts to close the channel cooperatively -with the peer, or unilaterally after \fIunilateraltimeout\fR\. +with the peer, or unilaterally after \fIunilateraltimeout\fR, and the +to-local output will be sent to the address specified in \fIdestination\fR\. If the given \fIid\fR is a peer ID (66 hex digits as a string), then it @@ -25,6 +26,10 @@ indefinitely until the peer is online and can negotiate a mutual close\. The default is 2 days (172800 seconds)\. +The \fIdestination\fR can be of any Bitcoin accepted type, including bech32\. +If it isn't specified, the default is a c-lightning wallet address\. + + The peer needs to be live and connected in order to negotiate a mutual close\. The default of unilaterally closing after 48 hours is usually a reasonable indication that you can no longer contact the peer\. diff --git a/doc/lightning-close.7.md b/doc/lightning-close.7.md index 9c36ce1b0..9f62f8346 100644 --- a/doc/lightning-close.7.md +++ b/doc/lightning-close.7.md @@ -4,13 +4,14 @@ lightning-close -- Command for closing channels with direct peers SYNOPSIS -------- -**close** *id* \[*unilateraltimeout*\] +**close** *id* \[*unilateraltimeout*\] \[*destination*\] DESCRIPTION ----------- The **close** RPC command attempts to close the channel cooperatively -with the peer, or unilaterally after *unilateraltimeout*. +with the peer, or unilaterally after *unilateraltimeout*, and the +to-local output will be sent to the address specified in *destination*. If the given *id* is a peer ID (66 hex digits as a string), then it applies to the active channel of the direct peer corresponding to the @@ -24,6 +25,9 @@ If *unilateraltimeout* is zero, then the **close** command will wait indefinitely until the peer is online and can negotiate a mutual close. The default is 2 days (172800 seconds). +The *destination* can be of any Bitcoin accepted type, including bech32. +If it isn't specified, the default is a c-lightning wallet address. + The peer needs to be live and connected in order to negotiate a mutual close. The default of unilaterally closing after 48 hours is usually a reasonable indication that you can no longer contact the peer.