aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-01-05 15:24:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
178e0b64636f18fc939f65aa3f28df62368ab69f
lightning/doc
History
Christian Decker 178e0b6463 docs: Structure the files in mkdocs 
We have 3 personas:

 - Users
 - Developers
 - Maintainers

The first one basically cover the installation documentation. The
latter two are sorted into the "Developer" category, and the reference
category serves as a quick lookup for facts on anything CLN related.
2023-03-25 15:40:35 +10:30
..
dev
docs: Structure the files in mkdocs
2023-03-25 15:40:35 +10:30
reference
docs: Structure the files in mkdocs
2023-03-25 15:40:35 +10:30
release-notes
doc: Fixed typo in the release notes
2018-06-18 12:45:00 +02:00
schemas
lightningd: add listclosedchannels command.
2023-03-25 15:28:02 +10:30
user
docs: Structure the files in mkdocs
2023-03-25 15:40:35 +10:30
.gitignore
doc: document the sql command.
2023-01-30 15:15:41 -06:00
BACKUP.md
doc: remove sections on litestream, .dump and vacuum into
2023-01-31 10:19:45 +10:30
bitcoin.bib
bitcoin.bib: Add Satoshi paper URL and date
2018-03-04 03:22:32 +01:00
CHANGELOG.md
docs: Add configuration for the sphinx documentation generator
2019-02-18 02:42:29 +00:00
commit-tx.eps
Add documentation.
2015-07-18 10:46:53 +09:30
commit-tx.svg
Add documentation.
2015-07-18 10:46:53 +09:30
conf.py
doc: sphinx-build fix external links (urls), language warning and broken footnote
2022-12-19 19:00:39 +01:00
deployable-lightning.lyx
udpate broken link
2018-06-08 17:56:48 +02:00
deployable-lightning.pdf
Regenerate PDF.
2015-11-20 06:45:19 +10:30
dual-anchor-diag1.eps
Add documentation.
2015-07-18 10:46:53 +09:30
dual-anchor-diag1.svg
Add documentation.
2015-07-18 10:46:53 +09:30
dual-anchor-diag2.eps
Add documentation.
2015-07-18 10:46:53 +09:30
dual-anchor-diag2.svg
Add documentation.
2015-07-18 10:46:53 +09:30
dual-anchor-diag3.eps
Add documentation.
2015-07-18 10:46:53 +09:30
dual-anchor-diag3.svg
Add documentation.
2015-07-18 10:46:53 +09:30
dual-anchor-diag4.eps
doc: fix flaw in escape transactions.
2015-07-20 14:07:25 +09:30
dual-anchor-diag4.svg
doc: fix flaw in escape transactions.
2015-07-20 14:07:25 +09:30
dual-anchor-final.eps
doc: fix flaw in escape transactions.
2015-07-20 14:07:25 +09:30
dual-anchor-final.svg
doc: fix flaw in escape transactions.
2015-07-20 14:07:25 +09:30
dual-anchor-take2.svg
Add documentation.
2015-07-18 10:46:53 +09:30
dual-anchor.svg
Add documentation.
2015-07-18 10:46:53 +09:30
FAQ.md
doc: announce-addr-discovered config switch
2023-01-25 14:37:56 +01:00
FUZZING.md
doc: sphinx-build fix external links (urls), language warning and broken footnote
2022-12-19 19:00:39 +01:00
GOSSIP_STORE.md
doc/GOSSIP_STORE.md: document the gossip_store file format.
2022-09-24 15:22:27 +09:30
HACKING.md
doc: update references to old BOLTs repo.
2022-09-29 16:10:57 +09:30
htlc.eps
Add documentation.
2015-07-18 10:46:53 +09:30
htlc.svg
Add documentation.
2015-07-18 10:46:53 +09:30
index.md
docs: Structure the files in mkdocs
2023-03-25 15:40:35 +10:30
index.rst
lightningd: add listclosedchannels command.
2023-03-25 15:28:02 +10:30
INSTALL.md
Need sudo for make install
2023-02-05 15:41:19 +10:30
lightning-addgossip.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-autoclean-once.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-autoclean-status.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-batching.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-bkpr-channelsapy.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-bkpr-dumpincomecsv.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-bkpr-inspect.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-bkpr-listaccountevents.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-bkpr-listbalances.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-bkpr-listincome.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-check.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-checkmessage.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-cli.1.md
cli: add -c/--commando support.
2023-01-11 11:13:27 +10:30
lightning-close.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-commando-rune.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-commando.7.md
doc: escape more naughty underscores
2022-12-12 15:34:00 +10:30
lightning-connect.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-createinvoice.7.md
doc: Correct createinvoice's invstring description
2023-02-06 15:54:32 -06:00
lightning-createonion.7.md
doc/schemas: remove unnecessary length restrictions.
2023-01-30 15:15:41 -06:00
lightning-datastore.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-decode.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-decodepay.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-deldatastore.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-delexpiredinvoice.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-delforward.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-delinvoice.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-delpay.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-disableinvoicerequest.7.md
doc: add documentation for invoicerequest commands.
2023-03-09 06:56:06 -06:00
lightning-disableoffer.7.md
doc: use specific types in schema rather than "hex".
2023-01-30 15:15:41 -06:00
lightning-disconnect.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-emergencyrecover.7.md
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-07-14 12:24:48 -05:00
lightning-feerates.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-fetchinvoice.7.md
doc: update documentation for fetchinvoice(7) and offer(7).
2023-03-09 06:56:06 -06:00
lightning-fundchannel_cancel.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-fundchannel_complete.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-fundchannel_start.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-fundchannel.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-funderupdate.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-fundpsbt.7.md
fundpsbt: add option to filter out wrapped p2sh inputs
2023-02-04 15:31:16 +10:30
lightning-getinfo.7.md
global: remove deprecated non-msat-named msat fields.
2023-03-18 15:55:49 +10:30
lightning-getlog.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-getroute.7.md
global: remove deprecated non-msat-named msat fields.
2023-03-18 15:55:49 +10:30
lightning-help.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-hsmtool.8.md
doc: drive-by spelling corrections
2022-12-12 15:34:00 +10:30
lightning-invoice.7.md
doc/schemas: remove unnecessary length restrictions.
2023-01-30 15:15:41 -06:00
lightning-invoicerequest.7.md
doc: add documentation for invoicerequest commands.
2023-03-09 06:56:06 -06:00
lightning-keysend.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-listchannels.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-listclosedchannels.7.md
lightningd: add listclosedchannels command.
2023-03-25 15:28:02 +10:30
lightning-listconfigs.7.md
options: create enable/disable option for peer storage.
2023-02-08 08:37:59 -06:00
lightning-listdatastore.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-listforwards.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-listfunds.7.md
Output channel_id in listfunds
2023-03-21 10:29:33 +00:00
lightning-listhtlcs.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-listinvoicerequests.7.md
doc: add documentation for invoicerequest commands.
2023-03-09 06:56:06 -06:00
lightning-listinvoices.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-listnodes.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-listoffers.7.md
doc: use specific types in schema rather than "hex".
2023-01-30 15:15:41 -06:00
lightning-listpays.7.md
doc: use specific types in schema rather than "hex".
2023-01-30 15:15:41 -06:00
lightning-listpeerchannels.7.md
listpeerchannels: add channel_type, both in hex and as array of names.
2023-03-25 15:28:02 +10:30
lightning-listpeers.7.md
lightningd: remove deprecated local_msat, remote_msat from listpeers.
2023-03-18 15:55:49 +10:30
lightning-listsendpays.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-listsqlschemas.7.md
typo fixes found by @niftynei
2023-01-30 15:15:41 -06:00
lightning-listtransactions.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-makesecret.7.md
doc/schemas: remove unnecessary length restrictions.
2023-01-30 15:15:41 -06:00
lightning-multifundchannel.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-multiwithdraw.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-newaddr.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-notifications.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-offer.7.md
doc: update documentation for fetchinvoice(7) and offer(7).
2023-03-09 06:56:06 -06:00
lightning-openchannel_abort.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-openchannel_bump.7.md
df: wire up peer's "require-confirmed-inputs"
2023-02-07 21:03:36 -06:00
lightning-openchannel_init.7.md
df: wire up peer's "require-confirmed-inputs"
2023-02-07 21:03:36 -06:00
lightning-openchannel_signed.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-openchannel_update.7.md
df: wire up peer's "require-confirmed-inputs"
2023-02-07 21:03:36 -06:00
lightning-parsefeerate.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-pay.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-ping.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-plugin.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-preapproveinvoice.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-preapprovekeysend.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-recoverchannel.7.md
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-07-14 12:24:48 -05:00
lightning-reserveinputs.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-sendcustommsg.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-sendinvoice.7.md
doc: fix modern usage of sendinvoice (changed in v22.11)
2023-03-09 06:56:06 -06:00
lightning-sendonion.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-sendonionmessage.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-sendpay.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-sendpsbt.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-setchannel.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-setpsbtversion.7.md
Add PSBT version setting RPC to aid with debugging and compatibility
2023-03-23 16:10:55 +10:30
lightning-signinvoice.7.md
lightningd: Add signinvoice to sign a BOLT11 invoice.
2023-02-06 15:54:32 -06:00
lightning-signmessage.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-signpsbt.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-sql.7.md
plugins/sql: add listclosedchannels
2023-03-25 15:28:02 +10:30
lightning-staticbackup.7.md
doc: Typo
2022-08-19 10:27:09 -04:00
lightning-stop.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-txdiscard.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-txprepare.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-txsend.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-unreserveinputs.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-upgradewallet.7.md
upgradewallet: JSONRPC call to update p2sh outputs to a native segwit
2023-02-04 15:31:16 +10:30
lightning-utxopsbt.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-waitanyinvoice.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-waitblockheight.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightning-waitinvoice.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-waitsendpay.7.md
doc/schemas: fix old deprecations.
2023-01-30 15:15:41 -06:00
lightning-withdraw.7.md
tools/fromschema.py: don't try to handle more complex cases.
2023-01-30 15:15:41 -06:00
lightningd-config.5.md
options: create enable/disable option for peer storage.
2023-02-08 08:37:59 -06:00
lightningd-rpc.7.md
doc: escape more naughty underscores
2022-12-12 15:34:00 +10:30
lightningd.8.md
doc: escape more naughty underscores
2022-12-12 15:34:00 +10:30
ln-draft-fig1.eps
doc: add figures from LN draft (thanks Joseph!).
2015-07-20 14:07:40 +09:30
ln-draft-fig2.eps
doc: add figures from LN draft (thanks Joseph!).
2015-07-20 14:07:40 +09:30
Makefile
lightningd: add listclosedchannels command.
2023-03-25 15:28:02 +10:30
MAKING-RELEASES.md
doc: update release procedure
2023-03-17 14:26:56 +10:30
PLUGINS.md
df: wire up peer's "require-confirmed-inputs"
2023-02-07 21:03:36 -06:00
reckless.7.md
doc: escape more naughty underscores
2022-12-12 15:34:00 +10:30
REPRODUCIBLE.md
doc: update release procedure
2023-03-17 14:26:56 +10:30
requirements.txt
docs: Switch to mkdocs for documentation
2023-03-25 15:40:35 +10:30
STYLE.md
Changelog-None
2022-08-22 11:21:19 -04:00
TOR.md
doc: announce-addr-discovered config switch
2023-01-25 14:37:56 +01:00
undoc-flags.json
lightningd: allow extra tlv types in non-experimental mode.
2022-09-22 17:19:11 +09:30