mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-19 15:14:23 +01:00
doc/manpages: replace asciidoc by markdown
This commit is contained in:
97
doc/lightning-cli.1.md
Normal file
97
doc/lightning-cli.1.md
Normal file
@@ -0,0 +1,97 @@
|
||||
LIGHTNING-CLI(1) Manual Page
|
||||
============================
|
||||
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 talk to lightning daemon: default is
|
||||
*lightning-rpc* in the lightning directory.
|
||||
|
||||
**--keywords**/**-k**
|
||||
Use format *key*=*value* for parameters in any order
|
||||
|
||||
**--order**/**-o**
|
||||
Follow strictly the order of parameters for the command
|
||||
|
||||
**--json**/**-J**
|
||||
Return result in JSON format (default unless *help* command)
|
||||
|
||||
**--raw**/**-R**
|
||||
Return raw JSON directly as lightningd replies
|
||||
|
||||
**--human-readable**/**-H**
|
||||
Return result in human-readable output (default for *help* command)
|
||||
|
||||
**--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.
|
||||
|
||||
ARGUMENTS
|
||||
---------
|
||||
|
||||
Arguments may be provided positionally or using *key*=*value* after the
|
||||
command name, based on either **-o** or **-k** option. Arguments may be
|
||||
integer numbers (composed entirely of digits), floating-point numbers
|
||||
(has a radix point but otherwise composed of digits), *true*, *false*,
|
||||
or *null*. Other arguments are treated as strings.
|
||||
|
||||
Some commands have optional arguments. You may use *null* to skip
|
||||
optional arguments to provide later arguments.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
Example 1. List commands
|
||||
|
||||
lightning-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.
|
||||
|
||||
------------------------------------------------------------------------
|
||||
|
||||
Last updated 2019-04-30 17:39:53 CEST
|
||||
Reference in New Issue
Block a user