Skip to content

Commit

Permalink
documentation: s/Protocol/Command/
Browse files Browse the repository at this point in the history
  • Loading branch information
@fixone @cdecker
fixone authored and cdecker committed Apr 27, 2018
1 parent 0078388 commit 52c2438
Show file tree
Hide file tree
Showing 27 changed files with 49 additions and 47 deletions.
8 changes: 5 additions & 3 deletions doc/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,23 @@ doc-wrongdir:
MANPAGES := doc/lightning-cli.1 \
doc/lightning-autocleaninvoice.7 \
doc/lightning-close.7 \
doc/lightning-connect.7 \
doc/lightning-decodepay.7 \
doc/lightning-delexpiredinvoice.7 \
doc/lightning-delinvoice.7 \
doc/lightning-getroute.7 \
doc/lightning-invoice.7 \
doc/lightning-listfunds.7 \
doc/lightning-listinvoices.7 \
doc/lightning-listpayments.7 \
doc/lightning-newaddr.7 \
doc/lightning-pay.7 \
doc/lightning-sendpay.7 \
doc/lightning-waitinvoice.7 \
doc/lightning-waitanyinvoice.7 \
doc/lightning-waitsendpay.7 \
doc/lightning-newaddr.7 \
doc/lightning-withdraw.7 \
doc/lightning-listfunds.7
doc/lightning-withdraw.7


