mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-18 21:35:11 +01:00
Code Issues Projects Releases Wiki Activity

documentation: s/Protocol/Command/

Browse Source
This commit is contained in:
Felix 2018-04-26 13:22:09 +03:00 committed by Christian Decker
parent 00783884f7
commit 52c243852e
27 changed files with 49 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/Makefile
View File

@ -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)

2
doc/lightning-close.7
View File

@ -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]

2
doc/lightning-close.7.txt
View File

@ -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
--------

6
doc/lightning-decodepay.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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]

2
doc/lightning-decodepay.7.txt
View File

@ -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

6
doc/lightning-delexpiredinvoice.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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]

2
doc/lightning-delexpiredinvoice.7.txt
View File

@ -4,7 +4,7 @@ LIGHTNING-DELEXPIREDINVOICE(7)
NAME
----
lightning-delexpiredinvoice - Protocol for removing expired invoices.
lightning-delexpiredinvoice - Command for removing expired invoices.
SYNOPSIS
--------

6
doc/lightning-delinvoice.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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

2
doc/lightning-delinvoice.7.txt
View File

@ -4,7 +4,7 @@ LIGHTNING-DELINVOICE(7)
NAME
----
lightning-delinvoice - Protocol for removing an invoice.
lightning-delinvoice - Command for removing an invoice.
SYNOPSIS
--------

6
doc/lightning-getroute.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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]

2
doc/lightning-getroute.7.txt
View File

@ -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

2
doc/lightning-invoice.7
View File

@ -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]

2
doc/lightning-invoice.7.txt
View File

@ -4,7 +4,7 @@ LIGHTNING-INVOICE(7)
NAME
----
lightning-invoice - Protocol for accepting payments.
lightning-invoice - Command for accepting payments.
SYNOPSIS
--------

6
doc/lightning-listinvoices.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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]

2
doc/lightning-listinvoices.7.txt
View File

@ -4,7 +4,7 @@ LIGHTNING-LISTINVOICES(7)
NAME
----
lightning-listinvoices - Protocol for querying invoice status
lightning-listinvoices - Command for querying invoice status
SYNOPSIS
--------

2
doc/lightning-listpayments.7
View File

@ -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

2
doc/lightning-listpayments.7.txt
View File

@ -4,7 +4,7 @@ LIGHTNING-LISTPAYMENTS(7)
NAME
----
lightning-listpayments - Protocol for querying payment status
lightning-listpayments - Command for querying payment status
SYNOPSIS
--------

6
doc/lightning-pay.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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]

2
doc/lightning-pay.7.txt
View File

@ -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
--------

2
doc/lightning-sendpay.7
View File

@ -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]

2
doc/lightning-sendpay.7.txt
View File

@ -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
--------

6
doc/lightning-waitanyinvoice.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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]

2
doc/lightning-waitanyinvoice.7.txt
View File

@ -4,7 +4,7 @@ LIGHTNING-WAITANYINVOICE(7)
NAME
----
lightning-waitanyinvoice - Protocol for waiting for payments.
lightning-waitanyinvoice - Command for waiting for payments.
SYNOPSIS
--------

6
doc/lightning-waitinvoice.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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

2
doc/lightning-waitinvoice.7.txt
View File

@ -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
--------

6
doc/lightning-waitsendpay.7
View File

@ -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
.\" -----------------------------------------------------------------
@ -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]

2
doc/lightning-waitsendpay.7.txt
View File

@ -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
--------