Better describe "urgent", "normal" and "slow" feerates

leshik · May 25, 2019 · 441c571 · 441c571
1 parent bbec8f6
commit 441c571
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 8 deletions.
diff --git a/doc/lightning-fundchannel.7 b/doc/lightning-fundchannel.7
@@ -2,12 +2,12 @@
 .\"     Title: lightning-fundchannel
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 04/08/2019
+.\"      Date: 05/24/2019
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "LIGHTNING\-FUNDCHANN" "7" "04/08/2019" "\ \&" "\ \&"
+.TH "LIGHTNING\-FUNDCHANN" "7" "05/24/2019" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -40,7 +40,7 @@ The \fBfundchannel\fR RPC command opens a payment channel with a peer by committ
 .sp
 \fIsatoshi\fR is the amount in satoshis taken from the internal wallet to fund the channel\&. The string \fIall\fR can be used to specify all available funds (or 16777215 satoshi if more is available)\&. Otherwise, it is in satoshi precision; it can be a whole number, a whole number ending in \fIsat\fR, a whole number ending in \fI000msat\fR, or a number with 1 to 8 decimal places ending in \fIbtc\fR\&. The value cannot be less than the dust limit, currently set to 546, nor more than 16777215 satoshi\&.
 .sp
-\fIfeerate\fR is an optional feerate used for the opening transaction and as initial feerate for commitment and HTLC transactions\&. It can be one of the strings \fIurgent\fR, \fInormal\fR or \fIslow\fR to use lightningd\(cqs internal estimates: \fInormal\fR is the default\&.
+\fIfeerate\fR is an optional feerate used for the opening transaction and as initial feerate for commitment and HTLC transactions\&. It can be one of the strings \fIurgent\fR (aim for next block), \fInormal\fR (next 4 blocks or so) or \fIslow\fR (next 100 blocks or so) to use lightningd\(cqs internal estimates: \fInormal\fR is the default\&.
 .sp
 \fIannounce\fR is an optional flag that triggers whether to announce this channel or not\&. Defaults to true\&. An unannounced channel is considered private\&.
 .sp

diff --git a/doc/lightning-fundchannel.7.txt b/doc/lightning-fundchannel.7.txt
@@ -30,7 +30,8 @@ than 16777215 satoshi.
 
 'feerate' is an optional feerate used for the opening transaction and as initial feerate for
 commitment and HTLC transactions.  It can be one of the strings
-'urgent', 'normal' or 'slow' to use lightningd's internal estimates:
+'urgent' (aim for next block), 'normal' (next 4 blocks or so) or 'slow' (next
+100 blocks or so) to use lightningd's internal estimates:
 'normal' is the default.
 
 'announce' is an optional flag that triggers whether to announce

diff --git a/doc/lightning-withdraw.7 b/doc/lightning-withdraw.7
@@ -2,12 +2,12 @@
 .\"     Title: lightning-withdraw
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 04/08/2019
+.\"      Date: 05/24/2019
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "LIGHTNING\-WITHDRAW" "7" "04/08/2019" "\ \&" "\ \&"
+.TH "LIGHTNING\-WITHDRAW" "7" "05/24/2019" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -40,7 +40,7 @@ The address can be of any Bitcoin accepted type, including bech32\&.
 .sp
 \fIsatoshi\fR is the amount to be withdrawn from the internal wallet (expressed, as name suggests, in satoshi)\&. The string \fIall\fR can be used to specify withdrawal of all available funds\&. Otherwise, it is in satoshi precision; it can be a whole number, a whole number ending in \fIsat\fR, a whole number ending in \fI000msat\fR, or a number with 1 to 8 decimal places ending in \fIbtc\fR\&.
 .sp
-\fIfeerate\fR is an optional feerate to use\&. It can be one of the strings \fIurgent\fR, \fInormal\fR or \fIslow\fR to use lightningd\(cqs internal estimates: \fInormal\fR is the default\&.
+\fIfeerate\fR is an optional feerate to use\&. It can be one of the strings \fIurgent\fR (aim for next block), \fInormal\fR (next 4 blocks or so) or \fIslow\fR (next 100 blocks or so) to use lightningd\(cqs internal estimates: \fInormal\fR is the default\&.
 .sp
 Otherwise, \fIfeerate\fR is a number, with an optional suffix: \fIperkw\fR means the number is interpreted as satoshi\-per\-kilosipa (weight), and \fIperkb\fR means it is interpreted bitcoind\-style as satoshi\-per\-kilobyte\&. Omitting the suffix is equivalent to \fIperkb\fR\&.
 .sp

diff --git a/doc/lightning-withdraw.7.txt b/doc/lightning-withdraw.7.txt
@@ -25,7 +25,8 @@ The string 'all' can be used to specify withdrawal of all
 available funds.  Otherwise, it is in satoshi precision; it can be a whole number, a whole number ending in 'sat', a whole number ending in '000msat', or a number with 1 to 8 decimal places ending in 'btc'.
 
 'feerate' is an optional feerate to use.  It can be one of the strings
-'urgent', 'normal' or 'slow' to use lightningd's internal estimates:
+'urgent' (aim for next block), 'normal' (next 4 blocks or so) or 'slow' (next
+100 blocks or so) to use lightningd's internal estimates:
 'normal' is the default.
 
 Otherwise, 'feerate' is a number, with an optional suffix: