mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-19 05:44:12 +01:00
3c3f4731bd
There are no definition lists in Markdown, and lists get mangled if
they follow immediately: they need a line between them.
So use bullets for options, and use an indent so the text gets in the
line below.
Here's a before-and-after example:
```diff
--- /tmp/after 2022-07-20 21:55:54.355487769 +0930
+++ /tmp/after2 2022-07-20 21:58:17.305642576 +0930
@@ -10,38 +10,71 @@
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.
+ • --lightning-dir=DIR
- --conf=PATH Sets configuration file (default: lightning-dir/config ).
+ Set the directory for the lightning daemon we're talking to; defaults to $HOME/.lightning.
- --network=network --mainnet --testnet --signet Sets network explicitly.
+ • --conf=PATH
- --rpc-file=FILE Named pipe to use to talk to lightning daemon: default is lightning-rpc in the lightning directory.
+ Sets configuration file (default: lightning-dir/config ).
- --keywords/-k Use format key=value for parameters in any order
+ • --network=network
- --order/-o Follow strictly the order of parameters for the command
+ • --mainnet
- --json/-J Return result in JSON format (default unless help command, or result contains a format-hint field).
+ • --testnet
- --raw/-R Return raw JSON directly as lightningd replies; this can be faster for large requests.
+ • --signet
- --human-readable/-H Return result in human-readable output.
+ Sets network explicitly.
- --flat/-F Return JSON result in flattened one-per-line output, e.g. { "help": [ { "command": "check" } ] } would become
+ • --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, or result contains a format-hint field).
+
+ • --raw/-R
+
+ Return raw JSON directly as lightningd replies; this can be faster for large requests.
+
+ • --human-readable/-H
+
+ 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.
- --notifications/-N=LEVEL If LEVEL is 'none', then never print out notifications. Otherwise, print out notifications of
- LEVEL or above (one of io, debug, info (the default), unusual or broken: they are prefixed with # .
+ • --notifications/-N=LEVEL
+
+ If LEVEL is 'none', then never print out notifications. Otherwise, print out notifications of LEVEL or above (one of
+ io, debug, info (the default), unusual or broken: they are prefixed with # .
+
+ • --help/-h
+
+ Pretty-print summary of options to standard output and exit. The format can be changed using -F, -R, -J, -H etc.
+
+ • --version/-V
- --help/-h Pretty-print summary of options to standard output and exit. The format can be changed using -F, -R, -J, -H
- etc.
+ Print version number to standard output and exit.
- --version/-V Print version number to standard output and exit.
+ • allow-deprecated-apis=BOOL
- allow-deprecated-apis=BOOL Enable deprecated options. It defaults to true, but you should set it to false when testing to
- ensure that an upgrade won't break your configuration.
+ Enable deprecated options. It defaults to true, but you should set it to false when testing to ensure that an upgrade
+ won't break your configuration.
COMMANDS
lightning-cli simply uses the JSON RPC interface to talk to lightningd, and prints the results. Thus the commands avail‐
@@ -60,13 +93,13 @@
this is not encouraged.
EXAMPLES
- 1. List commands
+ 1. List commands:
- lightning-cli help
+ • lightning-cli help
- 2. Fund a 10k sat channel using uncomfirmed outputs
+ 2. Fund a 10k sat channel using uncomfirmed outputs:
- lightning-cli --keywords fundchannel id=028f...ae7d amount=10000sat minconf=0
+ • lightning-cli --keywords fundchannel id=028f...ae7d amount=10000sat minconf=0
BUGS
This manpage documents how it should work, not how it does work. The pretty printing of results isn't pretty.
```
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
|
||
|---|---|---|
| .. | ||
| release-notes | ||
| schemas | ||
| .gitignore | ||
| BACKUP.md | ||
| bitcoin.bib | ||
| CHANGELOG.md | ||
| commit-tx.eps | ||
| commit-tx.svg | ||
| conf.py | ||
| deployable-lightning.lyx | ||
| deployable-lightning.pdf | ||
| dual-anchor-diag1.eps | ||
| dual-anchor-diag1.svg | ||
| dual-anchor-diag2.eps | ||
| dual-anchor-diag2.svg | ||
| dual-anchor-diag3.eps | ||
| dual-anchor-diag3.svg | ||
| dual-anchor-diag4.eps | ||
| dual-anchor-diag4.svg | ||
| dual-anchor-final.eps | ||
| dual-anchor-final.svg | ||
| dual-anchor-take2.svg | ||
| dual-anchor.svg | ||
| FAQ.md | ||
| FUZZING.md | ||
| HACKING.md | ||
| htlc.eps | ||
| htlc.svg | ||
| index.rst | ||
| INSTALL.md | ||
| lightning-addgossip.7.md | ||
| lightning-autocleaninvoice.7.md | ||
| lightning-bkpr-channelsapy.7.md | ||
| lightning-bkpr-dumpincomecsv.7.md | ||
| lightning-bkpr-inspect.7.md | ||
| lightning-bkpr-listaccountevents.7.md | ||
| lightning-bkpr-listbalances.7.md | ||
| lightning-bkpr-listincome.7.md | ||
| lightning-check.7.md | ||
| lightning-checkmessage.7.md | ||
| lightning-cli.1.md | ||
| lightning-close.7.md | ||
| lightning-commando-rune.7.md | ||
| lightning-commando.7.md | ||
| lightning-connect.7.md | ||
| lightning-createinvoice.7.md | ||
| lightning-createonion.7.md | ||
| lightning-datastore.7.md | ||
| lightning-decode.7.md | ||
| lightning-decodepay.7.md | ||
| lightning-deldatastore.7.md | ||
| lightning-delexpiredinvoice.7.md | ||
| lightning-delinvoice.7.md | ||
| lightning-delpay.7.md | ||
| lightning-disableoffer.7.md | ||
| lightning-disconnect.7.md | ||
| lightning-emergencyrecover.7.md | ||
| lightning-feerates.7.md | ||
| lightning-fetchinvoice.7.md | ||
| lightning-fundchannel_cancel.7.md | ||
| lightning-fundchannel_complete.7.md | ||
| lightning-fundchannel_start.7.md | ||
| lightning-fundchannel.7.md | ||
| lightning-funderupdate.7.md | ||
| lightning-fundpsbt.7.md | ||
| lightning-getinfo.7.md | ||
| lightning-getlog.7.md | ||
| lightning-getroute.7.md | ||
| lightning-help.7.md | ||
| lightning-hsmtool.8.md | ||
| lightning-invoice.7.md | ||
| lightning-keysend.7.md | ||
| lightning-listchannels.7.md | ||
| lightning-listconfigs.7.md | ||
| lightning-listdatastore.7.md | ||
| lightning-listforwards.7.md | ||
| lightning-listfunds.7.md | ||
| lightning-listinvoices.7.md | ||
| lightning-listnodes.7.md | ||
| lightning-listoffers.7.md | ||
| lightning-listpays.7.md | ||
| lightning-listpeers.7.md | ||
| lightning-listsendpays.7.md | ||
| lightning-listtransactions.7.md | ||
| lightning-makesecret.7.md | ||
| lightning-multifundchannel.7.md | ||
| lightning-multiwithdraw.7.md | ||
| lightning-newaddr.7.md | ||
| lightning-notifications.7.md | ||
| lightning-offer.7.md | ||
| lightning-offerout.7.md | ||
| lightning-openchannel_abort.7.md | ||
| lightning-openchannel_bump.7.md | ||
| lightning-openchannel_init.7.md | ||
| lightning-openchannel_signed.7.md | ||
| lightning-openchannel_update.7.md | ||
| lightning-parsefeerate.7.md | ||
| lightning-pay.7.md | ||
| lightning-ping.7.md | ||
| lightning-plugin.7.md | ||
| lightning-recoverchannel.7.md | ||
| lightning-reserveinputs.7.md | ||
| lightning-sendcustommsg.7.md | ||
| lightning-sendinvoice.7.md | ||
| lightning-sendonion.7.md | ||
| lightning-sendonionmessage.7.md | ||
| lightning-sendpay.7.md | ||
| lightning-sendpsbt.7.md | ||
| lightning-setchannel.7.md | ||
| lightning-setchannelfee.7.md | ||
| lightning-signmessage.7.md | ||
| lightning-signpsbt.7.md | ||
| lightning-staticbackup.7.md | ||
| lightning-stop.7.md | ||
| lightning-txdiscard.7.md | ||
| lightning-txprepare.7.md | ||
| lightning-txsend.7.md | ||
| lightning-unreserveinputs.7.md | ||
| lightning-utxopsbt.7.md | ||
| lightning-waitanyinvoice.7.md | ||
| lightning-waitblockheight.7.md | ||
| lightning-waitinvoice.7.md | ||
| lightning-waitsendpay.7.md | ||
| lightning-withdraw.7.md | ||
| lightningd-config.5.md | ||
| lightningd.8.md | ||
| ln-draft-fig1.eps | ||
| ln-draft-fig2.eps | ||
| Makefile | ||
| MAKING-RELEASES.md | ||
| PLUGINS.md | ||
| REPRODUCIBLE.md | ||
| STYLE.md | ||
| TOR.md | ||
| undoc-flags.json | ||
