mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
c3254e6639
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.
94 lines
2.3 KiB
Groff
94 lines
2.3 KiB
Groff
.TH "LIGHTNING-CLI" "1" "" "" "lightning-cli"
|
||
.SH NAME
|
||
lightning-cli - Control lightning daemon
|
||
.SH SYNOPSIS
|
||
|
||
\fBlightning-cli\fR [\fIOPTIONS\fR] \fIcommand\fR…
|
||
|
||
.SH DESCRIPTION
|
||
|
||
\fBlightning-cli\fR sends commands to the lightning daemon\.
|
||
|
||
.SH OPTIONS
|
||
|
||
\fB--lightning-dir\fR=\fIDIR\fR
|
||
Set the directory for the lightning daemon we’re talking to; defaults to
|
||
\fI$HOME/\.lightning\fR\.
|
||
|
||
|
||
\fB--rpc-file\fR=\fIFILE\fR
|
||
Named pipe to use to talk to lightning daemon: default is
|
||
\fIlightning-rpc\fR in the lightning directory\.
|
||
|
||
|
||
\fB--keywords\fR/\fB-k\fR
|
||
Use format \fIkey\fR=\fIvalue\fR for parameters in any order
|
||
|
||
|
||
\fB--order\fR/\fB-o\fR
|
||
Follow strictly the order of parameters for the command
|
||
|
||
|
||
\fB--json\fR/\fB-J\fR
|
||
Return result in JSON format (default unless \fIhelp\fR command)
|
||
|
||
|
||
\fB--raw\fR/\fB-R\fR
|
||
Return raw JSON directly as lightningd replies
|
||
|
||
|
||
\fB--human-readable\fR/\fB-H\fR
|
||
Return result in human-readable output (default for \fIhelp\fR command)
|
||
|
||
|
||
\fB--help\fR/\fB-h\fR
|
||
Print summary of options to standard output and exit\.
|
||
|
||
|
||
\fB--version\fR/\fB-V\fR
|
||
Print version number to standard output and exit\.
|
||
|
||
.SH COMMANDS
|
||
|
||
\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 ARGUMENTS
|
||
|
||
Arguments may be provided positionally or using \fIkey\fR=\fIvalue\fR after the
|
||
command name, based on either \fB-o\fR or \fB-k\fR option\. Arguments may be
|
||
integer numbers (composed entirely of digits), floating-point numbers
|
||
(has a radix point but otherwise composed of digits), \fItrue\fR, \fIfalse\fR,
|
||
or \fInull\fR\. Other arguments are treated as strings\.
|
||
|
||
|
||
Some commands have optional arguments\. You may use \fInull\fR to skip
|
||
optional arguments to provide later arguments\.
|
||
|
||
.SH EXAMPLES
|
||
|
||
Example 1\. List commands
|
||
|
||
|
||
lightning-cli help
|
||
|
||
.SH BUGS
|
||
|
||
This manpage documents how it should work, not how it does work\. The
|
||
pretty printing of results isn’t pretty\.
|
||
|
||
.SH AUTHOR
|
||
|
||
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly to blame\.
|
||
|
||
.SH RESOURCES
|
||
|
||
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\.
|
||
|