Skip to content
This repository was archived by the owner on Apr 17, 2020. It is now read-only.

Commit c3254e6

Browse files
cdeckercdecker
committed
docs: Update manpages to be recognized correctly by mrkd
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
1 parent 0495295 commit c3254e6

File tree

74 files changed

+215
-672
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+215
-672
lines changed

‎doc/Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ MANPAGES := doc/lightning-cli.1 \
4444
doc-all: $(MANPAGES) doc/index.rst
4545

4646
$(MANPAGES): doc/%: doc/%.md
47-
@if $(CHANGED_FROM_GIT); then echo mrkd $<; mrkd $<; else touch $@; fi
47+
if $(CHANGED_FROM_GIT); then mrkd $< $@; else touch $@; fi
4848

4949
doc/protocol-%.svg: test/test_protocol
5050
test/test_protocol --svg < test/commits/$*.script > $@
@@ -91,6 +91,6 @@ doc-clean:
9191
$(RM) doc/deployable-lightning.{aux,bbl,blg,dvi,log,out,tex}
9292

9393
doc/index.rst:
94-
(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.$$$$ $@
94+
(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.$$$$ $@
9595

9696
.PHONY: doc/index.rst

‎doc/index.rst

+4
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ c-lightning Documentation
2727
:maxdepth: 1
2828
:caption: Manpages
2929

30+
lightningd <lightningd.8.md>
31+
lightningd-config <lightningd-config.5.md>
32+
lightningd <lightningd.8.md>
33+
lightningd-config <lightningd-config.5.md>
3034
lightning-autocleaninvoice <lightning-autocleaninvoice.7.md>
3135
lightning-check <lightning-check.7.md>
3236
lightning-cli <lightning-cli.1.md>

‎doc/lightning-autocleaninvoice.7

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.TH "LIGHTNING-AUTOCLEANINVOICE" "7" "" "" "lightning-autocleaninvoice"
22
.SH NAME
3-
3+
lightning-autocleaninvoice - Set up auto-delete of expired invoice
44

55
lightning-autocleaninvoice - Set up auto-delete of expired invoice
66

@@ -32,17 +32,13 @@ On success, an empty object is returned\.
3232

3333
.SH AUTHOR
3434

35-
ZmnSCPxj \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
35+
ZmnSCPxj \fI<[email protected]\fR> is mainly responsible\.
3636

3737
.SH SEE ALSO
3838

3939
\fBlightning-delexpiredinvoice\fR(7), \fBlightning-delinvoice\fR(7)
4040

4141
.SH RESOURCES
4242

43-
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
44-
45-
.HL
46-
47-
Last updated 2019-04-07 14:23:17 CEST
43+
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
4844

‎doc/lightning-autocleaninvoice.7.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
LIGHTNING-AUTOCLEANINVOICE(7) Manual Page
2-
=========================================
3-
lightning-autocleaninvoice - Set up auto-delete of expired invoice
1+
lightning-autocleaninvoice -- Set up auto-delete of expired invoice
2+
===================================================================
43

54
SYNOPSIS
65
--------
@@ -42,7 +41,3 @@ RESOURCES
4241
---------
4342

4443
Main web site: <https://github.com/ElementsProject/lightning>
45-
46-
------------------------------------------------------------------------
47-
48-
Last updated 2019-04-07 14:23:17 CEST

‎doc/lightning-check.7

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
.TH "LIGHTNING-CHECK" "7" "" "" "lightning-check"
22
.SH NAME
3-
4-
53
lightning-check - Command for verifying parameters
6-
74
.SH SYNOPSIS
85

96
\fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR]
@@ -31,14 +28,10 @@ relevant RPC error is returned\.
3128

3229
.SH AUTHOR
3330

34-
Mark Beckwith \fBNone\fR (\fI<[email protected]\fR)> and Rusty Russell
35-
\fBNone\fR (\fI<[email protected]\fR)> are mainly responsible\.
31+
Mark Beckwith \fI<[email protected]\fR> and Rusty Russell
32+
\fI<[email protected]\fR> are mainly responsible\.
3633

3734
.SH RESOURCES
3835

39-
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
40-
41-
.HL
42-
43-
Last updated 2019-04-30 17:12:10 CEST
36+
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
4437

‎doc/lightning-check.7.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
LIGHTNING-CHECK(7) Manual Page
1+
lightning-check -- Command for verifying parameters
22
==============================
3-
lightning-check - Command for verifying parameters
43

54
SYNOPSIS
65
--------
@@ -37,7 +36,3 @@ RESOURCES
3736
---------
3837

3938
Main web site: <https://github.com/ElementsProject/lightning>
40-
41-
------------------------------------------------------------------------
42-
43-
Last updated 2019-04-30 17:12:10 CEST

‎doc/lightning-cli.1

+2-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
.TH "LIGHTNING-CLI" "1" "" "" "lightning-cli"
22
.SH NAME
3-
4-
53
lightning-cli - Control lightning daemon
6-
74
.SH SYNOPSIS
85

96
\fBlightning-cli\fR [\fIOPTIONS\fR] \fIcommand\fR…
@@ -83,18 +80,14 @@ pretty printing of results isn’t pretty\.
8380

8481
.SH AUTHOR
8582

86-
Rusty Russell \fBNone\fR (\fI<[email protected]\fR)> is mainly to blame\.
83+
Rusty Russell \fI<[email protected]\fR> is mainly to blame\.
8784

8885
.SH RESOURCES
8986

90-
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
87+
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
9188

9289
.SH COPYING
9390

9491
Note: the modules in the ccan/ directory have their own licenses, but
9592
the rest of the code is covered by the BSD-style MIT license\.
9693

97-
.HL
98-
99-
Last updated 2019-04-30 17:39:53 CEST
100-

‎doc/lightning-cli.1.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
LIGHTNING-CLI(1) Manual Page
2-
============================
3-
lightning-cli - Control lightning daemon
1+
lightning-cli -- Control lightning daemon
2+
=========================================
43

54
SYNOPSIS
65
--------
@@ -91,7 +90,3 @@ COPYING
9190

9291
Note: the modules in the ccan/ directory have their own licenses, but
9392
the rest of the code is covered by the BSD-style MIT license.
94-
95-
------------------------------------------------------------------------
96-
97-
Last updated 2019-04-30 17:39:53 CEST

‎doc/lightning-close.7

+2-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
.TH "LIGHTNING-CLOSE" "7" "" "" "lightning-close"
22
.SH NAME
3-
4-
53
lightning-close - Command for closing channels with direct peers
6-
74
.SH SYNOPSIS
85

96
\fBclose\fR \fIid\fR [\fIunilateraltimeout\fR]
@@ -59,17 +56,13 @@ vary based on the peer \fIto_self_delay\fR setting, not your own setting\.
5956

6057
.SH AUTHOR
6158

62-
ZmnSCPxj \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
59+
ZmnSCPxj \fI<[email protected]\fR> is mainly responsible\.
6360

6461
.SH SEE ALSO
6562

6663
\fBlightning-disconnect\fR(7), \fBlightning-fundchannel\fR(7)
6764

6865
.SH RESOURCES
6966

70-
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
71-
72-
.HL
73-
74-
Last updated 2019-08-09 11:12:04 CEST
67+
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
7568

‎doc/lightning-close.7.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
LIGHTNING-CLOSE(7) Manual Page
2-
==============================
3-
lightning-close - Command for closing channels with direct peers
1+
lightning-close -- Command for closing channels with direct peers
2+
=================================================================
43

54
SYNOPSIS
65
--------
@@ -68,7 +67,3 @@ RESOURCES
6867
---------
6968

7069
Main web site: <https://github.com/ElementsProject/lightning>
71-
72-
------------------------------------------------------------------------
73-
74-
Last updated 2019-08-09 11:12:04 CEST

‎doc/lightning-connect.7

+4-13
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
.TH "LIGHTNING-CONNECT" "7" "" "" "lightning-connect"
22
.SH NAME
3-
4-
5-
lightning-connect - Command for connecting to another lightning node\.
6-
3+
lightning-connect - Command for connecting to another lightning node
74
.SH SYNOPSIS
85

96
\fBconnect\fR \fIid\fR [\fIhost\fR \fIport\fR]
@@ -46,17 +43,15 @@ On success the peer \fIid\fR is returned\.
4643

4744
The following error codes may occur:
4845

49-
.RS
5046
.IP \[bu]
5147
-1: Catchall nonspecific error\. This may occur if the host is not
5248
valid or there are problems communicating with the peer\. \fBconnect\fR
5349
will make up to 10 attempts to connect to the peer before giving up\.
5450

55-
.RE
5651
.SH AUTHOR
5752

58-
Rusty Russell \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
59-
Felix \fBNone\fR (\fI<[email protected]\fR)> is the original author of this manpage\.
53+
Rusty Russell \fI<[email protected]\fR> is mainly responsible\.
54+
Felix \fI<[email protected]\fR> is the original author of this manpage\.
6055

6156
.SH SEE ALSO
6257

@@ -65,9 +60,5 @@ Felix \fBNone\fR (\fI<[email protected]\fR)> is the original author of this manpa
6560

6661
.SH RESOURCES
6762

68-
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
69-
70-
.HL
71-
72-
Last updated 2019-08-01 14:59:36 CEST
63+
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
7364

‎doc/lightning-connect.7.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
LIGHTNING-CONNECT(7) Manual Page
2-
================================
3-
lightning-connect - Command for connecting to another lightning node.
1+
lightning-connect -- Command for connecting to another lightning node
2+
=====================================================================
43

54
SYNOPSIS
65
--------
@@ -59,7 +58,3 @@ RESOURCES
5958
---------
6059

6160
Main web site: <https://github.com/ElementsProject/lightning>
62-
63-
------------------------------------------------------------------------
64-
65-
Last updated 2019-08-01 14:59:36 CEST

‎doc/lightning-decodepay.7

+2-13
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
.TH "LIGHTNING-DECODEPAY" "7" "" "" "lightning-decodepay"
22
.SH NAME
3-
4-
53
lightning-decodepay - Command for decoding a bolt11 string (low-level)
6-
74
.SH SYNOPSIS
85

96
\fBdecodepay\fR \fIbolt11\fR [\fIdescription\fR]
@@ -18,7 +15,6 @@ specified by the BOLT 11 specification\.
1815
On success, an object is returned with the following fields, as
1916
specified by BOLT11:
2017

21-
.RS
2218
.IP \[bu]
2319
\fIcurrency\fR: the BIP173 name for the currency\.
2420
.IP \[bu]
@@ -35,11 +31,9 @@ specified by BOLT11:
3531
\fIdescription\fR: the description of the purpose of the purchase (see
3632
below)
3733

38-
.RE
3934

4035
The following fields are optional:
4136

42-
.RS
4337
.IP \[bu]
4438
\fImsatoshi\fR: the number of millisatoshi requested (if any)\.
4539
.IP \[bu]
@@ -56,7 +50,6 @@ each containing \fIpubkey\fR, \fIshort_channel_id\fR, \fIfee_base_msat\fR,
5650
\fIextra\fR: an array of objects representing unknown fields, each with
5751
one-character \fItag\fR and a \fIdata\fR bech32 string\.
5852

59-
.RE
6053

6154
Technically, the \fIdescription\fR field is optional if a
6255
\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\.
6558

6659
.SH AUTHOR
6760

68-
Rusty Russell \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
61+
Rusty Russell \fI<[email protected]\fR> is mainly responsible\.
6962

7063
.SH SEE ALSO
7164

@@ -77,9 +70,5 @@ Rusty Russell \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
7770

7871
.SH RESOURCES
7972

80-
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
81-
82-
.HL
83-
84-
Last updated 2019-04-30 17:12:10 CEST
73+
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
8574

‎doc/lightning-decodepay.7.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
LIGHTNING-DECODEPAY(7) Manual Page
2-
==================================
3-
lightning-decodepay - Command for decoding a bolt11 string (low-level)
1+
lightning-decodepay -- Command for decoding a bolt11 string (low-level)
2+
=======================================================================
43

54
SYNOPSIS
65
--------
@@ -61,7 +60,3 @@ RESOURCES
6160
---------
6261

6362
Main web site: <https://github.com/ElementsProject/lightning>
64-
65-
------------------------------------------------------------------------
66-
67-
Last updated 2019-04-30 17:12:10 CEST

‎doc/lightning-delexpiredinvoice.7

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
.TH "LIGHTNING-DELEXPIREDINVOICE" "7" "" "" "lightning-delexpiredinvoice"
22
.SH NAME
3-
4-
5-
lightning-delexpiredinvoice - Command for removing expired invoices\.
6-
3+
lightning-delexpiredinvoice - Command for removing expired invoices
74
.SH SYNOPSIS
85

96
\fBdelexpiredinvoice\fR [\fImaxexpirytime\fR]
@@ -23,17 +20,13 @@ On success, an empty object is returned\.
2320

2421
.SH AUTHOR
2522

26-
ZmnSCPxj \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
23+
ZmnSCPxj \fI<[email protected]\fR> is mainly responsible\.
2724

2825
.SH SEE ALSO
2926

3027
\fBlightning-delinvoice\fR(7), \fBlightning-autocleaninvoice\fR(7)
3128

3229
.SH RESOURCES
3330

34-
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
35-
36-
.HL
37-
38-
Last updated 2019-04-07 14:23:17 CEST
31+
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
3932

‎doc/lightning-delexpiredinvoice.7.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
LIGHTNING-DELEXPIREDINVOICE(7) Manual Page
2-
==========================================
3-
lightning-delexpiredinvoice - Command for removing expired invoices.
1+
lightning-delexpiredinvoice -- Command for removing expired invoices
2+
====================================================================
43

54
SYNOPSIS
65
--------
@@ -35,7 +34,3 @@ RESOURCES
3534
---------
3635

3736
Main web site: <https://github.com/ElementsProject/lightning>
38-
39-
------------------------------------------------------------------------
40-
41-
Last updated 2019-04-07 14:23:17 CEST

0 commit comments

Comments
 (0)