mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 06:41:44 +01:00
Code Issues Projects Releases Wiki Activity
core-lightning/doc/index.rst

117 lines
4.9 KiB
ReStructuredText
Raw Normal View History

doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-06 14:39:48 +09:30
Core Lightning Documentation
============================
docs: Add configuration for the sphinx documentation generator This just takes the existing documentation, and generates a nice HTML version we can point users to. The documentation is automatically generated on every commit to `master` and will be deployed here: https://lightning.readthedocs.io/ Signed-off-by: Christian Decker <decker.christian@gmail.com>
2019-02-08 16:11:18 +01:00
.. toctree::
:maxdepth: 1
:caption: User Documentation
INSTALL.md
TOR.md
doc: start an FAQ This regroups questions (frequently) seen in Github issues, on IRC, and also some I've been asked in face to face. Changelog-Added: doc: An FAQ was added, accessible at https://lightning.readthedocs.io/FAQ.html Christian wrote the block chain rescaning paragraph. Lisa corrected my poor english grammar. Co-Authored-by: Christian Decker <decker.christian@gmail.com> Co-Authored-by: Lisa Neigut <niftynei@gmail.com>
2020-02-26 16:54:30 +01:00
FAQ <FAQ.md>
doc/BACKUP.md: Document backup strategies for `lightningd`. ChangeLog-Added: Document: `doc/BACKUP.md` describes how to back up your C-lightning node.
2020-11-17 21:13:00 +08:00
Backups <BACKUP.md>
docs: Add configuration for the sphinx documentation generator This just takes the existing documentation, and generates a nice HTML version we can point users to. The documentation is automatically generated on every commit to `master` and will be deployed here: https://lightning.readthedocs.io/ Signed-off-by: Christian Decker <decker.christian@gmail.com>
2019-02-08 16:11:18 +01:00
.. toctree::
:maxdepth: 2
:caption: Integrator Documentation
Writing plugins <PLUGINS.md>
.. toctree::
:maxdepth: 1
:caption: Developer Documentation
HACKING.md
Coding Style Guideline <STYLE.md>
MAKING-RELEASES.md
CHANGELOG.md
doc/manpages: Add manpages to readthedocs
2019-08-10 02:21:23 +02:00
.. toctree::
:maxdepth: 1
:caption: Manpages
docs: document addgossip API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `addgossip` allows direct injection of network gossip messages.
2021-02-02 15:46:22 +10:30
lightning-addgossip <lightning-addgossip.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-autocleaninvoice <lightning-autocleaninvoice.7.md>
lightning-check <lightning-check.7.md>
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 15:49:37 +10:30
lightning-checkmessage <lightning-checkmessage.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-cli <lightning-cli.1.md>
lightning-close <lightning-close.7.md>
lightning-connect <lightning-connect.7.md>
lightningd: createinvoice low-level invoice creation command. This takes an unsigned bolt11 (or bolt12 if EXPERIMENTAL_FEATURES) string and signs it and puts it in the database. The invoice command could now be moved out to a plugin, in fact. Changelog-Added: JSON-RPC: `createinvoice` new low-level invoice creation API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-12-14 11:51:48 +10:30
lightning-createinvoice <lightning-createinvoice.7.md>
doc: Add manpages for `createonion` and `sendonion` Changelog-Added: Added `createonion` and `sendonion` JSON-RPC methods allowing the implementation of custom protocol extensions that are not directly implemented in c-lightning itself.
2019-11-14 17:51:28 +01:00
lightning-createonion <lightning-createonion.7.md>
JSON-RPC: add interfaces to access datastore. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `datastore`, `deldatastore` and `listdatastore` for plugins to store simple persistent key/value data.
2021-08-25 12:20:12 +09:30
lightning-datastore <lightning-datastore.7.md>
decode: new generic API to decode bolt11 and bolt12. This is experimental for now, but can eventually deprecated 'decodepay' and even decode other kinds of messages. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-08 05:18:47 +10:30
lightning-decode <lightning-decode.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-decodepay <lightning-decodepay.7.md>
JSON-RPC: add interfaces to access datastore. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `datastore`, `deldatastore` and `listdatastore` for plugins to store simple persistent key/value data.
2021-08-25 12:20:12 +09:30
lightning-deldatastore <lightning-deldatastore.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-delexpiredinvoice <lightning-delexpiredinvoice.7.md>
lightning-delinvoice <lightning-delinvoice.7.md>
delpay: code style changes and fixed docs Changelog-Added: JSON-RPC: delpay a new method to delete the payment completed or failed. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-08 17:47:53 +02:00
lightning-delpay <lightning-delpay.7.md>
doc: add disableoffer and listoffers manpages. I noticed that offer(7) referred to `deloffer` which doesn't exist. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-02-18 10:26:19 +10:30
lightning-disableoffer <lightning-disableoffer.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-disconnect <lightning-disconnect.7.md>
doc: update since addition of feerate(7) Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-13 11:48:38 +09:30
lightning-feerates <lightning-feerates.7.md>
doc: document experimental commands. Not the low-level ones, just enough that people can play with the APIs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-08 05:15:47 +10:30
lightning-fetchinvoice <lightning-fetchinvoice.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-fundchannel <lightning-fundchannel.7.md>
lightning-fundchannel_cancel <lightning-fundchannel_cancel.7.md>
lightning-fundchannel_complete <lightning-fundchannel_complete.7.md>
lightning-fundchannel_start <lightning-fundchannel_start.7.md>
funderupdate: add documentation, update some params Documentation for the funderupdate command on the funder plugin. Realized we were missing the "leases_only" in the output; also adds '_msat' to msat denominated outputs so they're parsed correctly by our python bindings (also matches our naming conventions) Changelog-EXPERIMENTAL: funder: `funderupdate` command to view and update params for contributing our wallet funds to v2 channel openings. Provides params for enabling `option_will_fund`.
2021-07-15 11:48:36 -05:00
lightning-funderupdate <lightning-funderupdate.7.md>
doc: document fundpsbt. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 15:09:47 +09:30
lightning-fundpsbt <lightning-fundpsbt.7.md>
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 15:59:24 +02:00
lightning-getinfo <lightning-getinfo.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
lightning-getlog <lightning-getlog.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-getroute <lightning-getroute.7.md>
lightningd/hsm_control.c: Implement `getsharedsecret`. ChangeLog-Added: New `getsharedsecret` command, which lets you compute a shared secret with this node knowing only a public point. This implements the BOLT standard of hashing the ECDH point, and is incompatible with ECIES.
2020-02-04 13:53:17 +08:00
lightning-getsharedsecret <lightning-getsharedsecret.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
lightning-help <lightning-help.7.md>
Makefile: Install `tools/hsmtool` as `lightning-hsmtool`. Changelog-Added: We now install `lightning-hsmtool` for your `hsm_secret` needs. See: https://github.com/ElementsProject/lightning/issues/3717#issuecomment-644844594 It seems reasonable to add this to the standard install, and to document it properly as well, hopefully we can fill in the documentation better later on.
2020-06-29 14:28:46 +08:00
lightning-hsmtool <lightning-hsmtool.8.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-invoice <lightning-invoice.7.md>
doc: Add a man-page for the new keysend command
2020-07-01 13:35:58 +02:00
lightning-keysend <lightning-keysend.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-listchannels <lightning-listchannels.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
lightning-listconfigs <lightning-listconfigs.7.md>
JSON-RPC: add interfaces to access datastore. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `datastore`, `deldatastore` and `listdatastore` for plugins to store simple persistent key/value data.
2021-08-25 12:20:12 +09:30
lightning-listdatastore <lightning-listdatastore.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-listforwards <lightning-listforwards.7.md>
lightning-listfunds <lightning-listfunds.7.md>
lightning-listinvoices <lightning-listinvoices.7.md>
added documentation of commands listnodes, sendpsbt Some grammar mistake was fixed as suggest and more command docs were added. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-13 18:19:35 +02:00
lightning-listnodes <lightning-listnodes.7.md>
doc: add disableoffer and listoffers manpages. I noticed that offer(7) referred to `deloffer` which doesn't exist. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-02-18 10:26:19 +10:30
lightning-listoffers <lightning-listoffers.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-listpays <lightning-listpays.7.md>
lightning-listpeers <lightning-listpeers.7.md>
lightning-listsendpays <lightning-listsendpays.7.md>
added documentation of command listtransactions Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-13 14:37:16 +02:00
lightning-listtransactions <lightning-listtransactions.7.md>
doc/, contrib/: Additional support etc. for multifundchannel.
2020-09-09 12:41:37 +09:30
lightning-multifundchannel <lightning-multifundchannel.7.md>
plugins/spender/multiwithdraw.c: Implement multiwithdraw command. Fixes: #2679 Changelog-Added: JSON-RPC: New `multiwithdraw` command to batch multiple onchain sends in a single transaction. Note it shuffles inputs and outputs, does not use BIP69.
2020-09-09 19:56:14 +09:30
lightning-multiwithdraw <lightning-multiwithdraw.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-newaddr <lightning-newaddr.7.md>
JSON-RPC: notifications command. This lets callers enable notifications; we won't send any if they don't. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `notifications` command to enable notifications.
2020-10-12 16:03:50 +10:30
lightning-notifications <lightning-notifications.7.md>
doc: document experimental commands. Not the low-level ones, just enough that people can play with the APIs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-08 05:15:47 +10:30
lightning-offer <lightning-offer.7.md>
offers: split offer send_invoice generation into new JSON command We split `send_invoice` offers inoo offerout (for want of a better name). This simplifies the API. Also took the opportunity to move the `vendor` tag to immediately follow `description` (our tests use arguments by keywords, so no change there). Suggested-by: shesek Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-08 05:16:47 +10:30
lightning-offerout <lightning-offerout.7.md>
df: add openchannel_abort command Allows us to clean up an in-progress open that we won't be completing Changelog-Added: EXPERIMENTAL JSON-RPC: Permit user-initiated aborting of in-progress opens. Only valid for not-yet-committed opens and RBF-attempts
2021-03-09 15:14:08 -06:00
lightning-openchannel_abort <lightning-openchannel_abort.7.md>
df-doc: add docs for openchannel_bump, more checks for valid psbt Add docs for openchannel_bump, plus some checks that were missed for verifying the amount is valid.
2021-03-10 22:33:47 -06:00
lightning-openchannel_bump <lightning-openchannel_bump.7.md>
dualfund: opener, openchannel_init command (1/3) There are 3 commands for opening a channel with dualfunding. `openchannel_init` is the first of these. It initializes the open-channel dialog, and stops once we've run out of updates (input/outputs) to send to the peer.
2020-09-03 13:01:45 -05:00
lightning-openchannel_init <lightning-openchannel_init.7.md>
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 14:43:40 -05:00
lightning-openchannel_signed <lightning-openchannel_signed.7.md>
lightning-openchannel_update <lightning-openchannel_update.7.md>
chaintopology: new command 'parsefeerate' Useful for parsing a passed in feerate before calling lightningd with it, e.g. when you need to know what the feerate is for a fundpsbt before calling fundpsbt Changelog-Added: JSON-RPC: new command `parsefeerate` which takes a feerate string and returns the calculated perkw/perkb
2021-06-23 14:31:47 -05:00
lightning-parsefeerate <lightning-parsefeerate.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-pay <lightning-pay.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
lightning-ping <lightning-ping.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-plugin <lightning-plugin.7.md>
add manpages for reserve/unreserve
2020-06-09 19:20:18 -05:00
lightning-reserveinputs <lightning-reserveinputs.7.md>
sendcustommsg: promote to non-dev Enable non-dev builds to send custom messages. Preserves 'dev-' for compat-enabled builds. Changelog-Changed: JSON-RPC: moved dev-sendcustommsg to sendcustommsg
2021-07-13 16:04:30 -05:00
lightning-sendcustommsg <lightning-sendcustommsg.7.md>
doc: document experimental commands. Not the low-level ones, just enough that people can play with the APIs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-08 05:15:47 +10:30
lightning-sendinvoice <lightning-sendinvoice.7.md>
doc: Add manpages for `createonion` and `sendonion` Changelog-Added: Added `createonion` and `sendonion` JSON-RPC methods allowing the implementation of custom protocol extensions that are not directly implemented in c-lightning itself.
2019-11-14 17:51:28 +01:00
lightning-sendonion <lightning-sendonion.7.md>
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 14:06:49 +10:30
lightning-sendonionmessage <lightning-sendonionmessage.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-sendpay <lightning-sendpay.7.md>
added documentation of commands listnodes, sendpsbt Some grammar mistake was fixed as suggest and more command docs were added. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-13 18:19:35 +02:00
lightning-sendpsbt <lightning-sendpsbt.7.md>
lightningd: new setchannel command. Based on setchannelfee, but expanded to allow setting max htlc amount (and others in future?). The main differences: 1. It doesn't change values which are not specified (that would be hard to add fields to!) 2. It says exactly what all values are in any potentially changed channels. Changelog-Added: JSON-RPC: new `setchannel` command generalizes `setchannelfee`. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-03-21 11:28:28 +10:30
lightning-setchannel <lightning-setchannel.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-setchannelfee <lightning-setchannelfee.7.md>
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 15:49:37 +10:30
lightning-signmessage <lightning-signmessage.7.md>
added sendpsbt documentation Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-16 15:06:01 +02:00
lightning-signpsbt <lightning-signpsbt.7.md>
added documentation of command stop Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-16 15:14:52 +02:00
lightning-stop <lightning-stop.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-txdiscard <lightning-txdiscard.7.md>
lightning-txprepare <lightning-txprepare.7.md>
lightning-txsend <lightning-txsend.7.md>
add manpages for reserve/unreserve
2020-06-09 19:20:18 -05:00
lightning-unreserveinputs <lightning-unreserveinputs.7.md>
utxopsbt: new command to create PSBT from given utxos. It's *possible* to do this using various RPC calls, but it's unfriendly: 1. Call getinfo to get the current block height. 2. Call listfunds to map the UTXOs. 3. Create the PSBT and hope you get all the fields correct. Instead, this presents an interface just like `fundpsbt`, with identical returns. I think it's different enough to justify a new command (though it shares much internally, of course). In particular, it's now quite simple to create a command which uses specified utxos, and then adds more to meet any shortfall. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-18 11:52:53 +09:30
lightning-utxopsbt <lightning-utxopsbt.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-waitanyinvoice <lightning-waitanyinvoice.7.md>
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 10:19:09 +00:00
lightning-waitblockheight <lightning-waitblockheight.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
2019-08-29 00:36:00 +02:00
lightning-waitinvoice <lightning-waitinvoice.7.md>
lightning-waitsendpay <lightning-waitsendpay.7.md>
lightning-withdraw <lightning-withdraw.7.md>
build: fix and simplify doc/index.rst generation * Fix usage of `echo "...\n..."` (without `-e`), generating a broken output: ``` lightningd-config <lightningd-config.5.md> lightningd\nlightning-autocleaninvoice.7.md <lightningd.8.md\nlightning-autocleaninvoice.7.md> ``` * Use `$(SORT)` instead of bare `sort` to avoid locale-dependent sort. * Strip the trailing .[0-9].md without invoking sed. * Sort all man pages as one block. Changelog-None
2020-01-31 11:28:10 +01:00
lightningd <lightningd.8.md>
lightningd-config <lightningd-config.5.md>
Reference in a new issue Copy permalink