lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
9205 Commits
55 Branches
107 Tags
38 MiB
Tree: d47992a46d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd47992a46d'
${ noResults }
lightning/doc/index.rst

105 lines
4.2 KiB
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>
6 years ago
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>
5 years ago
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.
4 years ago
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 &lt;decker.christian@gmail.com&gt;
6 years ago
.. 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
5 years ago
.. toctree::
:maxdepth: 1
:caption: Manpages
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-autocleaninvoice <lightning-autocleaninvoice.7.md>
lightning-check <lightning-check.7.md>
doc: man pages for checkmessage and signmessage. They&#39;re a little subtle, so let&#39;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 &lt;rusty@rustcorp.com.au&gt;
5 years ago
lightning-checkmessage <lightning-checkmessage.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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 &lt;rusty@rustcorp.com.au&gt;
4 years ago
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.
5 years ago
lightning-createonion <lightning-createonion.7.md>
decode: new generic API to decode bolt11 and bolt12. This is experimental for now, but can eventually deprecated &#39;decodepay&#39; and even decode other kinds of messages. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
4 years ago
lightning-decode <lightning-decode.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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 &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-delpay <lightning-delpay.7.md>
docs: Add manpage for dev-sendcustommsg It&#39;s a dev-* command for now, but better document it so people can use it rather than having them guess how it&#39;s supposed to work.
5 years ago
lightning-dev-sendcustommsg <lightning-dev-sendcustommsg.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-disconnect <lightning-disconnect.7.md>
doc: update since addition of feerate(7) Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
5 years ago
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 &lt;rusty@rustcorp.com.au&gt;
4 years ago
lightning-fetchinvoice <lightning-fetchinvoice.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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 &lt;rusty@rustcorp.com.au&gt;
5 years ago
lightning-fundpsbt <lightning-fundpsbt.7.md>
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-getinfo <lightning-getinfo.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-getlog <lightning-getlog.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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.
5 years ago
lightning-getsharedsecret <lightning-getsharedsecret.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
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.
5 years ago
lightning-hsmtool <lightning-hsmtool.8.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-invoice <lightning-invoice.7.md>
doc: Add a man-page for the new keysend command
5 years ago
lightning-keysend <lightning-keysend.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-listchannels <lightning-listchannels.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-listconfigs <lightning-listconfigs.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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 &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-listnodes <lightning-listnodes.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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 &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-listtransactions <lightning-listtransactions.7.md>
doc/, contrib/: Additional support etc. for multifundchannel.
4 years ago
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.
4 years ago
lightning-multiwithdraw <lightning-multiwithdraw.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-newaddr <lightning-newaddr.7.md>
JSON-RPC: notifications command. This lets callers enable notifications; we won&#39;t send any if they don&#39;t. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt; Changelog-Added: JSON-RPC: `notifications` command to enable notifications.
4 years ago
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 &lt;rusty@rustcorp.com.au&gt;
4 years ago
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 &lt;rusty@rustcorp.com.au&gt;
4 years ago
lightning-offerout <lightning-offerout.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&#39;ve run out of updates (input/outputs) to send to the peer.
4 years ago
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`.
4 years ago
lightning-openchannel_signed <lightning-openchannel_signed.7.md>
lightning-openchannel_update <lightning-openchannel_update.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-pay <lightning-pay.7.md>
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-ping <lightning-ping.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-plugin <lightning-plugin.7.md>
add manpages for reserve/unreserve
5 years ago
lightning-reserveinputs <lightning-reserveinputs.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 &lt;rusty@rustcorp.com.au&gt;
4 years ago
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.
5 years ago
lightning-sendonion <lightning-sendonion.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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 &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-sendpsbt <lightning-sendpsbt.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-setchannelfee <lightning-setchannelfee.7.md>
doc: man pages for checkmessage and signmessage. They&#39;re a little subtle, so let&#39;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 &lt;rusty@rustcorp.com.au&gt;
5 years ago
lightning-signmessage <lightning-signmessage.7.md>
added sendpsbt documentation Signed-off-by: Vincenzo Palazzo &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-signpsbt <lightning-signpsbt.7.md>
added documentation of command stop Signed-off-by: Vincenzo Palazzo &lt;vincenzopalazzodev@gmail.com&gt;
4 years ago
lightning-stop <lightning-stop.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
lightning-txdiscard <lightning-txdiscard.7.md>
lightning-txprepare <lightning-txprepare.7.md>
lightning-txsend <lightning-txsend.7.md>
add manpages for reserve/unreserve
5 years ago
lightning-unreserveinputs <lightning-unreserveinputs.7.md>
utxopsbt: new command to create PSBT from given utxos. It&#39;s *possible* to do this using various RPC calls, but it&#39;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&#39;s different enough to justify a new command (though it shares much internally, of course). In particular, it&#39;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 &lt;rusty@rustcorp.com.au&gt;
4 years ago
lightning-utxopsbt <lightning-utxopsbt.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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.
5 years ago
lightning-waitblockheight <lightning-waitblockheight.7.md>
docs: Add the title of the manpage to TOC and sort alphabetically Fixes #2987
5 years ago
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 &#34;...\n...&#34;` (without `-e`), generating a broken output: ``` lightningd-config &lt;lightningd-config.5.md&gt; lightningd\nlightning-autocleaninvoice.7.md &lt;lightningd.8.md\nlightning-autocleaninvoice.7.md&gt; ``` * 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
5 years ago
lightningd <lightningd.8.md>
lightningd-config <lightningd-config.5.md>