aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-23 09:04:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

lightningd-config.5.txt: working and typos feedback.

Browse Source 
Thanks to @ajtowns and @ZmnSCPxj.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2018-05-17 14:16:22 +09:30
parent 626e9fed16
commit 226f0d63d2
2 changed files with 31 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/lightningd-config.5
View File

@@ -122,9 +122,9 @@ The bitcoind(1) RPC host to connect to\&.
The bitcoind(1) RPC port to connect to\&. The bitcoind(1) RPC port to connect to\&.
.RE .RE
.PP .PP
\fBdefault\-fee\-rate\fR=\fISIPA\fR \fBdefault\-fee\-rate\fR=\fISATOSHIKSIPA\fR
.RS 4 .RS 4
Satoshis per kw if bitcoind can\(cqt estimate fees\&. Satoshis per 1000 transaction weight if bitcoind can\(cqt estimate fees\&.
.RE .RE
.PP .PP
\fBrescan\fR=\fIBLOCKS\fR \fBrescan\fR=\fIBLOCKS\fR
@@ -188,7 +188,7 @@ The base fee to charge for every payment which passes through\&. Note that milli
.PP .PP
\fBfee\-per\-satoshi\fR=\fIMILLIONTHS\fR \fBfee\-per\-satoshi\fR=\fIMILLIONTHS\fR
.RS 4 .RS 4
This is the proportional fee to charge for every payment which passes through\&. As percentages are too course, it\(cqs in millionths, so 10000 is 1 percent, 1000 is 0\&.1%\&. This is the proportional fee to charge for every payment which passes through\&. As percentages are too coarse, it\(cqs in millionths, so 10000 is 1%, 1000 is 0\&.1%\&.
.RE .RE
.PP .PP
\fBignore\-fee\-limits\fR=\fIBOOL\fR \fBignore\-fee\-limits\fR=\fIBOOL\fR
@@ -218,16 +218,19 @@ The longest we\(cqll ever allow a peer to hold up payments, in the worst case\&.
Confirmations required for the funding transaction when the other side opens a channel before the channel is usable\&. Confirmations required for the funding transaction when the other side opens a channel before the channel is usable\&.
.RE .RE
.PP .PP
\fBcommit\-fee\-min\fR=\fIPERCENT\fR, \fBcommit\-fee\-max\fR=\fIPERCENT\fR
.RS 4
Limits on what onchain fee range we\(cqll allow when a node opens a channel with us\&. If they\(cqre outside this range, we abort their opening attempt\&. Note that max can (should!) be greater than 100\&.
.RE
.PP
\fBcommit\-fee\fR=\fIPERCENT\fR \fBcommit\-fee\fR=\fIPERCENT\fR
.RS 4 .RS 4
The percentage of The percentage of
\fIestimatesmartfee 2\fR \fIestimatesmartfee 2\fR
to use for channel funding: can be greater than 100\&. to use for the bitcoin transaction which funds a channel: can be greater than 100\&.
.RE
.PP
\fBcommit\-fee\-min\fR=\fIPERCENT\fR, \fBcommit\-fee\-max\fR=\fIPERCENT\fR
.RS 4
Limits on what onchain fee range we\(cqll allow when a node opens a channel with us, as a percentage of
\fIestimatesmartfee 2\fR\&. If they\(cqre outside this range, we abort their opening attempt\&. Note that
\fBcommit\-fee\-max\fR
can (should!) be greater than 100\&.
.RE .RE
.PP .PP
\fBcltv\-delta\fR=\fIBLOCKS\fR \fBcltv\-delta\fR=\fIBLOCKS\fR
@@ -272,7 +275,7 @@ Set an IP address (v4 or v6) or automatic Tor address to listen on and (maybe) a
.nf .nf
An empty \*(AqIPADDRESS\*(Aq is a special value meaning bind to IPv4 and/or An empty \*(AqIPADDRESS\*(Aq is a special value meaning bind to IPv4 and/or
IPv6 on all interfaces, \*(Aq0\&.0\&.0\&.0\*(Aq means bind to all IPv4 IPv6 on all interfaces, \*(Aq0\&.0\&.0\&.0\*(Aq means bind to all IPv4
interfaces, \*(Aq::\*(Aq means \*(Aqbind to all IPv6 interfaces\*(Aq\&. \*(AqPORT\*(Aq is interfaces, \*(Aq::\*(Aq means \*(Aqbind to all IPv6 interfaces\*(Aq\&. If \*(AqPORT\*(Aq is
not specified, 9735 is used\&. If we can determine a public IP not specified, 9735 is used\&. If we can determine a public IP
address from the resulting binding, the address is announced\&. address from the resulting binding, the address is announced\&.
.fi .fi
@@ -339,10 +342,10 @@ is not specified, a DNS lookup may be done to resolve \*(AqIPADDRESS\*(Aq\&.
.\} .\}
.RE .RE
.PP .PP
\fBannounce\-addr\fR=\fI[IPADDRESS[:PORT]]|TORADDRESS\&.onion[:PORT]\fR \fBannounce\-addr\fR=\fIIPADDRESS[:PORT]|TORADDRESS\&.onion[:PORT]\fR
.RS 4 .RS 4
Set an IP address or Tor address to announce; a Tor address is distinguished by ending in Set an IP address or Tor address to announce; a Tor address is distinguished by ending in
\fI\&.onion\fR, and is \fI\&.onion\fR\&.
\fIPORT\fR \fIPORT\fR
defaults to 9735\&. defaults to 9735\&.
.sp .sp
@@ -364,8 +367,7 @@ announced addresses are sane (ie\&. not localhost)\&.
.nf .nf
This option can be used multiple times to add more addresses, and This option can be used multiple times to add more addresses, and
its use disables autolisten\&. If necessary, and \*(Aqalways\-use\-proxy\*(Aq its use disables autolisten\&. If necessary, and \*(Aqalways\-use\-proxy\*(Aq
is not specified, a DNS lookup may be done to resolve \*(AqIPADDRESS\*(Aq is not specified, a DNS lookup may be done to resolve \*(AqIPADDRESS\*(Aq\&.
or \*(AqTORADDRESS\*(Aq\&.
.fi .fi
.if n \{\ .if n \{\
.RE .RE

30
doc/lightningd-config.5.txt
View File

@@ -86,8 +86,8 @@ Bitcoin control options:
*bitcoin-rpcport*='PORT':: *bitcoin-rpcport*='PORT'::
The bitcoind(1) RPC port to connect to. The bitcoind(1) RPC port to connect to.
*default-fee-rate*='SIPA':: *default-fee-rate*='SATOSHIKSIPA'::
Satoshis per kw if bitcoind can't estimate fees. Satoshis per 1000 transaction weight if bitcoind can't estimate fees.
*rescan*='BLOCKS':: *rescan*='BLOCKS'::
Number of blocks to rescan from the current head, or absolute blockheight Number of blocks to rescan from the current head, or absolute blockheight
@@ -134,8 +134,8 @@ Lightning node customization options:
*fee-per-satoshi*='MILLIONTHS':: *fee-per-satoshi*='MILLIONTHS'::
This is the proportional fee to charge for every payment which passes This is the proportional fee to charge for every payment which passes
through. As percentages are too course, it's in millionths, so 10000 through. As percentages are too coarse, it's in millionths, so 10000
is 1 percent, 1000 is 0.1%. is 1%, 1000 is 0.1%.
*ignore-fee-limits*='BOOL':: *ignore-fee-limits*='BOOL'::
Allow nodes which establish channels to us to set any fee they Allow nodes which establish channels to us to set any fee they
@@ -164,15 +164,16 @@ Lightning channel and HTLC options:
Confirmations required for the funding transaction when the other side Confirmations required for the funding transaction when the other side
opens a channel before the channel is usable. opens a channel before the channel is usable.
*commit-fee*='PERCENT'::
The percentage of 'estimatesmartfee 2' to use for the bitcoin
transaction which funds a channel: can be greater than 100.
*commit-fee-min*='PERCENT':: *commit-fee-min*='PERCENT'::
*commit-fee-max*='PERCENT':: *commit-fee-max*='PERCENT'::
Limits on what onchain fee range we'll allow when a node opens a Limits on what onchain fee range we'll allow when a node opens a
channel with us. If they're outside this range, we abort their channel with us, as a percentage of 'estimatesmartfee 2'. If
opening attempt. Note that max can (should!) be greater than 100. they're outside this range, we abort their opening attempt. Note
that *commit-fee-max* can (should!) be greater than 100.
*commit-fee*='PERCENT'::
The percentage of 'estimatesmartfee 2' to use for channel funding: can
be greater than 100.
*cltv-delta*='BLOCKS':: *cltv-delta*='BLOCKS'::
The number of blocks between incoming payments and outgoing payments: The number of blocks between incoming payments and outgoing payments:
@@ -213,7 +214,7 @@ or precisely control where to bind and what to announce with the
An empty 'IPADDRESS' is a special value meaning bind to IPv4 and/or An empty 'IPADDRESS' is a special value meaning bind to IPv4 and/or
IPv6 on all interfaces, '0.0.0.0' means bind to all IPv4 IPv6 on all interfaces, '0.0.0.0' means bind to all IPv4
interfaces, '::' means 'bind to all IPv6 interfaces'. 'PORT' is interfaces, '::' means 'bind to all IPv6 interfaces'. If 'PORT' is
not specified, 9735 is used. If we can determine a public IP not specified, 9735 is used. If we can determine a public IP
address from the resulting binding, the address is announced. address from the resulting binding, the address is announced.
@@ -243,10 +244,10 @@ or precisely control where to bind and what to announce with the
its use disables autolisten. If necessary, and 'always-use-proxy' its use disables autolisten. If necessary, and 'always-use-proxy'
is not specified, a DNS lookup may be done to resolve 'IPADDRESS'. is not specified, a DNS lookup may be done to resolve 'IPADDRESS'.
*announce-addr*='[IPADDRESS[:PORT]]|TORADDRESS.onion[:PORT]':: *announce-addr*='IPADDRESS[:PORT]|TORADDRESS.onion[:PORT]'::
Set an IP address or Tor address to announce; a Tor address is Set an IP address or Tor address to announce; a Tor address is
distinguished by ending in '.onion', and is 'PORT' defaults to 9735. distinguished by ending in '.onion'. 'PORT' defaults to 9735.
Empty or wildcard IPv4 and IPv6 addresses don't make sense here. Empty or wildcard IPv4 and IPv6 addresses don't make sense here.
Also, unlike the 'addr' option, there is no checking that your Also, unlike the 'addr' option, there is no checking that your
@@ -254,8 +255,7 @@ or precisely control where to bind and what to announce with the
This option can be used multiple times to add more addresses, and This option can be used multiple times to add more addresses, and
its use disables autolisten. If necessary, and 'always-use-proxy' its use disables autolisten. If necessary, and 'always-use-proxy'
is not specified, a DNS lookup may be done to resolve 'IPADDRESS' is not specified, a DNS lookup may be done to resolve 'IPADDRESS'.
or 'TORADDRESS'.
*offline*:: *offline*::
Do not bind to any ports, and do not try to reconnect to any peers. Do not bind to any ports, and do not try to reconnect to any peers.