lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: Use subsections for option types. 

And drive-by fix "if it's seems" to "if it seems".

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
plugin-6
Rusty Russell 6 years ago
committed by Christian Decker
parent
d7e94a9386
commit
31830ea6bb
2 changed files with 20 additions and 20 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 23
      doc/lightningd-config.5
  2. 17
      doc/lightningd-config.5.txt

23
doc/lightningd-config.5
View File

@ -1,13 +1,13 @@
'\" t '\" t
.\" Title: lightningd-config .\" Title: lightningd-config
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 11/22/2018 .\" Date: 12/03/2018
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNINGD\-CONFIG" "5" "11/22/2018" "\ \&" "\ \&" .TH "LIGHTNINGD\-CONFIG" "5" "12/03/2018" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -47,8 +47,7 @@ Blank lines and lines beginning with \fI#\fR are ignored\&.
.sp .sp
The lightning\-listconfigs(7) command will output a valid configuration file using the current settings\&. The lightning\-listconfigs(7) command will output a valid configuration file using the current settings\&.
.SH "OPTIONS" .SH "OPTIONS"
.sp .SS "General options"
General options:
.PP .PP
\fBallow\-deprecated\-apis\fR=\fIBOOL\fR \fBallow\-deprecated\-apis\fR=\fIBOOL\fR
.RS 4 .RS 4
@ -126,8 +125,7 @@ The bitcoind(1) RPC port to connect to\&.
.RS 4 .RS 4
Number of blocks to rescan from the current head, or absolute blockheight if negative\&. This is only needed if something goes badly wrong\&. Number of blocks to rescan from the current head, or absolute blockheight if negative\&. This is only needed if something goes badly wrong\&.
.RE .RE
.sp .SS "Lightning daemon options"
Lightning daemon options:
.PP .PP
\fBlightning\-dir\fR=\fIDIR\fR \fBlightning\-dir\fR=\fIDIR\fR
.RS 4 .RS 4
@ -181,8 +179,7 @@ must exist and be readable (we allow missing files in the default case)\&. Using
.RS 4 .RS 4
Specify a plugin to run as part of c\-lightning\&. This can be specified multiple times and may enable additional configuration options and JSON\-RPC methods, depending on the plugin\&. Specify a plugin to run as part of c\-lightning\&. This can be specified multiple times and may enable additional configuration options and JSON\-RPC methods, depending on the plugin\&.
.RE .RE
.sp .SS "Lightning node customization options"
Lightning node customization options:
.PP .PP
\fBrgb\fR=\fIRRGGBB\fR \fBrgb\fR=\fIRRGGBB\fR
.RS 4 .RS 4
@ -213,8 +210,7 @@ Allow nodes which establish channels to us to set any fee they want\&. This may
.RS 4 .RS 4
How long to wait before sending commitment messages to the peer: in theory increasing this would reduce load, but your node would have to be extremely busy node for you to even notice\&. How long to wait before sending commitment messages to the peer: in theory increasing this would reduce load, but your node would have to be extremely busy node for you to even notice\&.
.RE .RE
.sp .SS "Lightning channel and HTLC options"
Lightning channel and HTLC options:
.PP .PP
\fBwatchtime\-blocks\fR=\fIBLOCKS\fR \fBwatchtime\-blocks\fR=\fIBLOCKS\fR
.RS 4 .RS 4
@ -273,10 +269,9 @@ Control how long invoices must have been expired before they are cleaned (if
\fIautocleaninvoice\-cycle\fR \fIautocleaninvoice\-cycle\fR
is non\-zero)\&. is non\-zero)\&.
.RE .RE
.SS "Networking options"
.sp .sp
Networking options: Note that for simple setups, the implicit \fIautolisten\fR option does the right thing: it will try to bind to port 9735 on IPv4 and IPv6, and will announce it to peers if it seems like a public address\&.
.sp
Note that for simple setups, the implicit \fIautolisten\fR option does the right thing: it will try to bind to port 9735 on IPv4 and IPv6, and will announce it to peers if it\(cqs seems like a public address\&.
.sp .sp
You can instead use \fIaddr\fR to override this (eg\&. to change the port), or precisely control where to bind and what to announce with the \fIbind\-addr\fR and \fIannounce\-addr\fR options\&. These will \fBdisable\fR the \fIautolisten\fR logic, so you must specifiy exactly what you want! You can instead use \fIaddr\fR to override this (eg\&. to change the port), or precisely control where to bind and what to announce with the \fIbind\-addr\fR and \fIannounce\-addr\fR options\&. These will \fBdisable\fR the \fIautolisten\fR logic, so you must specifiy exactly what you want!
.PP .PP

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

@ -42,7 +42,8 @@ file using the current settings.
OPTIONS OPTIONS
------- -------
General options: General options
~~~~~~~~~~~~~~~
*allow-deprecated-apis*='BOOL':: *allow-deprecated-apis*='BOOL'::
Enable deprecated options, JSONRPC commands, fields, etc. It Enable deprecated options, JSONRPC commands, fields, etc. It
@ -91,7 +92,8 @@ Bitcoin control options:
Number of blocks to rescan from the current head, or absolute blockheight Number of blocks to rescan from the current head, or absolute blockheight
if negative. This is only needed if something goes badly wrong. if negative. This is only needed if something goes badly wrong.
Lightning daemon options: Lightning daemon options
~~~~~~~~~~~~~~~~~~~~~~~~
*lightning-dir*='DIR':: *lightning-dir*='DIR'::
Sets the working directory. All files (except '--conf' on the command Sets the working directory. All files (except '--conf' on the command
@ -129,7 +131,8 @@ Lightning daemon options:
multiple times and may enable additional configuration options and JSON-RPC multiple times and may enable additional configuration options and JSON-RPC
methods, depending on the plugin. methods, depending on the plugin.
Lightning node customization options: Lightning node customization options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*rgb*='RRGGBB':: *rgb*='RRGGBB'::
Your favorite color as a hex code. Your favorite color as a hex code.
@ -160,7 +163,8 @@ Lightning node customization options:
theory increasing this would reduce load, but your node would have to be theory increasing this would reduce load, but your node would have to be
extremely busy node for you to even notice. extremely busy node for you to even notice.
Lightning channel and HTLC options: Lightning channel and HTLC options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*watchtime-blocks*='BLOCKS':: *watchtime-blocks*='BLOCKS'::
How long we need to spot an outdated close attempt: on opening a channel How long we need to spot an outdated close attempt: on opening a channel
@ -210,11 +214,12 @@ Invoice control options:
Control how long invoices must have been expired before they are Control how long invoices must have been expired before they are
cleaned (if 'autocleaninvoice-cycle' is non-zero). cleaned (if 'autocleaninvoice-cycle' is non-zero).
Networking options: Networking options
~~~~~~~~~~~~~~~~~~
Note that for simple setups, the implicit 'autolisten' option does the Note that for simple setups, the implicit 'autolisten' option does the
right thing: it will try to bind to port 9735 on IPv4 and IPv6, and right thing: it will try to bind to port 9735 on IPv4 and IPv6, and
will announce it to peers if it's seems like a public address. will announce it to peers if it seems like a public address.
You can instead use 'addr' to override this (eg. to change the port), You can instead use 'addr' to override this (eg. to change the port),
or precisely control where to bind and what to announce with the or precisely control where to bind and what to announce with the

Write Preview
Loading…
Cancel
Save