aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 15:14:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: Mention keyword arguments, update pay to mention use of null.

Browse Source
This commit is contained in:
ZmnSCPxj
2018-02-11 23:25:43 +00:00
committed by Christian Decker
parent 6757300a0e
commit 4e382ebd94
4 changed files with 47 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/lightning-cli.1
View File

@@ -2,12 +2,12 @@
.\" Title: lightning-cli
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 01/22/2018
.\" Date: 02/11/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-CLI" "1" "01/22/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-CLI" "1" "02/11/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -50,6 +50,32 @@ Named pipe to use to talk to lightning daemon: default is
in the lightning directory\&.
.RE
.PP
\fB\-\-keywords\fR/\fB\-k\fR
.RS 4
Use format
\fIkey\fR=\fIvalue\fR
for parameters in any order
.RE
.PP
\fB\-\-order\fR/\fB\-o\fR
.RS 4
Follow strictly the order of parameters for the command
.RE
.PP
\fB\-\-json\fR/\fB\-J\fR
.RS 4
Return result in JSON format (default unless
\fIhelp\fR
command)
.RE
.PP
\fB\-\-human\-readable\fR/\fB\-H\fR
.RS 4
Return result in human\-readable output (default for
\fIhelp\fR
command)
.RE
.PP
\fB\-\-help\fR/\fB\-h\fR
.RS 4
Print summary of options to standard output and exit\&.
@@ -64,7 +90,7 @@ Print version number to standard output and exit\&.
\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"
.sp
Arguments are provided positionally after the command name\&. 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\&.
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\&.
.sp
Some commands have optional arguments\&. You may use \fInull\fR to skip optional arguments to provide later arguments\&.
.SH "EXAMPLES"