doc-all: $(MANPAGES)

Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-close.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-close \- Protocol for closing channels with direct peers
lightning-close \- Command for closing channels with direct peers
.SH "SYNOPSIS"
.sp
\fBclose\fR \fIid\fR [\fIforce\fR] [\fItimeout\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-close.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-CLOSE(7)

NAME
----
lightning-close - Protocol for closing channels with direct peers
lightning-close - Command for closing channels with direct peers

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-decodepay.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-decodepay
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 04/05/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-DECODEPAY" "7" "04/05/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-DECODEPAY" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-decodepay \- Protocol for decoding a bolt11 string (low\-level)
lightning-decodepay \- Command for decoding a bolt11 string (low\-level)
.SH "SYNOPSIS"
.sp
\fBdecodepay\fR \fIbolt11\fR [\fIdescription\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-decodepay.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-DECODEPAY(7)

NAME
----
lightning-decodepay - Protocol for decoding a bolt11 string (low-level)
lightning-decodepay - Command for decoding a bolt11 string (low-level)


SYNOPSIS
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-delexpiredinvoice.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-delexpiredinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/17/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-DELEXPIRE" "7" "03/17/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-DELEXPIRE" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-delexpiredinvoice \- Protocol for removing expired invoices\&.
lightning-delexpiredinvoice \- Command for removing expired invoices\&.
.SH "SYNOPSIS"
.sp
\fBdelexpiredinvoice\fR [\fImaxexpirytime\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-delexpiredinvoice.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-DELEXPIREDINVOICE(7)

NAME
----
lightning-delexpiredinvoice - Protocol for removing expired invoices.
lightning-delexpiredinvoice - Command for removing expired invoices.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-delinvoice.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-delinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/17/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-DELINVOIC" "7" "03/17/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-DELINVOIC" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-delinvoice \- Protocol for removing an invoice\&.
lightning-delinvoice \- Command for removing an invoice\&.
.SH "SYNOPSIS"
.sp
\fBdelinvoice\fR \fIlabel\fR \fIstatus\fR
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-delinvoice.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-DELINVOICE(7)

NAME
----
lightning-delinvoice - Protocol for removing an invoice.
lightning-delinvoice - Command for removing an invoice.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-getroute.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-getroute
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/19/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-GETROUTE" "7" "02/19/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-GETROUTE" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-getroute \- Protocol for routing a payment (low\-level)\&.
lightning-getroute \- Command for routing a payment (low\-level)\&.
.SH "SYNOPSIS"
.sp
\fBgetroute\fR \fIid\fR \fImsatoshi\fR \fIriskfactor\fR [\fIcltv\fR] [\fIfuzzpercent\fR] [\fIseed\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-getroute.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-GETROUTE(7)

NAME
----
lightning-getroute - Protocol for routing a payment (low-level).
lightning-getroute - Command for routing a payment (low-level).


SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-invoice.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-invoice \- Protocol for accepting payments\&.
lightning-invoice \- Command for accepting payments\&.
.SH "SYNOPSIS"
.sp
\fBinvoice\fR \fImsatoshi\fR \fIlabel\fR \fIdescription\fR [\fIexpiry\fR] [\fIfallbacks\fR] [\fIpreimage\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-invoice.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-INVOICE(7)

NAME
----
lightning-invoice - Protocol for accepting payments.
lightning-invoice - Command for accepting payments.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-listinvoices.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-listinvoices
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 01/18/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-LISTINVOI" "7" "01/18/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-LISTINVOI" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-listinvoices \- Protocol for querying invoice status
lightning-listinvoices \- Command for querying invoice status
.SH "SYNOPSIS"
.sp
\fBlistinvoices\fR [\fIlabel\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listinvoices.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-LISTINVOICES(7)

NAME
----
lightning-listinvoices - Protocol for querying invoice status
lightning-listinvoices - Command for querying invoice status

SYNOPSIS
--------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listpayments.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-listpayments \- Protocol for querying payment status
lightning-listpayments \- Command for querying payment status
.SH "SYNOPSIS"
.sp
\fBlistpayments\fR
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listpayments.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-LISTPAYMENTS(7)

NAME
----
lightning-listpayments - Protocol for querying payment status
lightning-listpayments - Command for querying payment status

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-pay.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-pay
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/21/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-PAY" "7" "03/21/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-PAY" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-pay \- Protocol for sending a payment to a BOLT11 invoice
lightning-pay \- Command for sending a payment to a BOLT11 invoice
.SH "SYNOPSIS"
.sp
\fBpay\fR \fIbolt11\fR [\fImsatoshi\fR] [\fIdescription\fR] [\fIriskfactor\fR] [\fImaxfeepercent\fR] [\fIretry_for\fR] [\fImaxdelay\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-pay.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-PAY(7)

NAME
----
lightning-pay - Protocol for sending a payment to a BOLT11 invoice
lightning-pay - Command for sending a payment to a BOLT11 invoice

SYNOPSIS
--------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-sendpay.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-sendpay \- Protocol for sending a payment via a route\&.
lightning-sendpay \- Command for sending a payment via a route\&.
.SH "SYNOPSIS"
.sp
\fBsendpay\fR \fIroute\fR \fIhash\fR [\fImsatoshi\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-sendpay.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-SENDPAY(7)

NAME
----
lightning-sendpay - Protocol for sending a payment via a route.
lightning-sendpay - Command for sending a payment via a route.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-waitanyinvoice.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-waitanyinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 01/13/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-WAITANYIN" "7" "01/13/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-WAITANYIN" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-waitanyinvoice \- Protocol for waiting for payments\&.
lightning-waitanyinvoice \- Command for waiting for payments\&.
.SH "SYNOPSIS"
.sp
\fBwaitanyinvoice\fR [\fIlastpay_index\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-waitanyinvoice.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-WAITANYINVOICE(7)

NAME
----
lightning-waitanyinvoice - Protocol for waiting for payments.
lightning-waitanyinvoice - Command for waiting for payments.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-waitinvoice.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-waitinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/03/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-WAITINVOI" "7" "02/03/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-WAITINVOI" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-waitinvoice \- Protocol for waiting for specific payment\&.
lightning-waitinvoice \- Command for waiting for specific payment\&.
.SH "SYNOPSIS"
.sp
\fBwaitinvoice\fR \fIlabel\fR
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-waitinvoice.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-WAITINVOICE(7)

NAME
----
lightning-waitinvoice - Protocol for waiting for specific payment.
lightning-waitinvoice - Command for waiting for specific payment.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-waitsendpay.7
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-waitsendpay
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/14/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-WAITSENDP" "7" "03/14/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-WAITSENDP" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-waitsendpay \- Protocol for sending a payment via a route\&.
lightning-waitsendpay \- Command for sending a payment via a route\&.
.SH "SYNOPSIS"
.sp
\fBwaitsendpay\fR \fIpayment_hash\fR [\fItimeout\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-waitsendpay.7.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-WAITSENDPAY(7)

NAME
----
lightning-waitsendpay - Protocol for sending a payment via a route.
lightning-waitsendpay - Command for sending a payment via a route.

SYNOPSIS
--------
Expand Down

0 comments on commit 52c2438

Please sign in to comment.