-
Notifications
You must be signed in to change notification settings - Fork 890
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: manpages for the various lightning RPC calls.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
- Loading branch information
1 parent
ab125f7
commit 2452df3
Showing
16 changed files
with
1,003 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| '\" t | ||
| .\" Title: lightning-cli | ||
| .\" Author: [see the "AUTHOR" section] | ||
| .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> | ||
| .\" Date: 09/06/2016 | ||
| .\" Manual: \ \& | ||
| .\" Source: \ \& | ||
| .\" Language: English | ||
| .\" | ||
| .TH "LIGHTNING\-CLI" "1" "09/06/2016" "\ \&" "\ \&" | ||
| .\" ----------------------------------------------------------------- | ||
| .\" * Define some portability stuff | ||
| .\" ----------------------------------------------------------------- | ||
| .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| .\" http://bugs.debian.org/507673 | ||
| .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | ||
| .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| .ie \n(.g .ds Aq \(aq | ||
| .el .ds Aq ' | ||
| .\" ----------------------------------------------------------------- | ||
| .\" * set default formatting | ||
| .\" ----------------------------------------------------------------- | ||
| .\" disable hyphenation | ||
| .nh | ||
| .\" disable justification (adjust text to left margin only) | ||
| .ad l | ||
| .\" ----------------------------------------------------------------- | ||
| .\" * MAIN CONTENT STARTS HERE * | ||
| .\" ----------------------------------------------------------------- | ||
| .SH "NAME" | ||
| lightning-cli \- Control lightning daemon | ||
| .SH "SYNOPSIS" | ||
| .sp | ||
| \fBlightning\-cli\fR [\fIOPTIONS\fR] \fIcommand\fR\&... | ||
| .SH "DESCRIPTION" | ||
| .sp | ||
| \fBlightning\-cli\fR sends commands to the lightning daemon\&. | ||
| .SH "OPTIONS" | ||
| .PP | ||
| \fB\-\-lightning\-dir\fR=\fIDIR\fR | ||
| .RS 4 | ||
| Set the directory for the lightning daemon we\(cqre talking to; defaults to | ||
| \fI$HOME/\&.lightning\fR\&. | ||
| .RE | ||
| .PP | ||
| \fB\-\-rpc\-file\fR=\fIFILE\fR | ||
| .RS 4 | ||
| Named pipe to use to to talk to lightning daemon: default is | ||
| \fIlightning\-rpc\fR | ||
| in the lightning directory\&. | ||
| .RE | ||
| .PP | ||
| \fB\-\-help\fR/\fB\-h\fR | ||
| .RS 4 | ||
| Print summary of options to standard output and exit\&. | ||
| .RE | ||
| .PP | ||
| \fB\-\-version\fR/\fB\-V\fR | ||
| .RS 4 | ||
| Print version number to standard output and exit\&. | ||
| .RE | ||
| .SH "COMMANDS" | ||
| .sp | ||
| \fIlightning\-cli\fR simply uses the JSON RPC interface to talk to \fIlightningd\fR, and prints the results\&. Thus the commands available depend entirely on the lightning daemon itself\&. | ||
| .SH "EXAMPLES" | ||
| .PP | ||
| \fBExample\ \&1.\ \&List commands\fR | ||
| .sp | ||
| lighting\-cli help | ||
| .SH "BUGS" | ||
| .sp | ||
| This manpage documents how it should work, not how it does work\&. The pretty printing of results isn\(cqt pretty\&. | ||
| .SH "AUTHOR" | ||
| .sp | ||
| Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly to blame\&. | ||
| .SH "RESOURCES" | ||
| .sp | ||
| Main web site: https://github\&.com/ElementsProject/lightning | ||
| .SH "COPYING" | ||
| .sp | ||
| 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\&. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| LIGHTNING-CLI(1) | ||
| ================== | ||
| :doctype: manpage | ||
|
|
||
| NAME | ||
| ---- | ||
| lightning-cli - Control lightning daemon | ||
|
|
||
|
|
||
| SYNOPSIS | ||
| -------- | ||
| *lightning-cli* ['OPTIONS'] 'command'... | ||
|
|
||
| DESCRIPTION | ||
| ----------- | ||
| *lightning-cli* sends commands to the lightning daemon. | ||
|
|
||
| OPTIONS | ||
| ------- | ||
| *--lightning-dir*='DIR':: | ||
| Set the directory for the lightning daemon we're talking to; defaults to | ||
| '$HOME/.lightning'. | ||
| *--rpc-file*='FILE':: | ||
| Named pipe to use to to talk to lightning daemon: default is 'lightning-rpc' | ||
| in the lightning directory. | ||
| *--help*/*-h*:: | ||
| Print summary of options to standard output and exit. | ||
| *--version*/*-V*:: | ||
| Print version number to standard output and exit. | ||
|
|
||
| COMMANDS | ||
| -------- | ||
| 'lightning-cli' simply uses the JSON RPC interface to talk to 'lightningd', | ||
| and prints the results. Thus the commands available depend entirely on the | ||
| lightning daemon itself. | ||
|
|
||
| EXAMPLES | ||
| -------- | ||
| .List commands | ||
| =================================================================== | ||
| lighting-cli help | ||
| =================================================================== | ||
|
|
||
| BUGS | ||
| ---- | ||
| This manpage documents how it should work, not how it does work. The | ||
| pretty printing of results isn't pretty. | ||
|
|
||
| AUTHOR | ||
| ------ | ||
| Rusty Russell <rusty@rustcorp.com.au> is mainly to blame. | ||
|
|
||
| RESOURCES | ||
| --------- | ||
| Main web site: https://github.com/ElementsProject/lightning | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| '\" t | ||
| .\" Title: lightning-delinvoice | ||
| .\" Author: [see the "AUTHOR" section] | ||
| .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> | ||
| .\" Date: 09/06/2016 | ||
| .\" Manual: \ \& | ||
| .\" Source: \ \& | ||
| .\" Language: English | ||
| .\" | ||
| .TH "LIGHTNING\-DELINVOIC" "7" "09/06/2016" "\ \&" "\ \&" | ||
| .\" ----------------------------------------------------------------- | ||
| .\" * Define some portability stuff | ||
| .\" ----------------------------------------------------------------- | ||
| .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| .\" http://bugs.debian.org/507673 | ||
| .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | ||
| .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| .ie \n(.g .ds Aq \(aq | ||
| .el .ds Aq ' | ||
| .\" ----------------------------------------------------------------- | ||
| .\" * set default formatting | ||
| .\" ----------------------------------------------------------------- | ||
| .\" disable hyphenation | ||
| .nh | ||
| .\" disable justification (adjust text to left margin only) | ||
| .ad l | ||
| .\" ----------------------------------------------------------------- | ||
| .\" * MAIN CONTENT STARTS HERE * | ||
| .\" ----------------------------------------------------------------- | ||
| .SH "NAME" | ||
| lightning-delinvoice \- Protocol for removing an unpaid invoice\&. | ||
| .SH "SYNOPSIS" | ||
| .sp | ||
| \fBdelinvoice\fR \fIlabel\fR | ||
| .SH "DESCRIPTION" | ||
| .sp | ||
| The \fBdelinvoice\fR RPC command removes an unpaid invoice\&. The caller should be particularly aware of the error case caused by a payment just before this command is invoked! | ||
| .SH "RETURN VALUE" | ||
| .sp | ||
| On success, the \fIrhash\fR, \fIlabel\fR and \fImsatoshi\fR will be returned\&. | ||
| .SH "AUTHOR" | ||
| .sp | ||
| Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly responsible\&. | ||
| .SH "SEE ALSO" | ||
| .sp | ||
| lightning\-listinvoice(7), lightning\-waitinvoice(7), lightning\-invoice(7)\&. | ||
| .SH "RESOURCES" | ||
| .sp | ||
| Main web site: https://github\&.com/ElementsProject/lightning |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| LIGHTNING-DELINVOICE(7) | ||
| ======================= | ||
| :doctype: manpage | ||
|
|
||
| NAME | ||
| ---- | ||
| lightning-delinvoice - Protocol for removing an unpaid invoice. | ||
|
|
||
| SYNOPSIS | ||
| -------- | ||
| *delinvoice* 'label' | ||
|
|
||
| DESCRIPTION | ||
| ----------- | ||
| The *delinvoice* RPC command removes an unpaid invoice. The caller | ||
| should be particularly aware of the error case caused by a payment | ||
| just before this command is invoked! | ||
|
|
||
| RETURN VALUE | ||
| ------------ | ||
| On success, the 'rhash', 'label' and 'msatoshi' will be returned. | ||
|
|
||
| //FIXME:Enumerate errors | ||
|
|
||
| AUTHOR | ||
| ------ | ||
| Rusty Russell <rusty@rustcorp.com.au> is mainly responsible. | ||
|
|
||
| SEE ALSO | ||
| -------- | ||
| lightning-listinvoice(7), lightning-waitinvoice(7), lightning-invoice(7). | ||
|
|
||
| RESOURCES | ||
| --------- | ||
| Main web site: https://github.com/ElementsProject/lightning |
Oops, something went wrong.