mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-03-01 17:47:30 +01:00
Code Issues Projects Releases Wiki Activity

Added regtest, example, k and null explanation

Browse source 
network was missing regtest as an option. 

The example was too simple, so I added a second one so show how the k option works.

The explanation of how k works should let the user know that in some cases lightningd will interpret the position of an argument which can lead to a weird response from lightningd.

let the users know that using null is not encouraged

@cdecker said "I think we should definitely not encourage null, since that is very brittle and forces us to keep argument ordering, and deprecating arguments is practically impossible."
This commit is contained in:
keblek 2021-02-06 15:21:13 +01:00 • committed by Christian Decker
parent d134580419
commit 50771b5e76
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -25,6 +25,7 @@ Sets configuration file (default: **lightning-dir**/*config* ).
**--mainnet**
**--testnet**
**--signet**
**--regtest**
Sets network explicitly.
**--rpc-file**=*FILE*
@ -83,21 +84,28 @@ 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*,
command name, based on either **-o** or **-k** option. When using **-k**
consider prefixing all arguments of the command with their respective keyword,
this is to avoid having lightningd intrepret the position of an arguement.
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.
optional arguments to provide later arguments, although this is not encouraged.
EXAMPLES
--------
Example 1. List commands
1. List commands
lightning-cli help
2. Fund a 10k sat channel using uncomfirmed outputs
lightning-cli --keywords fundchannel id=028f...ae7d amount=10000sat minconf=0
BUGS
----