mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-20 13:54:36 +01:00
Code Issues Projects Releases Wiki Activity

doc: update cli documentation.

Browse source 
1. help now uses a boutique format, not -H.
2. document the -F option.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2020-05-11 10:41:51 +09:30 • committed by Christian Decker
parent abb16b4226
commit 3c625b367d
3 changed files with 34 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
cli/lightning-cli.c
View file

@ -503,7 +503,7 @@ int main(int argc, char *argv[])
opt_register_noarg("--help|-h", opt_usage_and_exit,
"<command> [<params>...]", "Show this message. Use the command help (without hyphens -- \"lightning-cli help\") to get a list of all RPC commands");
opt_register_noarg("-H|--human-readable", opt_set_human, &format,
"Human-readable output (default for 'help')");
"Human-readable output");
opt_register_noarg("-F|--flat", opt_set_flat, &format,
"Flatten output ('x.y.x=' format)");
opt_register_noarg("-J|--json", opt_set_json, &format,

24
doc/lightning-cli.1
View file

@ -41,24 +41,40 @@ 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)
Return result in JSON format (default unless \fIhelp\fR command,
or result contains a \fBformat-hint\fR field)\.
\fB--raw\fR/\fB-R\fR
Return raw JSON directly as lightningd replies
Return raw JSON directly as lightningd replies; this can be faster for
large requests\.
\fB--human-readable\fR/\fB-H\fR
Return result in human-readable output (default for \fIhelp\fR command)
Return result in human-readable output\.
\fB--flat\fR/\fB-F\fR
Return JSON result in flattened one-per-line output, e\.g\. \fB{ "help":
[ { "command": "check" } ] }\fR would become \fBhelp[0].command=check\fR\.
This is useful for simple scripts which want to find a specific output
field without parsing JSON\.
\fB--help\fR/\fB-h\fR
Print summary of options to standard output and exit\.
Pretty-print summary of options to standard output and exit\. The format can
be changed using -F, -R, -J, -H etc\.
\fB--version\fR/\fB-V\fR
Print version number to standard output and exit\.
\fBallow-deprecated-apis\fR=\fIBOOL\fR
Enable deprecated options\. It defaults to \fItrue\fR, but you should set
it to \fIfalse\fR when testing to ensure that an upgrade won’t break your
configuration\.
.SH COMMANDS
\fIlightning-cli\fR simply uses the JSON RPC interface to talk to

17
doc/lightning-cli.1.md
View file

@ -38,16 +38,25 @@ Use format *key*=*value* for parameters in any order
Follow strictly the order of parameters for the command
**--json**/**-J**
Return result in JSON format (default unless *help* command)
Return result in JSON format (default unless *help* command,
or result contains a `format-hint` field).
**--raw**/**-R**
Return raw JSON directly as lightningd replies
Return raw JSON directly as lightningd replies; this can be faster for
large requests.
**--human-readable**/**-H**
Return result in human-readable output (default for *help* command)
Return result in human-readable output.
**--flat**/**-F**
Return JSON result in flattened one-per-line output, e.g. `{ "help":
[ { "command": "check" } ] }` would become `help[0].command=check`.
This is useful for simple scripts which want to find a specific output
field without parsing JSON.
**--help**/**-h**
Print summary of options to standard output and exit.
Pretty-print summary of options to standard output and exit. The format can
be changed using -F, -R, -J, -H etc.
**--version**/**-V**
Print version number to standard output and exit.