Browse Source

Added regtest, example, k and null explanation

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."
master
keblek 4 years ago
committed by Christian Decker
parent
commit
50771b5e76
  1. 18
      doc/lightning-cli.1.md

18
doc/lightning-cli.1.md

@ -25,6 +25,7 @@ Sets configuration file (default: **lightning-dir**/*config* ).
**--mainnet** **--mainnet**
**--testnet** **--testnet**
**--signet** **--signet**
**--regtest**
Sets network explicitly. Sets network explicitly.
**--rpc-file**=*FILE* **--rpc-file**=*FILE*
@ -83,21 +84,28 @@ ARGUMENTS
--------- ---------
Arguments may be provided positionally or using *key*=*value* after the Arguments may be provided positionally or using *key*=*value* after the
command name, based on either **-o** or **-k** option. Arguments may be command name, based on either **-o** or **-k** option. When using **-k**
integer numbers (composed entirely of digits), floating-point numbers consider prefixing all arguments of the command with their respective keyword,
(has a radix point but otherwise composed of digits), *true*, *false*, 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. or *null*. Other arguments are treated as strings.
Some commands have optional arguments. You may use *null* to skip 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 EXAMPLES
-------- --------
Example 1. List commands 1. List commands
lightning-cli help lightning-cli help
2. Fund a 10k sat channel using uncomfirmed outputs
lightning-cli --keywords fundchannel id=028f...ae7d amount=10000sat minconf=0
BUGS BUGS
---- ----

Loading…
Cancel
Save