From 909163b2607165e886df938b56d1728e9518843b Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Mon, 18 Sep 2023 15:09:44 +0200 Subject: [PATCH] doc: update after adding signet --- doc/chantools.md | 1 + doc/chantools_chanbackup.md | 1 + doc/chantools_closepoolaccount.md | 1 + doc/chantools_compactdb.md | 1 + doc/chantools_deletepayments.md | 1 + doc/chantools_derivekey.md | 1 + doc/chantools_doublespendinputs.md | 1 + doc/chantools_dropchannelgraph.md | 1 + doc/chantools_dumpbackup.md | 1 + doc/chantools_dumpchannels.md | 1 + doc/chantools_fakechanbackup.md | 1 + doc/chantools_filterbackup.md | 1 + doc/chantools_fixoldbackup.md | 1 + doc/chantools_forceclose.md | 1 + doc/chantools_genimportscript.md | 1 + doc/chantools_migratedb.md | 1 + doc/chantools_recoverloopin.md | 1 + doc/chantools_removechannel.md | 1 + doc/chantools_rescueclosed.md | 1 + doc/chantools_rescuefunding.md | 1 + doc/chantools_rescuetweakedkey.md | 1 + doc/chantools_showrootkey.md | 1 + doc/chantools_signrescuefunding.md | 1 + doc/chantools_summary.md | 1 + doc/chantools_sweepremoteclosed.md | 1 + doc/chantools_sweeptimelock.md | 1 + doc/chantools_sweeptimelockmanual.md | 1 + doc/chantools_triggerforceclose.md | 1 + doc/chantools_vanitygen.md | 1 + doc/chantools_walletinfo.md | 1 + doc/chantools_zombierecovery.md | 1 + doc/chantools_zombierecovery_findmatches.md | 1 + doc/chantools_zombierecovery_makeoffer.md | 1 + doc/chantools_zombierecovery_preparekeys.md | 1 + doc/chantools_zombierecovery_signoffer.md | 1 + 35 files changed, 35 insertions(+) diff --git a/doc/chantools.md b/doc/chantools.md index c3cc344..9b5386b 100644 --- a/doc/chantools.md +++ b/doc/chantools.md @@ -13,6 +13,7 @@ Complete documentation is available at https://github.com/lightninglabs/chantool ``` -h, --help help for chantools -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_chanbackup.md b/doc/chantools_chanbackup.md index 4626520..52c67ea 100644 --- a/doc/chantools_chanbackup.md +++ b/doc/chantools_chanbackup.md @@ -33,6 +33,7 @@ chantools chanbackup \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_closepoolaccount.md b/doc/chantools_closepoolaccount.md index 7cf05d2..f2f739a 100644 --- a/doc/chantools_closepoolaccount.md +++ b/doc/chantools_closepoolaccount.md @@ -48,6 +48,7 @@ chantools closepoolaccount \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_compactdb.md b/doc/chantools_compactdb.md index 21ebf17..0cb85ce 100644 --- a/doc/chantools_compactdb.md +++ b/doc/chantools_compactdb.md @@ -32,6 +32,7 @@ chantools compactdb \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_deletepayments.md b/doc/chantools_deletepayments.md index 2b4f357..e44e416 100644 --- a/doc/chantools_deletepayments.md +++ b/doc/chantools_deletepayments.md @@ -35,6 +35,7 @@ chantools deletepayments --failedonly \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_derivekey.md b/doc/chantools_derivekey.md index d14279f..13d4974 100644 --- a/doc/chantools_derivekey.md +++ b/doc/chantools_derivekey.md @@ -35,6 +35,7 @@ chantools derivekey --identity ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_doublespendinputs.md b/doc/chantools_doublespendinputs.md index 9239688..79d1602 100644 --- a/doc/chantools_doublespendinputs.md +++ b/doc/chantools_doublespendinputs.md @@ -34,6 +34,7 @@ chantools doublespendinputs \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_dropchannelgraph.md b/doc/chantools_dropchannelgraph.md index e97171a..5c27319 100644 --- a/doc/chantools_dropchannelgraph.md +++ b/doc/chantools_dropchannelgraph.md @@ -45,6 +45,7 @@ chantools dropchannelgraph \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_dumpbackup.md b/doc/chantools_dumpbackup.md index 3e74c76..bf6856d 100644 --- a/doc/chantools_dumpbackup.md +++ b/doc/chantools_dumpbackup.md @@ -31,6 +31,7 @@ chantools dumpbackup \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_dumpchannels.md b/doc/chantools_dumpchannels.md index 859be84..aefe172 100644 --- a/doc/chantools_dumpchannels.md +++ b/doc/chantools_dumpchannels.md @@ -32,6 +32,7 @@ chantools dumpchannels \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_fakechanbackup.md b/doc/chantools_fakechanbackup.md index cc0b262..bf641d0 100644 --- a/doc/chantools_fakechanbackup.md +++ b/doc/chantools_fakechanbackup.md @@ -71,6 +71,7 @@ chantools fakechanbackup --from_channel_graph lncli_describegraph.json \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_filterbackup.md b/doc/chantools_filterbackup.md index c00875f..9f03187 100644 --- a/doc/chantools_filterbackup.md +++ b/doc/chantools_filterbackup.md @@ -33,6 +33,7 @@ chantools filterbackup \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_fixoldbackup.md b/doc/chantools_fixoldbackup.md index 90e1f2f..f0523ba 100644 --- a/doc/chantools_fixoldbackup.md +++ b/doc/chantools_fixoldbackup.md @@ -34,6 +34,7 @@ chantools fixoldbackup \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_forceclose.md b/doc/chantools_forceclose.md index 3cc9b28..41b0b7d 100644 --- a/doc/chantools_forceclose.md +++ b/doc/chantools_forceclose.md @@ -49,6 +49,7 @@ chantools forceclose \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_genimportscript.md b/doc/chantools_genimportscript.md index 1ba5ea4..5249b34 100644 --- a/doc/chantools_genimportscript.md +++ b/doc/chantools_genimportscript.md @@ -57,6 +57,7 @@ chantools genimportscript --format bitcoin-cli \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_migratedb.md b/doc/chantools_migratedb.md index 16effd9..5bf8ba8 100644 --- a/doc/chantools_migratedb.md +++ b/doc/chantools_migratedb.md @@ -35,6 +35,7 @@ chantools migratedb \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_recoverloopin.md b/doc/chantools_recoverloopin.md index fff8177..307e555 100644 --- a/doc/chantools_recoverloopin.md +++ b/doc/chantools_recoverloopin.md @@ -40,6 +40,7 @@ chantools recoverloopin \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_removechannel.md b/doc/chantools_removechannel.md index 43c331b..e299ae7 100644 --- a/doc/chantools_removechannel.md +++ b/doc/chantools_removechannel.md @@ -37,6 +37,7 @@ chantools removechannel \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_rescueclosed.md b/doc/chantools_rescueclosed.md index 27f3b25..c091366 100644 --- a/doc/chantools_rescueclosed.md +++ b/doc/chantools_rescueclosed.md @@ -62,6 +62,7 @@ chantools rescueclosed --fromsummary results/summary-xxxxxx.json \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_rescuefunding.md b/doc/chantools_rescuefunding.md index 69093fb..3cde047 100644 --- a/doc/chantools_rescuefunding.md +++ b/doc/chantools_rescuefunding.md @@ -56,6 +56,7 @@ chantools rescuefunding \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_rescuetweakedkey.md b/doc/chantools_rescuetweakedkey.md index b80f4cd..7e16367 100644 --- a/doc/chantools_rescuetweakedkey.md +++ b/doc/chantools_rescuetweakedkey.md @@ -35,6 +35,7 @@ chantools rescuetweakedkey \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_showrootkey.md b/doc/chantools_showrootkey.md index b4be2ac..0fd8e76 100644 --- a/doc/chantools_showrootkey.md +++ b/doc/chantools_showrootkey.md @@ -30,6 +30,7 @@ chantools showrootkey ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_signrescuefunding.md b/doc/chantools_signrescuefunding.md index 0e18668..7f46d9e 100644 --- a/doc/chantools_signrescuefunding.md +++ b/doc/chantools_signrescuefunding.md @@ -36,6 +36,7 @@ chantools signrescuefunding \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_summary.md b/doc/chantools_summary.md index 68e95f5..b0d47e0 100644 --- a/doc/chantools_summary.md +++ b/doc/chantools_summary.md @@ -34,6 +34,7 @@ chantools summary --fromchanneldb ~/.lnd/data/graph/mainnet/channel.db ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_sweepremoteclosed.md b/doc/chantools_sweepremoteclosed.md index 02163b1..943fe03 100644 --- a/doc/chantools_sweepremoteclosed.md +++ b/doc/chantools_sweepremoteclosed.md @@ -46,6 +46,7 @@ chantools sweepremoteclosed \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_sweeptimelock.md b/doc/chantools_sweeptimelock.md index 0c8b429..06e3708 100644 --- a/doc/chantools_sweeptimelock.md +++ b/doc/chantools_sweeptimelock.md @@ -47,6 +47,7 @@ chantools sweeptimelock \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_sweeptimelockmanual.md b/doc/chantools_sweeptimelockmanual.md index cce3187..aae01be 100644 --- a/doc/chantools_sweeptimelockmanual.md +++ b/doc/chantools_sweeptimelockmanual.md @@ -56,6 +56,7 @@ chantools sweeptimelockmanual \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_triggerforceclose.md b/doc/chantools_triggerforceclose.md index 0575d2b..6903a8a 100644 --- a/doc/chantools_triggerforceclose.md +++ b/doc/chantools_triggerforceclose.md @@ -37,6 +37,7 @@ chantools triggerforceclose \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_vanitygen.md b/doc/chantools_vanitygen.md index 41b7441..59dd0b3 100644 --- a/doc/chantools_vanitygen.md +++ b/doc/chantools_vanitygen.md @@ -42,6 +42,7 @@ chantools vanitygen --prefix 022222 --threads 8 ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_walletinfo.md b/doc/chantools_walletinfo.md index 456873e..4c7e134 100644 --- a/doc/chantools_walletinfo.md +++ b/doc/chantools_walletinfo.md @@ -39,6 +39,7 @@ chantools walletinfo --withrootkey \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_zombierecovery.md b/doc/chantools_zombierecovery.md index 90b4a15..3fc6acf 100644 --- a/doc/chantools_zombierecovery.md +++ b/doc/chantools_zombierecovery.md @@ -24,6 +24,7 @@ chantools zombierecovery [flags] ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_zombierecovery_findmatches.md b/doc/chantools_zombierecovery_findmatches.md index f83718e..57e0597 100644 --- a/doc/chantools_zombierecovery_findmatches.md +++ b/doc/chantools_zombierecovery_findmatches.md @@ -37,6 +37,7 @@ chantools zombierecovery findmatches \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_zombierecovery_makeoffer.md b/doc/chantools_zombierecovery_makeoffer.md index 3a3db26..3a2c99d 100644 --- a/doc/chantools_zombierecovery_makeoffer.md +++ b/doc/chantools_zombierecovery_makeoffer.md @@ -40,6 +40,7 @@ chantools zombierecovery makeoffer \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_zombierecovery_preparekeys.md b/doc/chantools_zombierecovery_preparekeys.md index 608f110..96ee567 100644 --- a/doc/chantools_zombierecovery_preparekeys.md +++ b/doc/chantools_zombierecovery_preparekeys.md @@ -36,6 +36,7 @@ chantools zombierecovery preparekeys \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ``` diff --git a/doc/chantools_zombierecovery_signoffer.md b/doc/chantools_zombierecovery_signoffer.md index b91623c..309ebd7 100644 --- a/doc/chantools_zombierecovery_signoffer.md +++ b/doc/chantools_zombierecovery_signoffer.md @@ -31,6 +31,7 @@ chantools zombierecovery signoffer \ ``` -r, --regtest Indicates if regtest parameters should be used + -s, --signet Indicates if the public signet parameters should be used -t, --testnet Indicates if testnet parameters should be used ```