diff --git a/doc/Makefile b/doc/Makefile index ea9bd5b76..f0fdfa992 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -44,7 +44,7 @@ MANPAGES := doc/lightning-cli.1 \ doc-all: $(MANPAGES) doc/index.rst $(MANPAGES): doc/%: doc/%.md - @if $(CHANGED_FROM_GIT); then echo mrkd $<; mrkd $<; else touch $@; fi + if $(CHANGED_FROM_GIT); then mrkd $< $@; else touch $@; fi doc/protocol-%.svg: test/test_protocol test/test_protocol --svg < test/commits/$*.script > $@ @@ -91,6 +91,6 @@ doc-clean: $(RM) doc/deployable-lightning.{aux,bbl,blg,dvi,log,out,tex} doc/index.rst: - (grep -v '^ lightning-.*\.[0-9]\.md>$$' $@; for m in $$(cd doc && ls lightning*.[0-9].md | sort); do echo " $$(echo $$m | sed 's/.[0-9].md//') <$$m>"; done) > $@.tmp.$$$$ && mv $@.tmp.$$$$ $@ + (grep -v '^ lightning.*\.[0-9]\.md>$$' $@; for m in $$(cd doc && ls lightning*.[0-9].md | sort); do echo " $$(echo $$m | sed 's/.[0-9].md//') <$$m>"; done) > $@.tmp.$$$$ && mv $@.tmp.$$$$ $@ .PHONY: doc/index.rst diff --git a/doc/index.rst b/doc/index.rst index db17697c6..9ad2886be 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -27,6 +27,10 @@ c-lightning Documentation :maxdepth: 1 :caption: Manpages + lightningd + lightningd-config + lightningd + lightningd-config lightning-autocleaninvoice lightning-check lightning-cli diff --git a/doc/lightning-autocleaninvoice.7 b/doc/lightning-autocleaninvoice.7 index 0756cced8..4f3d504ee 100644 --- a/doc/lightning-autocleaninvoice.7 +++ b/doc/lightning-autocleaninvoice.7 @@ -1,6 +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 @@ -32,7 +32,7 @@ On success, an empty object is returned\. .SH AUTHOR -ZmnSCPxj \fBNone\fR (\fI is mainly responsible\. +ZmnSCPxj \fI is mainly responsible\. .SH SEE ALSO @@ -40,9 +40,5 @@ ZmnSCPxj \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-07 14:23:17 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-autocleaninvoice.7.md b/doc/lightning-autocleaninvoice.7.md index 93efb51fb..77925198d 100644 --- a/doc/lightning-autocleaninvoice.7.md +++ b/doc/lightning-autocleaninvoice.7.md @@ -1,6 +1,5 @@ -LIGHTNING-AUTOCLEANINVOICE(7) Manual Page -========================================= -lightning-autocleaninvoice - Set up auto-delete of expired invoice +lightning-autocleaninvoice -- Set up auto-delete of expired invoice +=================================================================== SYNOPSIS -------- @@ -42,7 +41,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-07 14:23:17 CEST diff --git a/doc/lightning-check.7 b/doc/lightning-check.7 index 95aac6930..7e8c41820 100644 --- a/doc/lightning-check.7 +++ b/doc/lightning-check.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-CHECK" "7" "" "" "lightning-check" .SH NAME - - lightning-check - Command for verifying parameters - .SH SYNOPSIS \fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR] @@ -31,14 +28,10 @@ relevant RPC error is returned\. .SH AUTHOR -Mark Beckwith \fBNone\fR (\fI and Rusty Russell -\fBNone\fR (\fI are mainly responsible\. +Mark Beckwith \fI and Rusty Russell +\fI are mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-30 17:12:10 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-check.7.md b/doc/lightning-check.7.md index 49e5d77ca..0c8dc2435 100644 --- a/doc/lightning-check.7.md +++ b/doc/lightning-check.7.md @@ -1,6 +1,5 @@ -LIGHTNING-CHECK(7) Manual Page +lightning-check -- Command for verifying parameters ============================== -lightning-check - Command for verifying parameters SYNOPSIS -------- @@ -37,7 +36,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:12:10 CEST diff --git a/doc/lightning-cli.1 b/doc/lightning-cli.1 index 12018b82c..e3055cff7 100644 --- a/doc/lightning-cli.1 +++ b/doc/lightning-cli.1 @@ -1,9 +1,6 @@ .TH "LIGHTNING-CLI" "1" "" "" "lightning-cli" .SH NAME - - lightning-cli - Control lightning daemon - .SH SYNOPSIS \fBlightning-cli\fR [\fIOPTIONS\fR] \fIcommand\fR… @@ -83,18 +80,14 @@ pretty printing of results isn’t pretty\. .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly to blame\. +Rusty Russell \fI is mainly to blame\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR .SH COPYING Note: the modules in the ccan/ directory have their own licenses, but the rest of the code is covered by the BSD-style MIT license\. -.HL - -Last updated 2019-04-30 17:39:53 CEST - diff --git a/doc/lightning-cli.1.md b/doc/lightning-cli.1.md index 0d350b167..e56acd793 100644 --- a/doc/lightning-cli.1.md +++ b/doc/lightning-cli.1.md @@ -1,6 +1,5 @@ -LIGHTNING-CLI(1) Manual Page -============================ -lightning-cli - Control lightning daemon +lightning-cli -- Control lightning daemon +========================================= SYNOPSIS -------- @@ -91,7 +90,3 @@ COPYING Note: the modules in the ccan/ directory have their own licenses, but the rest of the code is covered by the BSD-style MIT license. - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:39:53 CEST diff --git a/doc/lightning-close.7 b/doc/lightning-close.7 index 0c3a6825b..a5535c773 100644 --- a/doc/lightning-close.7 +++ b/doc/lightning-close.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-CLOSE" "7" "" "" "lightning-close" .SH NAME - - lightning-close - Command for closing channels with direct peers - .SH SYNOPSIS \fBclose\fR \fIid\fR [\fIunilateraltimeout\fR] @@ -59,7 +56,7 @@ vary based on the peer \fIto_self_delay\fR setting, not your own setting\. .SH AUTHOR -ZmnSCPxj \fBNone\fR (\fI is mainly responsible\. +ZmnSCPxj \fI is mainly responsible\. .SH SEE ALSO @@ -67,9 +64,5 @@ ZmnSCPxj \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-08-09 11:12:04 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-close.7.md b/doc/lightning-close.7.md index a25eacd5b..9c36ce1b0 100644 --- a/doc/lightning-close.7.md +++ b/doc/lightning-close.7.md @@ -1,6 +1,5 @@ -LIGHTNING-CLOSE(7) Manual Page -============================== -lightning-close - Command for closing channels with direct peers +lightning-close -- Command for closing channels with direct peers +================================================================= SYNOPSIS -------- @@ -68,7 +67,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-08-09 11:12:04 CEST diff --git a/doc/lightning-connect.7 b/doc/lightning-connect.7 index c41e65e57..7bec09eb9 100644 --- a/doc/lightning-connect.7 +++ b/doc/lightning-connect.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-CONNECT" "7" "" "" "lightning-connect" .SH NAME - - -lightning-connect - Command for connecting to another lightning node\. - +lightning-connect - Command for connecting to another lightning node .SH SYNOPSIS \fBconnect\fR \fIid\fR [\fIhost\fR \fIport\fR] @@ -46,17 +43,15 @@ On success the peer \fIid\fR is returned\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. This may occur if the host is not valid or there are problems communicating with the peer\. \fBconnect\fR will make up to 10 attempts to connect to the peer before giving up\. -.RE .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. -Felix \fBNone\fR (\fI is the original author of this manpage\. +Rusty Russell \fI is mainly responsible\. +Felix \fI is the original author of this manpage\. .SH SEE ALSO @@ -65,9 +60,5 @@ Felix \fBNone\fR (\fI is the original author of this manpa .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-08-01 14:59:36 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-connect.7.md b/doc/lightning-connect.7.md index c3658479a..6f21176d1 100644 --- a/doc/lightning-connect.7.md +++ b/doc/lightning-connect.7.md @@ -1,6 +1,5 @@ -LIGHTNING-CONNECT(7) Manual Page -================================ -lightning-connect - Command for connecting to another lightning node. +lightning-connect -- Command for connecting to another lightning node +===================================================================== SYNOPSIS -------- @@ -59,7 +58,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-08-01 14:59:36 CEST diff --git a/doc/lightning-decodepay.7 b/doc/lightning-decodepay.7 index e399fa60f..859a5a7de 100644 --- a/doc/lightning-decodepay.7 +++ b/doc/lightning-decodepay.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-DECODEPAY" "7" "" "" "lightning-decodepay" .SH NAME - - lightning-decodepay - Command for decoding a bolt11 string (low-level) - .SH SYNOPSIS \fBdecodepay\fR \fIbolt11\fR [\fIdescription\fR] @@ -18,7 +15,6 @@ 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] @@ -35,11 +31,9 @@ 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] @@ -56,7 +50,6 @@ 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 @@ -65,7 +58,7 @@ the \fIdescription_hash\fR\. In practice, these are currently unused\. .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -77,9 +70,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-30 17:12:10 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-decodepay.7.md b/doc/lightning-decodepay.7.md index c7167ba07..c1f17c988 100644 --- a/doc/lightning-decodepay.7.md +++ b/doc/lightning-decodepay.7.md @@ -1,6 +1,5 @@ -LIGHTNING-DECODEPAY(7) Manual Page -================================== -lightning-decodepay - Command for decoding a bolt11 string (low-level) +lightning-decodepay -- Command for decoding a bolt11 string (low-level) +======================================================================= SYNOPSIS -------- @@ -61,7 +60,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:12:10 CEST diff --git a/doc/lightning-delexpiredinvoice.7 b/doc/lightning-delexpiredinvoice.7 index e39778922..d5825fcfc 100644 --- a/doc/lightning-delexpiredinvoice.7 +++ b/doc/lightning-delexpiredinvoice.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-DELEXPIREDINVOICE" "7" "" "" "lightning-delexpiredinvoice" .SH NAME - - -lightning-delexpiredinvoice - Command for removing expired invoices\. - +lightning-delexpiredinvoice - Command for removing expired invoices .SH SYNOPSIS \fBdelexpiredinvoice\fR [\fImaxexpirytime\fR] @@ -23,7 +20,7 @@ On success, an empty object is returned\. .SH AUTHOR -ZmnSCPxj \fBNone\fR (\fI is mainly responsible\. +ZmnSCPxj \fI is mainly responsible\. .SH SEE ALSO @@ -31,9 +28,5 @@ ZmnSCPxj \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-07 14:23:17 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-delexpiredinvoice.7.md b/doc/lightning-delexpiredinvoice.7.md index 99bcfdd37..2e3179ce4 100644 --- a/doc/lightning-delexpiredinvoice.7.md +++ b/doc/lightning-delexpiredinvoice.7.md @@ -1,6 +1,5 @@ -LIGHTNING-DELEXPIREDINVOICE(7) Manual Page -========================================== -lightning-delexpiredinvoice - Command for removing expired invoices. +lightning-delexpiredinvoice -- Command for removing expired invoices +==================================================================== SYNOPSIS -------- @@ -35,7 +34,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-07 14:23:17 CEST diff --git a/doc/lightning-delinvoice.7 b/doc/lightning-delinvoice.7 index 0baee5c2e..fd6a7ea64 100644 --- a/doc/lightning-delinvoice.7 +++ b/doc/lightning-delinvoice.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-DELINVOICE" "7" "" "" "lightning-delinvoice" .SH NAME - - -lightning-delinvoice - Command for removing an invoice\. - +lightning-delinvoice - Command for removing an invoice .SH SYNOPSIS \fBdelinvoice\fR \fIlabel\fR \fIstatus\fR @@ -24,7 +21,7 @@ On success, an invoice description will be returned as per .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -34,9 +31,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-07 14:23:17 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-delinvoice.7.md b/doc/lightning-delinvoice.7.md index 0f85d2665..791b2966a 100644 --- a/doc/lightning-delinvoice.7.md +++ b/doc/lightning-delinvoice.7.md @@ -1,6 +1,5 @@ -LIGHTNING-DELINVOICE(7) Manual Page -=================================== -lightning-delinvoice - Command for removing an invoice. +lightning-delinvoice -- Command for removing an invoice +======================================================= SYNOPSIS -------- @@ -38,7 +37,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-07 14:23:17 CEST diff --git a/doc/lightning-disconnect.7 b/doc/lightning-disconnect.7 index 48c5ceff3..0427adb68 100644 --- a/doc/lightning-disconnect.7 +++ b/doc/lightning-disconnect.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-DISCONNECT" "7" "" "" "lightning-disconnect" .SH NAME - - -lightning-disconnect - Command for disconnecting from another lightning -node\. - +lightning-disconnect - Command for disconnecting from another lightning node .SH SYNOPSIS \fBdisconnect\fR \fIid\fR [\fIforce\fR] @@ -70,7 +66,7 @@ message will be returned: .fi .SH AUTHOR -Michael Hawkins \fBNone\fR (\fI\. +Michael Hawkins \fI\. .SH SEE ALSO @@ -78,9 +74,5 @@ Michael Hawkins \fBNone\fR (\fI\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-30 17:34:18 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-disconnect.7.md b/doc/lightning-disconnect.7.md index aba35da2b..05754f337 100644 --- a/doc/lightning-disconnect.7.md +++ b/doc/lightning-disconnect.7.md @@ -1,7 +1,5 @@ -LIGHTNING-DISCONNECT(7) Manual Page -=================================== -lightning-disconnect - Command for disconnecting from another lightning -node. +lightning-disconnect -- Command for disconnecting from another lightning node +============================================================================= SYNOPSIS -------- @@ -63,7 +61,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:34:18 CEST diff --git a/doc/lightning-fundchannel.7 b/doc/lightning-fundchannel.7 index 97e2d1c13..0ccdeb0a6 100644 --- a/doc/lightning-fundchannel.7 +++ b/doc/lightning-fundchannel.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-FUNDCHANNEL" "7" "" "" "lightning-fundchannel" .SH NAME - - -lightning-fundchannel - Command for establishing a lightning channel\. - +lightning-fundchannel - Command for establishing a lightning channel .SH SYNOPSIS \fBfundchannel\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR \fIannounce\fR] [\fIminconf\fR] @@ -66,7 +63,6 @@ is reported and the channel is not funded\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -78,7 +74,6 @@ The following error codes may occur: .IP \[bu] 303: Broadcasting of the funding transaction failed, the internal call to bitcoin-cli returned with an error\. -.RE Failure may also occur if \fBlightningd\fR and the peer cannot agree on channel parameters (funding limits, channel reserves, fees, etc\.)\. @@ -89,9 +84,5 @@ channel parameters (funding limits, channel reserves, fees, etc\.)\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-06-12 11:16:20 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-fundchannel.7.md b/doc/lightning-fundchannel.7.md index 76469de11..4ab2ba1d0 100644 --- a/doc/lightning-fundchannel.7.md +++ b/doc/lightning-fundchannel.7.md @@ -1,6 +1,5 @@ -LIGHTNING-FUNDCHANNEL(7) Manual Page -==================================== -lightning-fundchannel - Command for establishing a lightning channel. +lightning-fundchannel -- Command for establishing a lightning channel +===================================================================== SYNOPSIS -------- @@ -76,7 +75,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-12 11:16:20 CEST diff --git a/doc/lightning-fundchannel_cancel.7 b/doc/lightning-fundchannel_cancel.7 index eacf94427..348453301 100644 --- a/doc/lightning-fundchannel_cancel.7 +++ b/doc/lightning-fundchannel_cancel.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-FUNDCHANNEL_CANCEL" "7" "" "" "lightning-fundchannel_cancel" .SH NAME - - -lightning-fundchannel_cancel - Command for completing channel -establishment - +lightning-fundchannel_cancel - Command for completing channel establishment .SH SYNOPSIS \fBfundchannel_cancel\fR \fIid\fR @@ -27,7 +23,7 @@ On failure, returns an error\. .SH AUTHOR -Lisa Neigut \fBNone\fR (\fI is mainly responsible\. +Lisa Neigut \fI is mainly responsible\. .SH SEE ALSO @@ -36,9 +32,5 @@ lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcomplete\fR(7) .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-06-12 11:16:20 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-fundchannel_cancel.7.md b/doc/lightning-fundchannel_cancel.7.md index c777d0333..c32fa966f 100644 --- a/doc/lightning-fundchannel_cancel.7.md +++ b/doc/lightning-fundchannel_cancel.7.md @@ -1,7 +1,5 @@ -LIGHTNING-FUNDCHANNEL\_CANCEL(7) Manual Page -============================================ -lightning-fundchannel\_cancel - Command for completing channel -establishment +lightning-fundchannel\_cancel -- Command for completing channel establishment +============================================================================= SYNOPSIS -------- @@ -39,7 +37,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-12 11:16:20 CEST diff --git a/doc/lightning-fundchannel_complete.7 b/doc/lightning-fundchannel_complete.7 index c9d6ac00f..da035ca99 100644 --- a/doc/lightning-fundchannel_complete.7 +++ b/doc/lightning-fundchannel_complete.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-FUNDCHANNEL_COMPLETE" "7" "" "" "lightning-fundchannel_complete" .SH NAME - - -lightning-fundchannel_complete - Command for completing channel -establishment - +lightning-fundchannel_complete - Command for completing channel establishment .SH SYNOPSIS \fBfundchannel_complete\fR \fIid\fR \fItxid\fR \fItxout\fR @@ -40,7 +36,7 @@ On failure, returns an error\. .SH AUTHOR -Lisa Neigut \fBNone\fR (\fI is mainly responsible\. +Lisa Neigut \fI is mainly responsible\. .SH SEE ALSO @@ -49,8 +45,9 @@ lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcancel\fR(7) .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR .HL Last updated 2019-06-12 11:16:20 CEST + diff --git a/doc/lightning-fundchannel_complete.7.md b/doc/lightning-fundchannel_complete.7.md index f9f7913b0..2dd5cd918 100644 --- a/doc/lightning-fundchannel_complete.7.md +++ b/doc/lightning-fundchannel_complete.7.md @@ -1,7 +1,5 @@ -LIGHTNING-FUNDCHANNEL\_COMPLETE(7) Manual Page -============================================== -lightning-fundchannel\_complete - Command for completing channel -establishment +lightning-fundchannel\_complete -- Command for completing channel establishment +=============================================================================== SYNOPSIS -------- @@ -49,7 +47,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-12 11:16:20 CEST diff --git a/doc/lightning-fundchannel_start.7 b/doc/lightning-fundchannel_start.7 index 0f4d3eae6..fdd1bfd22 100644 --- a/doc/lightning-fundchannel_start.7 +++ b/doc/lightning-fundchannel_start.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-FUNDCHANNEL_START" "7" "" "" "lightning-fundchannel_start" .SH NAME - - -lightning-fundchannel_start - Command for initiating channel -establishment for a lightning channel - +lightning-fundchannel_start - Command for initiating channel establishment for a lightning channel .SH SYNOPSIS \fBfundchannel_start\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR \fIannounce\fR] @@ -29,10 +25,11 @@ commitment transactions\. \fIannounce\fR whether or not to announce this channel\. + Note that the funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running \fBfundchannel_complete\fR, as the commitment transactions for this channel -are not secured until the complete command succeeds. Broadcasting +are not secured until the complete command succeeds\. Broadcasting transaction before that can lead to unrecoverable loss of funds\. .SH RETURN VALUE @@ -44,7 +41,7 @@ On failure, returns an error\. .SH AUTHOR -Lisa Neigut \fBNone\fR (\fI is mainly responsible\. +Lisa Neigut \fI is mainly responsible\. .SH SEE ALSO @@ -53,8 +50,9 @@ lightning-fundchannel_\fBcomplete\fR(7), lightning-fundchannel_\fBcancel\fR(7) .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR .HL Last updated 2019-06-12 11:16:20 CEST + diff --git a/doc/lightning-fundchannel_start.7.md b/doc/lightning-fundchannel_start.7.md index 11137b0d8..6c44aeb2d 100644 --- a/doc/lightning-fundchannel_start.7.md +++ b/doc/lightning-fundchannel_start.7.md @@ -1,7 +1,5 @@ -LIGHTNING-FUNDCHANNEL\_START(7) Manual Page -=========================================== -lightning-fundchannel\_start - Command for initiating channel -establishment for a lightning channel +lightning-fundchannel\_start -- Command for initiating channel establishment for a lightning channel +==================================================================================================== SYNOPSIS -------- @@ -53,7 +51,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-12 11:16:20 CEST diff --git a/doc/lightning-getroute.7 b/doc/lightning-getroute.7 index 04b2b9139..69c64fe7b 100644 --- a/doc/lightning-getroute.7 +++ b/doc/lightning-getroute.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-GETROUTE" "7" "" "" "lightning-getroute" .SH NAME - - -lightning-getroute - Command for routing a payment (low-level)\. - +lightning-getroute - Command for routing a payment (low-level) .SH SYNOPSIS \fBgetroute\fR \fIid\fR \fImsatoshi\fR \fIriskfactor\fR [\fIcltv\fR] [\fIfromid\fR] @@ -125,7 +122,7 @@ for the payment failure, in blocks\. .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -133,9 +130,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-08-01 14:59:36 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-getroute.7.md b/doc/lightning-getroute.7.md index 13ebf8be7..c0f0d6326 100644 --- a/doc/lightning-getroute.7.md +++ b/doc/lightning-getroute.7.md @@ -1,6 +1,5 @@ -LIGHTNING-GETROUTE(7) Manual Page -================================= -lightning-getroute - Command for routing a payment (low-level). +lightning-getroute -- Command for routing a payment (low-level) +=============================================================== SYNOPSIS -------- @@ -300,7 +299,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-08-01 14:59:36 CEST diff --git a/doc/lightning-invoice.7 b/doc/lightning-invoice.7 index ff6e8603b..47a74f6e8 100644 --- a/doc/lightning-invoice.7 +++ b/doc/lightning-invoice.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-INVOICE" "7" "" "" "lightning-invoice" .SH NAME - - -lightning-invoice - Command for accepting payments\. - +lightning-invoice - Command for accepting payments .SH SYNOPSIS \fBinvoice\fR \fImsatoshi\fR \fIlabel\fR \fIdescription\fR [\fIexpiry\fR] @@ -87,7 +84,6 @@ not\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -95,11 +91,9 @@ The following error codes may occur: .IP \[bu] 901: An invoice with the given \fIpreimage\fR already exists\. -.RE One of the following warnings may occur (on success): -.RS .IP \[bu] \fIwarning_offline\fR if no channel with a currently connected peer has the incoming capacity to pay this invoice @@ -108,10 +102,9 @@ One of the following warnings may occur (on success): incoming capacity and has a peer that is publicly connected (i\.e\. not a dead end) -.RE .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -120,9 +113,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-08-02 18:18:10 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-invoice.7.md b/doc/lightning-invoice.7.md index 3ddd1d0b3..7ca42153b 100644 --- a/doc/lightning-invoice.7.md +++ b/doc/lightning-invoice.7.md @@ -1,6 +1,5 @@ -LIGHTNING-INVOICE(7) Manual Page -================================ -lightning-invoice - Command for accepting payments. +lightning-invoice -- Command for accepting payments +=================================================== SYNOPSIS -------- @@ -103,7 +102,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-08-02 18:18:10 CEST diff --git a/doc/lightning-listchannels.7 b/doc/lightning-listchannels.7 index 74d654650..169470907 100644 --- a/doc/lightning-listchannels.7 +++ b/doc/lightning-listchannels.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-LISTCHANNELS" "7" "" "" "lightning-listchannels" .SH NAME - - -lightning-listchannels - Command to query active lightning channels in -the entire network\. - +lightning-listchannels - Command to query active lightning channels in the entire network .SH SYNOPSIS \fBlistchannels\fR [\fIshort_channel_id\fR] [\fIsource\fR] @@ -36,7 +32,6 @@ list of 0 or more objects\. Each object in the list contains the following data: -.RS .IP \[bu] \fIsource\fR : The node providing entry to the channel, specifying the fees charged for using the channel in that direction\. @@ -84,7 +79,6 @@ through this channel\. \fIhtlc_maximum_msat\fR : The maximum payment which can be send through this channel\. -.RE If \fIshort_channel_id\fR or \fIsource\fR is supplied and no matching channels are found, a "channels" object with an empty list is returned\. @@ -108,7 +102,7 @@ Similarly if \fIsource\fR is not a valid pubkey\. .SH AUTHOR -Michael Hawkins \fBNone\fR (\fI\. +Michael Hawkins \fI\. .SH SEE ALSO @@ -116,26 +110,24 @@ Michael Hawkins \fBNone\fR (\fI\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR Lightning RFC site -.RS .IP \[bu] BOLT #2: -\fBNone\fR (\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md\fR) +\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md\fR .IP \[bu] BOLT #7: -\fBNone\fR (\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md\fR) +\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md\fR -.RE .HL Last updated 2019-06-12 11:16:20 CEST diff --git a/doc/lightning-listchannels.7.md b/doc/lightning-listchannels.7.md index e1ca7de6e..296c6e200 100644 --- a/doc/lightning-listchannels.7.md +++ b/doc/lightning-listchannels.7.md @@ -1,7 +1,5 @@ -LIGHTNING-LISTCHANNELS(7) Manual Page -===================================== -lightning-listchannels - Command to query active lightning channels in -the entire network. +lightning-listchannels -- Command to query active lightning channels in the entire network +========================================================================================== SYNOPSIS -------- @@ -100,7 +98,3 @@ Lightning RFC site - BOLT \#7: - ------------------------------------------------------------------------- - -Last updated 2019-06-12 11:16:20 CEST diff --git a/doc/lightning-listforwards.7 b/doc/lightning-listforwards.7 index fbeb68d1f..7a8bf82b6 100644 --- a/doc/lightning-listforwards.7 +++ b/doc/lightning-listforwards.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-LISTFORWARDS" "7" "" "" "lightning-listforwards" .SH NAME - - -lightning-listforwards - Command showing all htlcs and their -information\. - +lightning-listforwards - Command showing all htlcs and their information .SH SYNOPSIS \fBlistforwards\fR @@ -22,7 +18,6 @@ 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] @@ -33,12 +28,10 @@ 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] @@ -46,26 +39,21 @@ 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 \fBNone\fR (\fI is mainly responsible\. +Rene Pickhardt \fI is mainly responsible\. .SH SEE ALSO @@ -73,7 +61,7 @@ Rene Pickhardt \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 .HL diff --git a/doc/lightning-listforwards.7.md b/doc/lightning-listforwards.7.md index 23b287768..84db34624 100644 --- a/doc/lightning-listforwards.7.md +++ b/doc/lightning-listforwards.7.md @@ -1,7 +1,5 @@ -LIGHTNING-LISTFORWARDS(7) Manual Page -===================================== -lightning-listforwards - Command showing all htlcs and their -information. +lightning-listforwards -- Command showing all htlcs and their information +========================================================================= SYNOPSIS -------- @@ -56,7 +54,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-07-23 00:53:16 CEST diff --git a/doc/lightning-listfunds.7 b/doc/lightning-listfunds.7 index 466614578..e23879cd5 100644 --- a/doc/lightning-listfunds.7 +++ b/doc/lightning-listfunds.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-LISTFUNDS" "7" "" "" "lightning-listfunds" .SH NAME - - -lightning-listfunds - Command showing all funds currently managed by the -c-lightning node\. - +lightning-listfunds - Command showing all funds currently managed by the c-lightning node .SH SYNOPSIS \fBlistfunds\fR @@ -24,7 +20,6 @@ channels\. Each entry in \fIoutputs\fR will include: -.RS .IP \[bu] \fItxid\fR .IP \[bu] @@ -39,11 +34,9 @@ appended) .IP \[bu] \fIstatus\fR (whether \fIunconfirmed\fR, \fIconfirmed\fR, or \fIspent\fR) -.RE Each entry in \fIchannels\fR will include: -.RS .IP \[bu] \fIpeer_id\fR - the peer with which the channel is opened\. .IP \[bu] @@ -68,10 +61,9 @@ appended\. \fIfunding_output\fR - the index of the output in the funding transaction\. -.RE .SH AUTHOR -Felix \fBNone\fR (\fI is mainly responsible\. +Felix \fI is mainly responsible\. .SH SEE ALSO @@ -79,9 +71,5 @@ Felix \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-07-28 16:25:20 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-listfunds.7.md b/doc/lightning-listfunds.7.md index 4d4ae62b2..d81496b30 100644 --- a/doc/lightning-listfunds.7.md +++ b/doc/lightning-listfunds.7.md @@ -1,7 +1,5 @@ -LIGHTNING-LISTFUNDS(7) Manual Page -================================== -lightning-listfunds - Command showing all funds currently managed by the -c-lightning node. +lightning-listfunds -- Command showing all funds currently managed by the c-lightning node +========================================================================================== SYNOPSIS -------- @@ -62,7 +60,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-07-28 16:25:20 CEST diff --git a/doc/lightning-listinvoices.7 b/doc/lightning-listinvoices.7 index f0265e62e..e1e96c07d 100644 --- a/doc/lightning-listinvoices.7 +++ b/doc/lightning-listinvoices.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-LISTINVOICES" "7" "" "" "lightning-listinvoices" .SH NAME - - lightning-listinvoices - Command for querying invoice status - .SH SYNOPSIS \fBlistinvoices\fR [\fIlabel\fR] @@ -29,7 +26,7 @@ allow clients to obscure payment paths); there will also be an .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -37,9 +34,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-30 17:12:10 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-listinvoices.7.md b/doc/lightning-listinvoices.7.md index 91e74b3c6..bc083f2d4 100644 --- a/doc/lightning-listinvoices.7.md +++ b/doc/lightning-listinvoices.7.md @@ -1,6 +1,5 @@ -LIGHTNING-LISTINVOICES(7) Manual Page -===================================== -lightning-listinvoices - Command for querying invoice status +lightning-listinvoices -- Command for querying invoice status +============================================================= SYNOPSIS -------- @@ -42,7 +41,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:12:10 CEST diff --git a/doc/lightning-listpays.7 b/doc/lightning-listpays.7 index db42593ce..adff03ec3 100644 --- a/doc/lightning-listpays.7 +++ b/doc/lightning-listpays.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-LISTPAYS" "7" "" "" "lightning-listpays" .SH NAME - - lightning-listpays - Command for querying payment status - .SH SYNOPSIS \fBlistpays\fR [bolt11] @@ -58,7 +55,7 @@ These three can all be extracted from \fIbolt11\fR, hence are obsolete\. .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -66,9 +63,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-30 17:12:10 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-listpays.7.md b/doc/lightning-listpays.7.md index 848f3ae9f..1cb8d0e19 100644 --- a/doc/lightning-listpays.7.md +++ b/doc/lightning-listpays.7.md @@ -1,6 +1,5 @@ -LIGHTNING-LISTPAYS(7) Manual Page -================================= -lightning-listpays - Command for querying payment status +lightning-listpays -- Command for querying payment status +========================================================= SYNOPSIS -------- @@ -61,7 +60,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:12:10 CEST diff --git a/doc/lightning-listpeers.7 b/doc/lightning-listpeers.7 index acac4e21d..553c122ba 100644 --- a/doc/lightning-listpeers.7 +++ b/doc/lightning-listpeers.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-LISTPEERS" "7" "" "" "lightning-listpeers" .SH NAME - - -lightning-listpeers - Command for returning data on connected lightning -nodes\. - +lightning-listpeers - Command returning data on connected lightning nodes .SH SYNOPSIS \fBlistpeers\fR [\fIid\fR] [\fIlevel\fR] @@ -51,7 +47,6 @@ of 0 or more objects\. Each object in the list contains the following data: -.RS .IP \[bu] \fIid\fR : The unique id of the peer .IP \[bu] @@ -68,7 +63,6 @@ Each object in the list contains the following data: \fIlog\fR : Only present if \fIlevel\fR is set\. List logs related to the peer at the specified \fIlevel\fR -.RE If \fIid\fR is supplied and no matching nodes are found, a "peers" object with an empty list is returned\. @@ -98,7 +92,7 @@ If \fIlevel\fR is not a valid log level, an error message will be returned: .fi .SH AUTHOR -Michael Hawkins \fBNone\fR (\fI\. +Michael Hawkins \fI\. .SH SEE ALSO @@ -106,11 +100,7 @@ Michael Hawkins \fBNone\fR (\fI\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) Lightning +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR Lightning RFC site (BOLT #9): -\fBNone\fR (\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md\fR) - -.HL - -Last updated 2019-04-30 17:12:10 CEST +\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md\fR diff --git a/doc/lightning-listpeers.7.md b/doc/lightning-listpeers.7.md index 16f45c2ce..da6f9fcfd 100644 --- a/doc/lightning-listpeers.7.md +++ b/doc/lightning-listpeers.7.md @@ -1,7 +1,5 @@ -LIGHTNING-LISTPEERS(7) Manual Page -================================== -lightning-listpeers - Command for returning data on connected lightning -nodes. +lightning-listpeers -- Command returning data on connected lightning nodes +========================================================================== SYNOPSIS -------- @@ -83,7 +81,3 @@ RESOURCES Main web site: Lightning RFC site (BOLT \#9): - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:12:10 CEST diff --git a/doc/lightning-listsendpays.7 b/doc/lightning-listsendpays.7 index 580bc89cb..a9662ad42 100644 --- a/doc/lightning-listsendpays.7 +++ b/doc/lightning-listsendpays.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-LISTSENDPAYS" "7" "" "" "lightning-listsendpays" .SH NAME - - lightning-listsendpays - Low-level command for querying sendpay status - .SH SYNOPSIS \fBlistsendpays\fR [\fIbolt11\fR] [\fIpayment_hash\fR] @@ -62,7 +59,7 @@ payments)\. .SH AUTHOR -Christian Decker \fBNone\fR (\fI is mainly +Christian Decker \fI is mainly responsible\. .SH SEE ALSO @@ -71,9 +68,5 @@ responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-30 17:12:10 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-listsendpays.7.md b/doc/lightning-listsendpays.7.md index c21fe4db7..5af477574 100644 --- a/doc/lightning-listsendpays.7.md +++ b/doc/lightning-listsendpays.7.md @@ -1,6 +1,5 @@ -LIGHTNING-LISTSENDPAYS(7) Manual Page -===================================== -lightning-listsendpays - Low-level command for querying sendpay status +lightning-listsendpays -- Low-level command for querying sendpay status +======================================================================= SYNOPSIS -------- @@ -66,7 +65,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:12:10 CEST diff --git a/doc/lightning-newaddr.7 b/doc/lightning-newaddr.7 index 9fd132e9b..67f143069 100644 --- a/doc/lightning-newaddr.7 +++ b/doc/lightning-newaddr.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-NEWADDR" "7" "" "" "lightning-newaddr" .SH NAME - - -lightning-newaddr - Command for generating a new address to be used by -c-lightning\. - +lightning-newaddr - Command for generating a new address to be used by c-lightning .SH SYNOPSIS \fBnewaddr\fR [ \fIaddresstype\fR ] @@ -41,7 +37,7 @@ returned\. .SH AUTHOR -Felix \fBNone\fR (\fI is mainly responsible\. +Felix \fI is mainly responsible\. .SH SEE ALSO @@ -49,9 +45,5 @@ Felix \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-30 17:34:18 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-newaddr.7.md b/doc/lightning-newaddr.7.md index 003905cd6..8ea06e4e6 100644 --- a/doc/lightning-newaddr.7.md +++ b/doc/lightning-newaddr.7.md @@ -1,7 +1,5 @@ -LIGHTNING-NEWADDR(7) Manual Page -================================ -lightning-newaddr - Command for generating a new address to be used by -c-lightning. +lightning-newaddr -- Command for generating a new address to be used by c-lightning +=================================================================================== SYNOPSIS -------- @@ -52,7 +50,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:34:18 CEST diff --git a/doc/lightning-pay.7 b/doc/lightning-pay.7 index 4f8de1990..2e0fd9ff5 100644 --- a/doc/lightning-pay.7 +++ b/doc/lightning-pay.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-PAY" "7" "" "" "lightning-pay" .SH NAME - - lightning-pay - Command for sending a payment to a BOLT11 invoice - .SH SYNOPSIS \fBpay\fR \fIbolt11\fR [\fImsatoshi\fR] [\fIlabel\fR] [\fIriskfactor\fR] @@ -87,7 +84,6 @@ You can monitor the progress and retries of a payment using the The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -113,7 +109,6 @@ invoice expiration) as UNIX epoch time in seconds\. .IP \[bu] 210: Payment timed out without a payment in progress\. -.RE Error codes 202 and 204 will only get reported at \fBsendpay\fR; in \fBpay\fR we will keep retrying if we would have gotten those errors\. @@ -121,7 +116,6 @@ Error codes 202 and 204 will only get reported at \fBsendpay\fR; in A routing failure object has the fields below: -.RS .IP \[bu] \fIerring_index\fR: The index of the node along the route that reported the error\. 0 for the local node, 1 for the first hop, and so on\. @@ -138,7 +132,6 @@ error, or \fI0:0:0\fR if the destination node raised the error\. received from the remote node\. Only present if error is from the remote node and the \fIfailcode\fR has the UPDATE bit set, as per BOLT #4\. -.RE The \fIdata\fR field of errors will include statistics \fIgetroute_tries\fR and \fIsendpay_tries\fR\. It will also contain a \fIfailures\fR field with detailed @@ -146,7 +139,7 @@ data about routing errors\. .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -155,7 +148,7 @@ Rusty Russell \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 .HL diff --git a/doc/lightning-pay.7.md b/doc/lightning-pay.7.md index f57957440..1bc12e534 100644 --- a/doc/lightning-pay.7.md +++ b/doc/lightning-pay.7.md @@ -1,6 +1,5 @@ -LIGHTNING-PAY(7) Manual Page -============================ -lightning-pay - Command for sending a payment to a BOLT11 invoice +lightning-pay -- Command for sending a payment to a BOLT11 invoice +================================================================== SYNOPSIS -------- @@ -129,7 +128,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-08-01 14:59:36 CEST diff --git a/doc/lightning-plugin.7 b/doc/lightning-plugin.7 index 27463e5dc..dcd6e0cc4 100644 --- a/doc/lightning-plugin.7 +++ b/doc/lightning-plugin.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-PLUGIN" "7" "" "" "lightning-plugin" .SH NAME - - lightning-plugin - Manage plugins with RPC - .SH SYNOPSIS \fBplugin\fR command [parameter] [second_parameter] @@ -44,11 +41,11 @@ asynchronously, a freshly started plugin may not appear immediately\. .SH AUTHOR -Antoine Poinsot \fBNone\fR (\fI is mainly responsible\. +Antoine Poinsot \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 .HL diff --git a/doc/lightning-plugin.7.md b/doc/lightning-plugin.7.md index 2a91fcad7..467e083e9 100644 --- a/doc/lightning-plugin.7.md +++ b/doc/lightning-plugin.7.md @@ -1,6 +1,5 @@ -LIGHTNING-PLUGIN(7) Manual Page -=============================== -lightning-plugin - Manage plugins with RPC +lightning-plugin -- Manage plugins with RPC +=========================================== SYNOPSIS -------- @@ -47,7 +46,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-07-29 12:57:57 CEST diff --git a/doc/lightning-sendpay.7 b/doc/lightning-sendpay.7 index 8d0d6d64c..bf1d052af 100644 --- a/doc/lightning-sendpay.7 +++ b/doc/lightning-sendpay.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-SENDPAY" "7" "" "" "lightning-sendpay" .SH NAME - - -lightning-sendpay - Low-level command for sending a payment via a route\. - +lightning-sendpay - Low-level command for sending a payment via a route .SH SYNOPSIS \fBsendpay\fR \fIroute\fR \fIpayment_hash\fR [\fIlabel\fR] [\fImsatoshi\fR] @@ -68,7 +65,6 @@ retried\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -85,11 +81,9 @@ will be routing failure object\. 204: Failure along route; retry a different route\. The \fIdata\fR field of the error will be routing failure object\. -.RE A routing failure object has the fields below: -.RS .IP \[bu] \fIerring_index\fR\. The index of the node along the route that reported the error\. 0 for the local node, 1 for the first hop, and so on\. @@ -107,10 +101,9 @@ received from the remote node\. Only present if error is from the remote node and the \fIfailcode\fR has the UPDATE bit set, as per BOLT #4\. -.RE .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -120,7 +113,7 @@ Rusty Russell \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 .HL diff --git a/doc/lightning-sendpay.7.md b/doc/lightning-sendpay.7.md index ecf2da57c..d677aa116 100644 --- a/doc/lightning-sendpay.7.md +++ b/doc/lightning-sendpay.7.md @@ -1,6 +1,5 @@ -LIGHTNING-SENDPAY(7) Manual Page -================================ -lightning-sendpay - Low-level command for sending a payment via a route. +lightning-sendpay -- Low-level command for sending a payment via a route +======================================================================== SYNOPSIS -------- @@ -101,7 +100,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-08-01 14:59:36 CEST diff --git a/doc/lightning-setchannelfee.7 b/doc/lightning-setchannelfee.7 index 592f9f0bd..6c7d41750 100644 --- a/doc/lightning-setchannelfee.7 +++ b/doc/lightning-setchannelfee.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-SETCHANNELFEE" "7" "" "" "lightning-setchannelfee" .SH NAME - - -lightning-setchannelfee - Command for setting specific routing fees on a -lightning channel\. - +lightning-setchannelfee - Command for setting specific routing fees on a lightning channel .SH SYNOPSIS \fBsetchannelfee\fR \fIid\fR [\fIbase\fR] [\fIppm\fR] @@ -47,18 +43,16 @@ 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 \fBNone\fR (\fI is the author of this -feature\. Rusty Russell \fBNone\fR (\fI is mainly +Michael Schmoock \fI is the author of this +feature\. Rusty Russell \fI is mainly responsible for the c-lightning project\. .SH SEE ALSO @@ -68,7 +62,7 @@ responsible for the c-lightning project\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR .HL diff --git a/doc/lightning-setchannelfee.7.md b/doc/lightning-setchannelfee.7.md index cd00fdd9a..630f64f7d 100644 --- a/doc/lightning-setchannelfee.7.md +++ b/doc/lightning-setchannelfee.7.md @@ -1,7 +1,5 @@ -LIGHTNING-SETCHANNELFEE(7) Manual Page -====================================== -lightning-setchannelfee - Command for setting specific routing fees on a -lightning channel. +lightning-setchannelfee -- Command for setting specific routing fees on a lightning channel +=========================================================================================== SYNOPSIS -------- @@ -66,7 +64,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-30 17:34:18 CEST diff --git a/doc/lightning-txdiscard.7 b/doc/lightning-txdiscard.7 index 873f326f0..80b016f14 100644 --- a/doc/lightning-txdiscard.7 +++ b/doc/lightning-txdiscard.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-TXDISCARD" "7" "" "" "lightning-txdiscard" .SH NAME - - -lightning-txdiscard - Abandon a transaction from txprepare, release -inputs - +lightning-txdiscard - Abandon a transaction from txprepare, release inputs .SH SYNOPSIS \fBtxdiscard\fR \fItxid\fR @@ -28,14 +24,12 @@ 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 \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -43,7 +37,7 @@ Rusty Russell \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 .HL diff --git a/doc/lightning-txdiscard.7.md b/doc/lightning-txdiscard.7.md index 278c6d82f..d8d6baf60 100644 --- a/doc/lightning-txdiscard.7.md +++ b/doc/lightning-txdiscard.7.md @@ -1,7 +1,5 @@ -LIGHTNING-TXDISCARD(7) Manual Page -================================== -lightning-txdiscard - Abandon a transaction from txprepare, release -inputs +lightning-txdiscard -- Abandon a transaction from txprepare, release inputs +=========================================================================== SYNOPSIS -------- @@ -42,7 +40,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-08 16:03:59 CEST diff --git a/doc/lightning-txprepare.7 b/doc/lightning-txprepare.7 index 94b09e7b3..865840120 100644 --- a/doc/lightning-txprepare.7 +++ b/doc/lightning-txprepare.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-TXPREPARE" "7" "" "" "lightning-txprepare" .SH NAME - - -lightning-txprepare - Command to prepare to withdraw funds from the -internal wallet\. - +lightning-txprepare - Command to prepare to withdraw funds from the internal wallet .SH SYNOPSIS \fBtxprepare\fR \fIdestination\fR \fIsatoshi\fR [\fIfeerate\fR] [\fIminconf\fR] @@ -36,7 +32,6 @@ On failure, an error is reported and the transaction is not created\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -45,10 +40,9 @@ fees) to create the transaction\. .IP \[bu] 302: The dust limit is not met\. -.RE .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -56,9 +50,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-06-08 16:03:59 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-txprepare.7.md b/doc/lightning-txprepare.7.md index 9c34d4c33..0c7dd53a1 100644 --- a/doc/lightning-txprepare.7.md +++ b/doc/lightning-txprepare.7.md @@ -1,7 +1,5 @@ -LIGHTNING-TXPREPARE(7) Manual Page -================================== -lightning-txprepare - Command to prepare to withdraw funds from the -internal wallet. +lightning-txprepare -- Command to prepare to withdraw funds from the internal wallet +==================================================================================== SYNOPSIS -------- @@ -51,7 +49,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-08 16:03:59 CEST diff --git a/doc/lightning-txsend.7 b/doc/lightning-txsend.7 index fb43d43a5..119dafc3c 100644 --- a/doc/lightning-txsend.7 +++ b/doc/lightning-txsend.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-TXSEND" "7" "" "" "lightning-txsend" .SH NAME - - lightning-txsend - Command to sign and send transaction from txprepare - .SH SYNOPSIS \fBtxsend\fR \fItxid\fR @@ -28,14 +25,12 @@ the transaction are unreserved\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. -.RE .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -43,9 +38,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-06-08 16:03:59 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-txsend.7.md b/doc/lightning-txsend.7.md index be672a7a3..5bde8c43a 100644 --- a/doc/lightning-txsend.7.md +++ b/doc/lightning-txsend.7.md @@ -1,6 +1,5 @@ -LIGHTNING-TXSEND(7) Manual Page -=============================== -lightning-txsend - Command to sign and send transaction from txprepare +lightning-txsend -- Command to sign and send transaction from txprepare +======================================================================= SYNOPSIS -------- @@ -41,7 +40,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-08 16:03:59 CEST diff --git a/doc/lightning-waitanyinvoice.7 b/doc/lightning-waitanyinvoice.7 index edb34b436..bd3335d8c 100644 --- a/doc/lightning-waitanyinvoice.7 +++ b/doc/lightning-waitanyinvoice.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-WAITANYINVOICE" "7" "" "" "lightning-waitanyinvoice" .SH NAME - - -lightning-waitanyinvoice - Command for waiting for payments\. - +lightning-waitanyinvoice - Command for waiting for payments .SH SYNOPSIS \fBwaitanyinvoice\fR [\fIlastpay_index\fR] @@ -32,7 +29,7 @@ On success, an invoice description will be returned as per .SH AUTHOR -Rusty Russell \fBNone\fR (\fI is mainly responsible\. +Rusty Russell \fI is mainly responsible\. .SH SEE ALSO @@ -41,9 +38,5 @@ Rusty Russell \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-04-07 14:23:17 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-waitanyinvoice.7.md b/doc/lightning-waitanyinvoice.7.md index defe13b0e..0c0192a32 100644 --- a/doc/lightning-waitanyinvoice.7.md +++ b/doc/lightning-waitanyinvoice.7.md @@ -1,6 +1,5 @@ -LIGHTNING-WAITANYINVOICE(7) Manual Page -======================================= -lightning-waitanyinvoice - Command for waiting for payments. +lightning-waitanyinvoice -- Command for waiting for payments +============================================================ SYNOPSIS -------- @@ -44,7 +43,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-07 14:23:17 CEST diff --git a/doc/lightning-waitinvoice.7 b/doc/lightning-waitinvoice.7 index 3340a7791..be1939fed 100644 --- a/doc/lightning-waitinvoice.7 +++ b/doc/lightning-waitinvoice.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-WAITINVOICE" "7" "" "" "lightning-waitinvoice" .SH NAME - - -lightning-waitinvoice - Command for waiting for specific payment\. - +lightning-waitinvoice - Command for waiting for specific payment .SH SYNOPSIS \fBwaitinvoice\fR \fIlabel\fR @@ -29,7 +26,7 @@ invoice data as per \fBlistinvoice\fR\. .SH AUTHOR -Christian Decker \fBNone\fR (\fI is mainly +Christian Decker \fI is mainly responsible\. .SH SEE ALSO @@ -39,7 +36,7 @@ responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR .HL diff --git a/doc/lightning-waitinvoice.7.md b/doc/lightning-waitinvoice.7.md index 43543f049..46a16c1ba 100644 --- a/doc/lightning-waitinvoice.7.md +++ b/doc/lightning-waitinvoice.7.md @@ -1,6 +1,5 @@ -LIGHTNING-WAITINVOICE(7) Manual Page -==================================== -lightning-waitinvoice - Command for waiting for specific payment. +lightning-waitinvoice -- Command for waiting for specific payment +================================================================= SYNOPSIS -------- @@ -42,7 +41,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-04-07 14:23:17 CEST diff --git a/doc/lightning-waitsendpay.7 b/doc/lightning-waitsendpay.7 index 13ee0dc24..d7011e399 100644 --- a/doc/lightning-waitsendpay.7 +++ b/doc/lightning-waitsendpay.7 @@ -1,9 +1,6 @@ .TH "LIGHTNING-WAITSENDPAY" "7" "" "" "lightning-waitsendpay" .SH NAME - - -lightning-waitsendpay - Command for sending a payment via a route\. - +lightning-waitsendpay - Command for sending a payment via a route .SH SYNOPSIS \fBwaitsendpay\fR \fIpayment_hash\fR [\fItimeout\fR] @@ -46,7 +43,6 @@ route\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -69,11 +65,9 @@ nothing to wait for\. stored\. This should only occur when querying failed payments on very old databases\. -.RE A routing failure object has the fields below: -.RS .IP \[bu] \fIerring_index\fR: The index of the node along the route that reported the error\. 0 for the local node, 1 for the first hop, and so on\. @@ -92,10 +86,9 @@ error (or the final channel if the destination raised the error)\. \fIfailcodename\fR: The human-readable name corresponding to \fIfailcode\fR, if known\. -.RE .SH AUTHOR -ZmnSCPxj \fBNone\fR (\fI is mainly responsible\. +ZmnSCPxj \fI is mainly responsible\. .SH SEE ALSO @@ -103,7 +96,7 @@ ZmnSCPxj \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 .HL diff --git a/doc/lightning-waitsendpay.7.md b/doc/lightning-waitsendpay.7.md index 1c698e31e..dc4fe5fc3 100644 --- a/doc/lightning-waitsendpay.7.md +++ b/doc/lightning-waitsendpay.7.md @@ -1,6 +1,5 @@ -LIGHTNING-WAITSENDPAY(7) Manual Page -==================================== -lightning-waitsendpay - Command for sending a payment via a route. +lightning-waitsendpay -- Command for sending a payment via a route +================================================================== SYNOPSIS -------- @@ -83,7 +82,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-05-22 16:46:09 CEST diff --git a/doc/lightning-withdraw.7 b/doc/lightning-withdraw.7 index ef732c09b..8950da80c 100644 --- a/doc/lightning-withdraw.7 +++ b/doc/lightning-withdraw.7 @@ -1,10 +1,6 @@ .TH "LIGHTNING-WITHDRAW" "7" "" "" "lightning-withdraw" .SH NAME - - -lightning-withdraw - Command for withdrawing funds from the internal -wallet\. - +lightning-withdraw - Command for withdrawing funds from the internal wallet .SH SYNOPSIS \fBwithdraw\fR \fIdestination\fR \fIsatoshi\fR [\fIfeerate\fR] [\fIminconf\fR] @@ -56,7 +52,6 @@ created\. The following error codes may occur: -.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -65,10 +60,9 @@ fees) to create the transaction\. .IP \[bu] 302: The dust limit is not met\. -.RE .SH AUTHOR -Felix \fBNone\fR (\fI is mainly responsible\. +Felix \fI is mainly responsible\. .SH SEE ALSO @@ -77,9 +71,5 @@ Felix \fBNone\fR (\fI is mainly responsible\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - -.HL - -Last updated 2019-06-08 16:03:59 CEST +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR diff --git a/doc/lightning-withdraw.7.md b/doc/lightning-withdraw.7.md index c606afe87..559595796 100644 --- a/doc/lightning-withdraw.7.md +++ b/doc/lightning-withdraw.7.md @@ -1,7 +1,5 @@ -LIGHTNING-WITHDRAW(7) Manual Page -================================= -lightning-withdraw - Command for withdrawing funds from the internal -wallet. +lightning-withdraw -- Command for withdrawing funds from the internal wallet +============================================================================ SYNOPSIS -------- @@ -68,7 +66,3 @@ RESOURCES --------- Main web site: - ------------------------------------------------------------------------- - -Last updated 2019-06-08 16:03:59 CEST diff --git a/doc/lightningd-config.5 b/doc/lightningd-config.5 index 8e5d7d8f4..9cdf50e09 100644 --- a/doc/lightningd-config.5 +++ b/doc/lightningd-config.5 @@ -1,9 +1,6 @@ .TH "LIGHTNINGD-CONFIG" "5" "" "" "lightningd-config" .SH NAME - - lightningd-config - Lightning daemon configuration file - .SH SYNOPSIS \fB~/\.lightning/config\fR @@ -155,6 +152,7 @@ a configuration file is meaningless\. .SH Lightning node customization options \fBalias\fR=\fIRRGGBB\fR + \fBrgb\fR=\fIRRGGBB\fR Your favorite color as a hex code\. @@ -420,7 +418,7 @@ to gain our eternal gratitude! .SH AUTHOR -Rusty Russell <\fBNone\fR (\fIrusty@rustcorp.com.au\fR)> wrote this man page, and +Rusty Russell <\fIrusty@rustcorp.com.au\fR> wrote this man page, and much of the configuration language, but many others did the hard work of actually implementing these options\. @@ -430,13 +428,10 @@ actually implementing these options\. .SH RESOURCES -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR .SH COPYING Note: the modules in the ccan/ directory have their own licenses, but the rest of the code is covered by the BSD-style MIT license\. - -Last updated 2019-08-09 11:12:04 CEST - diff --git a/doc/lightningd-config.5.md b/doc/lightningd-config.5.md index a60dd3fb0..1b6a08ea6 100644 --- a/doc/lightningd-config.5.md +++ b/doc/lightningd-config.5.md @@ -1,6 +1,5 @@ -LIGHTNINGD-CONFIG(5) Manual Page -================================ -lightningd-config - Lightning daemon configuration file +lightningd-config -- Lightning daemon configuration file +======================================================== SYNOPSIS -------- @@ -371,6 +370,3 @@ COPYING Note: the modules in the ccan/ directory have their own licenses, but the rest of the code is covered by the BSD-style MIT license. - - -Last updated 2019-08-09 11:12:04 CEST diff --git a/doc/lightningd.8 b/doc/lightningd.8 index ae27aad0c..88d3a472d 100644 --- a/doc/lightningd.8 +++ b/doc/lightningd.8 @@ -1,25 +1,19 @@ .TH "LIGHTNINGD" "8" "" "" "lightningd" .SH NAME - - lightningd - Daemon for running a Lightning Network node +.SH SYNOPSIS +.nf +.RS +lightningd [--conf=] [OPTIONS]… +.RE - -SYNOPSIS - - -lightningd [--conf=<config-file>] [\fIOPTIONS\fR]… - - -DESCRIPTION - +.fi +.SH DESCRIPTION \fBlightningd\fR starts the C-Lightning daemon, which implements a standards-compliant Lightning Network node\. - -CONFIGURATION OPTIONS - +.SH CONFIGURATION OPTIONS \fB--conf\fR=\fIFILE\fR Specify configuration file\. If not an absolute path, will be relative @@ -30,21 +24,17 @@ from the lightning-dir location\. Defaults to \fIconfig\fR\. Set the directory for the C-Lightning daemon\. Defaults to \fI$HOME/\.lightning\fR\. - -MORE OPTIONS - +.SH MORE OPTIONS Command line options are mirrored as configuration options in the configuration file, so \fIfoo\fR in the configuration file simply becomes -\fI--foo\fR on the command line, and \fIfoo=bar\fR becomes \fI--foo=bar\fR\. +\fB--foo\fR on the command line, and \fBfoo=bar\fR becomes \fB--foo=bar\fR\. See \fBlightningd-config\fR(5) for a comprehensive list of all available options\. - -LOGGING AND COMMANDING C-LIGHTNING - +.SH LOGGING AND COMMANDING C-LIGHTNING .nf .RS By default, C-Lightning will log to the standard output. @@ -183,7 +173,7 @@ $ dig lseed.bitcoinstats.com A This will give 25 IPv4 addresses, you can select any one of those\. You will also need to learn the corresponding public key, which you can -determine by searching the IP addrss on \fBNone\fR (\fIhttps://1ml.com/\fR) \. The public +determine by searching the IP addrss on \fIhttps://1ml.com/\fR \. The public key is a long hex string, like so: \fI024772ee4fa461febcef09d5869e1238f932861f57be7a6633048514e3f56644a1\fR\. (this example public key is not used as of this writing) @@ -243,43 +233,30 @@ $ lightning-cli pay $INVOICE .RE .fi - -BUGS - +.SH BUGS You should report bugs on our github issues page, and maybe submit a fix to gain our eternal gratitude! +.SH AUTHOR -AUTHOR - - -ZmnSCPxj <\fBNone\fR (\fIZmnSCPxj@protonmail.com\fR)> wrote the initial version of +ZmnSCPxj \fI wrote the initial version of this man page, but many others did the hard work of actually implementing a standards-compliant Lightning Network node implementation\. - -SEE ALSO - +.SH SEE ALSO \fBlightning-listconfigs\fR(7), \fBlightning-config\fR(5), \fBlightning-cli\fR(1), \fBlightning-newaddr\fR(7), \fBlightning-listfunds\fR(7), \fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7), \fBlightning-listpeers\fR(7), \fBlightning-pay\fR(7) +.SH RESOURCES -RESOURCES - - -Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR) - - -COPYING +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR +.SH COPYING Note: the modules in the ccan/ directory have their own licenses, but the rest of the code is covered by the BSD-style MIT license\. - -Last updated 2019-08-09 11:11:48 CEST - diff --git a/doc/lightningd.8.md b/doc/lightningd.8.md index b903073e7..1617237b0 100644 --- a/doc/lightningd.8.md +++ b/doc/lightningd.8.md @@ -1,17 +1,20 @@ -LIGHTNINGD(8) Manual Page -========================= -lightningd - Daemon for running a Lightning Network node +lightningd -- Daemon for running a Lightning Network node +========================================================= SYNOPSIS - -lightningd \[--conf=<config-file>\] \[*OPTIONS*\]… +-------- +```bash +lightningd [--conf=] [OPTIONS]… +``` DESCRIPTION +----------- **lightningd** starts the C-Lightning daemon, which implements a standards-compliant Lightning Network node. CONFIGURATION OPTIONS +--------------------- **--conf**=*FILE* Specify configuration file. If not an absolute path, will be relative @@ -22,15 +25,17 @@ Set the directory for the C-Lightning daemon. Defaults to *$HOME/.lightning*. MORE OPTIONS +------------ Command line options are mirrored as configuration options in the configuration file, so *foo* in the configuration file simply becomes -*--foo* on the command line, and *foo=bar* becomes *--foo=bar*. +**--foo** on the command line, and **foo=bar** becomes **--foo=bar**. See lightningd-config(5) for a comprehensive list of all available options. LOGGING AND COMMANDING C-LIGHTNING +---------------------------------- By default, C-Lightning will log to the standard output. To log to a specific file, use '--log-file=PATH'. @@ -147,31 +152,33 @@ merchant, and use lightning-pay(7) to pay it: $ lightning-cli pay $INVOICE BUGS +---- You should report bugs on our github issues page, and maybe submit a fix to gain our eternal gratitude! AUTHOR +------ -ZmnSCPxj <> wrote the initial version of +ZmnSCPxj <> wrote the initial version of this man page, but many others did the hard work of actually implementing a standards-compliant Lightning Network node implementation. SEE ALSO +-------- lightning-listconfigs(7), lightning-config(5), lightning-cli(1), lightning-newaddr(7), lightning-listfunds(7), lightning-connect(7), lightning-fundchannel(7), lightning-listpeers(7), lightning-pay(7) RESOURCES +--------- Main web site: COPYING +------- Note: the modules in the ccan/ directory have their own licenses, but the rest of the code is covered by the BSD-style MIT license. - - -Last updated 2019-08-09 11:11:48 CEST