mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
2618ef10c3
core-lightning/doc/index.rst

94 lines
3.6 KiB
ReStructuredText
Raw Normal View History

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
c-lightning Documentation
=========================
.. 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>
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: 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 07:19:37 +02:00
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>
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>
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>
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>
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 16:32:49 +01:00
lightning-dev-sendcustommsg <lightning-dev-sendcustommsg.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 04:18:38 +02:00
lightning-feerates <lightning-feerates.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>
doc: document fundpsbt. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 07:39:47 +02:00
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 06:53:17 +01: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 08:28:46 +02: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>
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>
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 05:11:37 +02:00
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 12:26:14 +02:00
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>
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-10 02:20:18 +02:00
lightning-reserveinputs <lightning-reserveinputs.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>
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>
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 07:19:37 +02:00
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-10 02:20:18 +02: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 04:22:53 +02:00
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 11:19:09 +01: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 New Issue Copy Permalink