From ab56dcf34e2864828a4aca897bb68f28a8d0e82a Mon Sep 17 00:00:00 2001 From: UdjinM6 Date: Tue, 7 Nov 2023 17:04:39 +0300 Subject: [PATCH] docs: update man pages (#5672) ## Issue being fixed or feature implemented ## What was done? `./contrib/devtools/gen-manpages.sh` and drop `rc2` and `dirty` suffixes ## How Has This Been Tested? n/a ## Breaking Changes n/a ## Checklist: - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added or updated relevant unit/integration/functional/e2e tests - [ ] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ --- doc/man/dash-cli.1 | 56 ++++++++----- doc/man/dash-qt.1 | 170 +++++++++++++++++++++++++-------------- doc/man/dash-tx.1 | 44 +++++----- doc/man/dash-wallet.1 | 51 +++++++----- doc/man/dashd.1 | 182 ++++++++++++++++++++++++++++-------------- 5 files changed, 319 insertions(+), 184 deletions(-) diff --git a/doc/man/dash-cli.1 b/doc/man/dash-cli.1 index c9fa2756f9687..88e9276608d58 100644 --- a/doc/man/dash-cli.1 +++ b/doc/man/dash-cli.1 @@ -1,7 +1,7 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH DASH-CLI "1" "June 2023" "dash-cli v19.2.0" "User Commands" +.TH DASH-CLI "1" "November 2023" "dash-cli v20.0.0" "User Commands" .SH NAME -dash-cli \- manual page for dash-cli v19.2.0 +dash-cli \- manual page for dash-cli v20.0.0 .SH SYNOPSIS .B dash-cli [\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] \fI\,Send command to Dash Core\/\fR @@ -15,7 +15,7 @@ dash-cli \- manual page for dash-cli v19.2.0 .B dash-cli [\fI\,options\/\fR] \fI\,help Get help for a command\/\fR .SH DESCRIPTION -Dash Core RPC client version v19.2.0 +Dash Core RPC client version v20.0.0 .SH OPTIONS .HP \-? @@ -31,6 +31,15 @@ location. (default: dash.conf) .IP Specify data directory .HP +\fB\-generate\fR +.IP +Generate blocks immediately, equivalent to RPC generatenewaddress +followed by RPC generatetoaddress. Optional positional integer +arguments are number of blocks to generate (default: 1) and +maximum iterations to try (default: 1000000), equivalent to RPC +generatetoaddress nblocks and maxtries arguments. Example: +dash\-cli \fB\-generate\fR 4 1000 +.HP \fB\-getinfo\fR .IP Get general information from the remote server. Note that unlike @@ -43,6 +52,13 @@ be as of a different block from the chain state reported) .IP Pass named instead of positional arguments (default: false) .HP +\fB\-netinfo\fR +.IP +Get network peer connection information from the remote server. An +optional integer argument from 0 to 4 can be passed for different +peers listings (default: 0). Pass "help" for detailed help +documentation. +.HP \fB\-rpcclienttimeout=\fR .IP Timeout in seconds during HTTP requests, or 0 for no timeout. (default: @@ -107,6 +123,11 @@ Print version and exit .PP Chain selection options: .HP +\fB\-chain=\fR +.IP +Use the chain (default: main). Allowed values: main, test, +regtest +.HP \fB\-devnet=\fR .IP Use devnet chain with provided name @@ -124,7 +145,8 @@ highsubsidyblocks window of a chain (default: 1, devnet\-only) \fB\-llmqchainlocks=\fR .IP Override the default LLMQ type used for ChainLocks. Allows using -ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet\-only) +ChainLocks with smaller LLMQs. (default: llmq_devnet, +devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP @@ -134,19 +156,24 @@ devnet\-only) \fB\-llmqinstantsend=\fR .IP Override the default LLMQ type used for InstantSend. Allows using -InstantSend with smaller LLMQs. (default: llmq_50_60, +InstantSend with smaller LLMQs. (default: llmq_devnet, devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP Override the default LLMQ type used for InstantSendDIP0024. (default: -llmq_60_75, devnet\-only) +llmq_devnet_dip0024, devnet\-only) .HP -\fB\-llmqplatform=\fR +\fB\-llmqmnhf=\fR .IP -Override the default LLMQ type used for Platform. (default: llmq_100_67, +Override the default LLMQ type used for EHF. (default: llmq_devnet, devnet\-only) .HP +\fB\-llmqplatform=\fR +.IP +Override the default LLMQ type used for Platform. (default: +llmq_devnet_platform, devnet\-only) +.HP \fB\-minimumdifficultyblocks=\fR .IP The number of blocks that can be mined with the minimum difficulty at @@ -159,15 +186,4 @@ minutes, devnet\-only) .HP \fB\-testnet\fR .IP -Use the test chain -.SH COPYRIGHT -Copyright (C) 2014-2023 The Dash Core developers -Copyright (C) 2009-2023 The Bitcoin Core developers - -Please contribute if you find Dash Core useful. Visit for -further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR diff --git a/doc/man/dash-qt.1 b/doc/man/dash-qt.1 index a4a36ade31779..0430d58e97679 100644 --- a/doc/man/dash-qt.1 +++ b/doc/man/dash-qt.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH DASH-QT "1" "June 2023" "dash-qt v19.2.0" "User Commands" +.TH DASH-QT "1" "November 2023" "dash-qt v20.0.0" "User Commands" .SH NAME -dash-qt \- manual page for dash-qt v19.2.0 +dash-qt \- manual page for dash-qt v20.0.0 .SH SYNOPSIS .B dash-qt [\fI\,command-line options\/\fR] .SH DESCRIPTION -Dash Core version v19.2.0 +Dash Core version v20.0.0 .SH OPTIONS .HP \-? @@ -55,6 +55,15 @@ and rebroadcast of any transactions from inbound peers is disabled, unless the peer has the 'forcerelay' permission. RPC transactions are not affected. (default: 0) .HP +\fB\-chainlocknotify=\fR +.IP +Execute command when the best chainlock changes (%s in cmd is replaced +by chainlocked block hash) +.HP +\fB\-coinstatsindex\fR +.IP +Maintain coinstats index used by the gettxoutset RPC (default: 0) +.HP \fB\-conf=\fR .IP Specify path to read\-only configuration file. Relative paths will be @@ -126,11 +135,12 @@ Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a target size in MiB is provided. This mode is -incompatible with \fB\-txindex\fR, \fB\-rescan\fR and \fB\-disablegovernance\fR=\fI\,false\/\fR. -Warning: Reverting this setting requires re\-downloading the -entire blockchain. (default: 0 = disable pruning blocks, 1 = -allow manual pruning via RPC, >945 = automatically prune block -files to stay under the specified target size in MiB) +incompatible with \fB\-txindex\fR, \fB\-coinstatsindex\fR, \fB\-rescan\fR and +\fB\-disablegovernance\fR=\fI\,false\/\fR. Warning: Reverting this setting +requires re\-downloading the entire blockchain. (default: 0 = +disable pruning blocks, 1 = allow manual pruning via RPC, >945 = +automatically prune block files to stay under the specified +target size in MiB) .HP \fB\-settings=\fR .IP @@ -181,10 +191,13 @@ Threshold for disconnecting and discouraging misbehaving peers (default: Default duration (in seconds) of manually configured bans (default: 86400) .HP -\fB\-bind=\fR +\fB\-bind=\fR[:][=onion] .IP -Bind to given address and always listen on it. Use [host]:port notation -for IPv6 +Bind to given address and always listen on it (default: 0.0.0.0). Use +[host]:port notation for IPv6. Append =onion to tag any incoming +connections to that address and port as incoming Tor connections +(default: 127.0.0.1:9996=onion, testnet: 127.0.0.1:19996=onion, +regtest: 127.0.0.1:19896=onion) .HP \fB\-connect=\fR .IP @@ -215,13 +228,27 @@ Specify your own public address .IP Always query for peer addresses via DNS lookup (default: 0) .HP +\fB\-i2pacceptincoming\fR +.IP +If set and \fB\-i2psam\fR is also set then incoming I2P connections are +accepted via the SAM proxy. If this is not set but \fB\-i2psam\fR is set +then only outgoing connections will be made to the I2P network. +Ignored if \fB\-i2psam\fR is not set. Listening for incoming I2P +connections is done through the SAM proxy, not by binding to a +local address and port (default: 1) +.HP +\fB\-i2psam=\fR +.IP +I2P SAM proxy to reach I2P peers and accept I2P connections (default: +none) +.HP \fB\-listen\fR .IP Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR) .HP \fB\-listenonion\fR .IP -Automatically create Tor hidden service (default: 1) +Automatically create Tor onion service (default: 1) .HP \fB\-maxconnections=\fR .IP @@ -244,8 +271,9 @@ amount. (default: 4200 seconds) .HP \fB\-maxuploadtarget=\fR .IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) +Tries to keep outbound traffic under the given target (in MiB per 24h). +Limit does not apply to peers with 'download' permission. 0 = no +limit (default: 0) .HP \fB\-natpmp\fR .IP @@ -253,15 +281,18 @@ Use NAT\-PMP to map the listening port (default: 0) .HP \fB\-onion=\fR .IP -Use separate SOCKS5 proxy to reach peers via Tor hidden services, set +Use separate SOCKS5 proxy to reach peers via Tor onion services, set \fB\-noonion\fR to disable (default: \fB\-proxy\fR) .HP \fB\-onlynet=\fR .IP -Make outgoing connections only through network (ipv4, ipv6 or -onion). Incoming connections are not affected by this option. -This option can be specified multiple times to allow multiple -networks. +Make outgoing connections only through network (ipv4, ipv6, onion, +i2p). Incoming connections are not affected by this option. This +option can be specified multiple times to allow multiple +networks. Warning: if it is used with non\-onion networks and the +\fB\-onion\fR or \fB\-proxy\fR option is set, then outbound onion connections +will still be made; use \fB\-noonion\fR or \fB\-onion\fR=\fI\,0\/\fR to disable outbound +onion connections in this case. .HP \fB\-peerblockfilters\fR .IP @@ -284,8 +315,9 @@ Relay non\-P2SH multisig (default: 1) .HP \fB\-port=\fR .IP -Listen for connections on (default: 9999, testnet: 19999, -regtest: 19899) +Listen for connections on . Nodes not using the default ports +(default: 9999, testnet: 19999, regtest: 19899) are unlikely to +get incoming connections. Not relevant for I2P (see doc/i2p.md). .HP \fB\-proxy=\fR .IP @@ -328,21 +360,25 @@ Use UPnP to map the listening port (default: 0) .HP \fB\-whitebind=\fR<[permissions@]addr> .IP -Bind to given address and whitelist peers connecting to it. Use -[host]:port notation for IPv6. Allowed permissions are -bloomfilter (allow requesting BIP37 filtered blocks and -transactions), noban (do not ban for misbehavior), forcerelay -(relay transactions that are already in the mempool; implies -relay), relay (relay even in \fB\-blocksonly\fR mode), and mempool -(allow requesting BIP35 mempool contents). Specify multiple -permissions separated by commas (default: noban,mempool,relay). -Can be specified multiple times. +Bind to the given address and add permission flags to the peers +connecting to it. Use [host]:port notation for IPv6. Allowed +permissions: bloomfilter (allow requesting BIP37 filtered blocks +and transactions), noban (do not ban for misbehavior; implies +download), forcerelay (relay transactions that are already in the +mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode), +mempool (allow requesting BIP35 mempool contents), download +(allow getheaders during IBD, no disconnect after maxuploadtarget +limit), addr (responses to GETADDR avoid hitting the cache and +contain random records with the most up\-to\-date info). Specify +multiple permissions separated by commas (default: +download,noban,mempool,relay). Can be specified multiple times. .HP \fB\-whitelist=\fR<[permissions@]IP address or network> .IP -Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or -CIDR notated network(e.g. 1.2.3.0/24). Uses same permissions as -\fB\-whitebind\fR. Can be specified multiple times. +Add permission flags to the peers connecting from the given IP address +(e.g. 1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses +the same permissions as \fB\-whitebind\fR. Can be specified multiple +times. .PP Indexing options: .HP @@ -431,12 +467,14 @@ Wallet options: .HP \fB\-avoidpartialspends\fR .IP -Group outputs by address, selecting all or none, instead of selecting on -a per\-output basis. Privacy is improved as an address is only -used once (unless someone sends to it after spending from it), -but may result in slightly higher fees as suboptimal coin -selection may result due to the added limitation (default: 0 -(always enabled for wallets with "avoid_reuse" enabled)) +Group outputs by address, selecting many (possibly all) or none, instead +of selecting on a per\-output basis. Privacy is improved as +addresses are mostly swept with fewer transactions and outputs +are aggregated in clean change addresses. It may result in higher +fees due to less optimal coin selection caused by this added +limitation and possibly a larger\-than\-necessary number of inputs +being used. Always enabled for wallets with "avoid_reuse" +enabled, otherwise default: 0. .HP \fB\-createwalletbackups=\fR .IP @@ -449,7 +487,10 @@ Do not load the wallet and disable wallet RPC calls \fB\-instantsendnotify=\fR .IP Execute command when a wallet InstantSend transaction is successfully -locked (%s in cmd is replaced by TxID) +locked. %s in cmd is replaced by TxID and %w is replaced by +wallet name. %w is not currently implemented on Windows. On +systems where %w is supported, it should NOT be quoted because +this would break shell escaping used to invoke the command. .HP \fB\-keypool=\fR .IP @@ -511,7 +552,8 @@ limited by the fee estimate for the longest target \fB\-fallbackfee=\fR .IP A fee rate (in DASH/kB) that will be used when fee estimation has -insufficient data (default: 0.00001) +insufficient data. 0 to entirely disable the fallbackfee feature. +(default: 0.00001) .HP \fB\-mintxfee=\fR .IP @@ -539,6 +581,12 @@ during wallet creation/first start (default: randomly generated) User defined mnemonic for HD wallet (bip39). Only has effect during wallet creation/first start (default: randomly generated) .HP +\fB\-mnemonicbits=\fR +.IP +User defined mnemonic security for HD wallet in bits (BIP39). Only has +effect during wallet creation/first start (allowed values: 128, +160, 192, 224, 256; default: 128) +.HP \fB\-mnemonicpassphrase=\fR .IP User defined mnemonic passphrase for HD wallet (BIP39). Only has effect @@ -764,9 +812,9 @@ optional). If is not supplied or if = 1, output all debugging information. can be: net, tor, mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, -libevent, coindb, qt, leveldb, chainlocks, gobject, instantsend, -llmq, llmq\-dkg, llmq\-sigs, mnpayments, mnsync, coinjoin, spork, -netconn. +libevent, coindb, qt, leveldb, validation, i2p, chainlocks, +gobject, instantsend, llmq, llmq\-dkg, llmq\-sigs, mnpayments, +mnsync, coinjoin, spork, netconn. .HP \fB\-debugexclude=\fR .IP @@ -829,6 +877,11 @@ Append comment to the user agent string .PP Chain selection options: .HP +\fB\-chain=\fR +.IP +Use the chain (default: main). Allowed values: main, test, +regtest +.HP \fB\-devnet=\fR .IP Use devnet chain with provided name @@ -846,7 +899,8 @@ highsubsidyblocks window of a chain (default: 1, devnet\-only) \fB\-llmqchainlocks=\fR .IP Override the default LLMQ type used for ChainLocks. Allows using -ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet\-only) +ChainLocks with smaller LLMQs. (default: llmq_devnet, +devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP @@ -856,19 +910,24 @@ devnet\-only) \fB\-llmqinstantsend=\fR .IP Override the default LLMQ type used for InstantSend. Allows using -InstantSend with smaller LLMQs. (default: llmq_50_60, +InstantSend with smaller LLMQs. (default: llmq_devnet, devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP Override the default LLMQ type used for InstantSendDIP0024. (default: -llmq_60_75, devnet\-only) +llmq_devnet_dip0024, devnet\-only) .HP -\fB\-llmqplatform=\fR +\fB\-llmqmnhf=\fR .IP -Override the default LLMQ type used for Platform. (default: llmq_100_67, +Override the default LLMQ type used for EHF. (default: llmq_devnet, devnet\-only) .HP +\fB\-llmqplatform=\fR +.IP +Override the default LLMQ type used for Platform. (default: +llmq_devnet_platform, devnet\-only) +.HP \fB\-minimumdifficultyblocks=\fR .IP The number of blocks that can be mined with the minimum difficulty at @@ -881,7 +940,7 @@ minutes, devnet\-only) .HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR .PP Node relay options: .HP @@ -1050,14 +1109,3 @@ Show splash screen on startup (default: 1) \fB\-windowtitle=\fR .IP Sets a window title which is appended to "Dash Core \- " -.SH COPYRIGHT -Copyright (C) 2014-2023 The Dash Core developers -Copyright (C) 2009-2023 The Bitcoin Core developers - -Please contribute if you find Dash Core useful. Visit for -further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or diff --git a/doc/man/dash-tx.1 b/doc/man/dash-tx.1 index 440e9170c5648..5e8620de5dee5 100644 --- a/doc/man/dash-tx.1 +++ b/doc/man/dash-tx.1 @@ -1,7 +1,7 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH DASH-TX "1" "June 2023" "dash-tx v19.2.0" "User Commands" +.TH DASH-TX "1" "November 2023" "dash-tx v20.0.0" "User Commands" .SH NAME -dash-tx \- manual page for dash-tx v19.2.0 +dash-tx \- manual page for dash-tx v20.0.0 .SH SYNOPSIS .B dash-tx [\fI\,options\/\fR] \fI\, \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded dash transaction\/\fR @@ -9,7 +9,7 @@ dash-tx \- manual page for dash-tx v19.2.0 .B dash-tx [\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded dash transaction\/\fR .SH DESCRIPTION -Dash Core dash\-tx utility version v19.2.0 +Dash Core dash\-tx utility version v20.0.0 .SH OPTIONS .HP \-? @@ -27,9 +27,18 @@ Select JSON output \fB\-txid\fR .IP Output only the hex\-encoded transaction id of the resultant transaction. +.HP +\fB\-version\fR +.IP +Print version and exit .PP Chain selection options: .HP +\fB\-chain=\fR +.IP +Use the chain (default: main). Allowed values: main, test, +regtest +.HP \fB\-devnet=\fR .IP Use devnet chain with provided name @@ -47,7 +56,8 @@ highsubsidyblocks window of a chain (default: 1, devnet\-only) \fB\-llmqchainlocks=\fR .IP Override the default LLMQ type used for ChainLocks. Allows using -ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet\-only) +ChainLocks with smaller LLMQs. (default: llmq_devnet, +devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP @@ -57,19 +67,24 @@ devnet\-only) \fB\-llmqinstantsend=\fR .IP Override the default LLMQ type used for InstantSend. Allows using -InstantSend with smaller LLMQs. (default: llmq_50_60, +InstantSend with smaller LLMQs. (default: llmq_devnet, devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP Override the default LLMQ type used for InstantSendDIP0024. (default: -llmq_60_75, devnet\-only) +llmq_devnet_dip0024, devnet\-only) .HP -\fB\-llmqplatform=\fR +\fB\-llmqmnhf=\fR .IP -Override the default LLMQ type used for Platform. (default: llmq_100_67, +Override the default LLMQ type used for EHF. (default: llmq_devnet, devnet\-only) .HP +\fB\-llmqplatform=\fR +.IP +Override the default LLMQ type used for Platform. (default: +llmq_devnet_platform, devnet\-only) +.HP \fB\-minimumdifficultyblocks=\fR .IP The number of blocks that can be mined with the minimum difficulty at @@ -82,7 +97,7 @@ minutes, devnet\-only) .HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR .PP Commands: .IP @@ -146,14 +161,3 @@ Load JSON file FILENAME into register NAME set=NAME:JSON\-STRING .IP Set register NAME to given JSON\-STRING -.SH COPYRIGHT -Copyright (C) 2014-2023 The Dash Core developers -Copyright (C) 2009-2023 The Bitcoin Core developers - -Please contribute if you find Dash Core useful. Visit for -further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or diff --git a/doc/man/dash-wallet.1 b/doc/man/dash-wallet.1 index 51f6d1ddd0f85..8a6c6329b77ce 100644 --- a/doc/man/dash-wallet.1 +++ b/doc/man/dash-wallet.1 @@ -1,9 +1,9 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH DASH-WALLET "1" "June 2023" "dash-wallet v19.2.0" "User Commands" +.TH DASH-WALLET "1" "November 2023" "dash-wallet v20.0.0" "User Commands" .SH NAME -dash-wallet \- manual page for dash-wallet v19.2.0 +dash-wallet \- manual page for dash-wallet v20.0.0 .SH DESCRIPTION -Dash Core dash\-wallet version v19.2.0 +Dash Core dash\-wallet version v20.0.0 .PP dash\-wallet is an offline tool for creating and interacting with Dash Core wallet files. By default dash\-wallet will act on wallets in the default mainnet wallet directory in the datadir. @@ -21,6 +21,10 @@ Print this help message and exit .IP Specify data directory .HP +\fB\-version\fR +.IP +Print version and exit +.HP \fB\-wallet=\fR .IP Specify wallet name @@ -38,6 +42,11 @@ otherwise). .PP Chain selection options: .HP +\fB\-chain=\fR +.IP +Use the chain (default: main). Allowed values: main, test, +regtest +.HP \fB\-devnet=\fR .IP Use devnet chain with provided name @@ -55,7 +64,8 @@ highsubsidyblocks window of a chain (default: 1, devnet\-only) \fB\-llmqchainlocks=\fR .IP Override the default LLMQ type used for ChainLocks. Allows using -ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet\-only) +ChainLocks with smaller LLMQs. (default: llmq_devnet, +devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP @@ -65,19 +75,24 @@ devnet\-only) \fB\-llmqinstantsend=\fR .IP Override the default LLMQ type used for InstantSend. Allows using -InstantSend with smaller LLMQs. (default: llmq_50_60, +InstantSend with smaller LLMQs. (default: llmq_devnet, devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP Override the default LLMQ type used for InstantSendDIP0024. (default: -llmq_60_75, devnet\-only) +llmq_devnet_dip0024, devnet\-only) .HP -\fB\-llmqplatform=\fR +\fB\-llmqmnhf=\fR .IP -Override the default LLMQ type used for Platform. (default: llmq_100_67, +Override the default LLMQ type used for EHF. (default: llmq_devnet, devnet\-only) .HP +\fB\-llmqplatform=\fR +.IP +Override the default LLMQ type used for Platform. (default: +llmq_devnet_platform, devnet\-only) +.HP \fB\-minimumdifficultyblocks=\fR .IP The number of blocks that can be mined with the minimum difficulty at @@ -90,7 +105,7 @@ minutes, devnet\-only) .HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR .PP Commands: .IP @@ -104,15 +119,9 @@ Get wallet info .IP salvage .IP -Attempt to recover private keys from a corrupt wallet -.SH COPYRIGHT -Copyright (C) 2014-2023 The Dash Core developers -Copyright (C) 2009-2023 The Bitcoin Core developers - -Please contribute if you find Dash Core useful. Visit for -further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or +Attempt to recover private keys from a corrupt wallet. Warning: +\&'salvage' is experimental. +.IP +wipetxes +.IP +Wipe all transactions from a wallet diff --git a/doc/man/dashd.1 b/doc/man/dashd.1 index 3c35690a195ef..68d5b7439846b 100644 --- a/doc/man/dashd.1 +++ b/doc/man/dashd.1 @@ -1,12 +1,22 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH DASHD "1" "June 2023" "dashd v19.2.0" "User Commands" +.TH DASHD "1" "November 2023" "dashd v20.0.0" "User Commands" .SH NAME -dashd \- manual page for dashd v19.2.0 +dashd \- manual page for dashd v20.0.0 .SH SYNOPSIS .B dashd -[\fI\,options\/\fR] \fI\,Start Dash Core Daemon\/\fR +[\fI\,options\/\fR] \fI\,Start Dash Core\/\fR .SH DESCRIPTION -Dash Core Daemon version v19.2.0 +Dash Core version v20.0.0 +Copyright \(co 2014\-2023 The Dash Core developers +Copyright \(co 2009\-2023 The Bitcoin Core developers +.PP +Please contribute if you find Dash Core useful. Visit for +further information about the software. +The source code is available from . +.PP +This is experimental software. +Distributed under the MIT software license, see the accompanying file COPYING +or .SH OPTIONS .HP \-? @@ -55,6 +65,15 @@ and rebroadcast of any transactions from inbound peers is disabled, unless the peer has the 'forcerelay' permission. RPC transactions are not affected. (default: 0) .HP +\fB\-chainlocknotify=\fR +.IP +Execute command when the best chainlock changes (%s in cmd is replaced +by chainlocked block hash) +.HP +\fB\-coinstatsindex\fR +.IP +Maintain coinstats index used by the gettxoutset RPC (default: 0) +.HP \fB\-conf=\fR .IP Specify path to read\-only configuration file. Relative paths will be @@ -126,11 +145,12 @@ Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a target size in MiB is provided. This mode is -incompatible with \fB\-txindex\fR, \fB\-rescan\fR and \fB\-disablegovernance\fR=\fI\,false\/\fR. -Warning: Reverting this setting requires re\-downloading the -entire blockchain. (default: 0 = disable pruning blocks, 1 = -allow manual pruning via RPC, >945 = automatically prune block -files to stay under the specified target size in MiB) +incompatible with \fB\-txindex\fR, \fB\-coinstatsindex\fR, \fB\-rescan\fR and +\fB\-disablegovernance\fR=\fI\,false\/\fR. Warning: Reverting this setting +requires re\-downloading the entire blockchain. (default: 0 = +disable pruning blocks, 1 = allow manual pruning via RPC, >945 = +automatically prune block files to stay under the specified +target size in MiB) .HP \fB\-settings=\fR .IP @@ -181,10 +201,13 @@ Threshold for disconnecting and discouraging misbehaving peers (default: Default duration (in seconds) of manually configured bans (default: 86400) .HP -\fB\-bind=\fR +\fB\-bind=\fR[:][=onion] .IP -Bind to given address and always listen on it. Use [host]:port notation -for IPv6 +Bind to given address and always listen on it (default: 0.0.0.0). Use +[host]:port notation for IPv6. Append =onion to tag any incoming +connections to that address and port as incoming Tor connections +(default: 127.0.0.1:9996=onion, testnet: 127.0.0.1:19996=onion, +regtest: 127.0.0.1:19896=onion) .HP \fB\-connect=\fR .IP @@ -215,13 +238,27 @@ Specify your own public address .IP Always query for peer addresses via DNS lookup (default: 0) .HP +\fB\-i2pacceptincoming\fR +.IP +If set and \fB\-i2psam\fR is also set then incoming I2P connections are +accepted via the SAM proxy. If this is not set but \fB\-i2psam\fR is set +then only outgoing connections will be made to the I2P network. +Ignored if \fB\-i2psam\fR is not set. Listening for incoming I2P +connections is done through the SAM proxy, not by binding to a +local address and port (default: 1) +.HP +\fB\-i2psam=\fR +.IP +I2P SAM proxy to reach I2P peers and accept I2P connections (default: +none) +.HP \fB\-listen\fR .IP Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR) .HP \fB\-listenonion\fR .IP -Automatically create Tor hidden service (default: 1) +Automatically create Tor onion service (default: 1) .HP \fB\-maxconnections=\fR .IP @@ -244,8 +281,9 @@ amount. (default: 4200 seconds) .HP \fB\-maxuploadtarget=\fR .IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) +Tries to keep outbound traffic under the given target (in MiB per 24h). +Limit does not apply to peers with 'download' permission. 0 = no +limit (default: 0) .HP \fB\-natpmp\fR .IP @@ -253,15 +291,18 @@ Use NAT\-PMP to map the listening port (default: 0) .HP \fB\-onion=\fR .IP -Use separate SOCKS5 proxy to reach peers via Tor hidden services, set +Use separate SOCKS5 proxy to reach peers via Tor onion services, set \fB\-noonion\fR to disable (default: \fB\-proxy\fR) .HP \fB\-onlynet=\fR .IP -Make outgoing connections only through network (ipv4, ipv6 or -onion). Incoming connections are not affected by this option. -This option can be specified multiple times to allow multiple -networks. +Make outgoing connections only through network (ipv4, ipv6, onion, +i2p). Incoming connections are not affected by this option. This +option can be specified multiple times to allow multiple +networks. Warning: if it is used with non\-onion networks and the +\fB\-onion\fR or \fB\-proxy\fR option is set, then outbound onion connections +will still be made; use \fB\-noonion\fR or \fB\-onion\fR=\fI\,0\/\fR to disable outbound +onion connections in this case. .HP \fB\-peerblockfilters\fR .IP @@ -284,8 +325,9 @@ Relay non\-P2SH multisig (default: 1) .HP \fB\-port=\fR .IP -Listen for connections on (default: 9999, testnet: 19999, -regtest: 19899) +Listen for connections on . Nodes not using the default ports +(default: 9999, testnet: 19999, regtest: 19899) are unlikely to +get incoming connections. Not relevant for I2P (see doc/i2p.md). .HP \fB\-proxy=\fR .IP @@ -328,21 +370,25 @@ Use UPnP to map the listening port (default: 0) .HP \fB\-whitebind=\fR<[permissions@]addr> .IP -Bind to given address and whitelist peers connecting to it. Use -[host]:port notation for IPv6. Allowed permissions are -bloomfilter (allow requesting BIP37 filtered blocks and -transactions), noban (do not ban for misbehavior), forcerelay -(relay transactions that are already in the mempool; implies -relay), relay (relay even in \fB\-blocksonly\fR mode), and mempool -(allow requesting BIP35 mempool contents). Specify multiple -permissions separated by commas (default: noban,mempool,relay). -Can be specified multiple times. +Bind to the given address and add permission flags to the peers +connecting to it. Use [host]:port notation for IPv6. Allowed +permissions: bloomfilter (allow requesting BIP37 filtered blocks +and transactions), noban (do not ban for misbehavior; implies +download), forcerelay (relay transactions that are already in the +mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode), +mempool (allow requesting BIP35 mempool contents), download +(allow getheaders during IBD, no disconnect after maxuploadtarget +limit), addr (responses to GETADDR avoid hitting the cache and +contain random records with the most up\-to\-date info). Specify +multiple permissions separated by commas (default: +download,noban,mempool,relay). Can be specified multiple times. .HP \fB\-whitelist=\fR<[permissions@]IP address or network> .IP -Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or -CIDR notated network(e.g. 1.2.3.0/24). Uses same permissions as -\fB\-whitebind\fR. Can be specified multiple times. +Add permission flags to the peers connecting from the given IP address +(e.g. 1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses +the same permissions as \fB\-whitebind\fR. Can be specified multiple +times. .PP Indexing options: .HP @@ -431,12 +477,14 @@ Wallet options: .HP \fB\-avoidpartialspends\fR .IP -Group outputs by address, selecting all or none, instead of selecting on -a per\-output basis. Privacy is improved as an address is only -used once (unless someone sends to it after spending from it), -but may result in slightly higher fees as suboptimal coin -selection may result due to the added limitation (default: 0 -(always enabled for wallets with "avoid_reuse" enabled)) +Group outputs by address, selecting many (possibly all) or none, instead +of selecting on a per\-output basis. Privacy is improved as +addresses are mostly swept with fewer transactions and outputs +are aggregated in clean change addresses. It may result in higher +fees due to less optimal coin selection caused by this added +limitation and possibly a larger\-than\-necessary number of inputs +being used. Always enabled for wallets with "avoid_reuse" +enabled, otherwise default: 0. .HP \fB\-createwalletbackups=\fR .IP @@ -449,7 +497,10 @@ Do not load the wallet and disable wallet RPC calls \fB\-instantsendnotify=\fR .IP Execute command when a wallet InstantSend transaction is successfully -locked (%s in cmd is replaced by TxID) +locked. %s in cmd is replaced by TxID and %w is replaced by +wallet name. %w is not currently implemented on Windows. On +systems where %w is supported, it should NOT be quoted because +this would break shell escaping used to invoke the command. .HP \fB\-keypool=\fR .IP @@ -511,7 +562,8 @@ limited by the fee estimate for the longest target \fB\-fallbackfee=\fR .IP A fee rate (in DASH/kB) that will be used when fee estimation has -insufficient data (default: 0.00001) +insufficient data. 0 to entirely disable the fallbackfee feature. +(default: 0.00001) .HP \fB\-mintxfee=\fR .IP @@ -539,6 +591,12 @@ during wallet creation/first start (default: randomly generated) User defined mnemonic for HD wallet (bip39). Only has effect during wallet creation/first start (default: randomly generated) .HP +\fB\-mnemonicbits=\fR +.IP +User defined mnemonic security for HD wallet in bits (BIP39). Only has +effect during wallet creation/first start (allowed values: 128, +160, 192, 224, 256; default: 128) +.HP \fB\-mnemonicpassphrase=\fR .IP User defined mnemonic passphrase for HD wallet (BIP39). Only has effect @@ -764,9 +822,9 @@ optional). If is not supplied or if = 1, output all debugging information. can be: net, tor, mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, -libevent, coindb, qt, leveldb, chainlocks, gobject, instantsend, -llmq, llmq\-dkg, llmq\-sigs, mnpayments, mnsync, coinjoin, spork, -netconn. +libevent, coindb, qt, leveldb, validation, i2p, chainlocks, +gobject, instantsend, llmq, llmq\-dkg, llmq\-sigs, mnpayments, +mnsync, coinjoin, spork, netconn. .HP \fB\-debugexclude=\fR .IP @@ -829,6 +887,11 @@ Append comment to the user agent string .PP Chain selection options: .HP +\fB\-chain=\fR +.IP +Use the chain (default: main). Allowed values: main, test, +regtest +.HP \fB\-devnet=\fR .IP Use devnet chain with provided name @@ -846,7 +909,8 @@ highsubsidyblocks window of a chain (default: 1, devnet\-only) \fB\-llmqchainlocks=\fR .IP Override the default LLMQ type used for ChainLocks. Allows using -ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet\-only) +ChainLocks with smaller LLMQs. (default: llmq_devnet, +devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP @@ -856,19 +920,24 @@ devnet\-only) \fB\-llmqinstantsend=\fR .IP Override the default LLMQ type used for InstantSend. Allows using -InstantSend with smaller LLMQs. (default: llmq_50_60, +InstantSend with smaller LLMQs. (default: llmq_devnet, devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP Override the default LLMQ type used for InstantSendDIP0024. (default: -llmq_60_75, devnet\-only) +llmq_devnet_dip0024, devnet\-only) .HP -\fB\-llmqplatform=\fR +\fB\-llmqmnhf=\fR .IP -Override the default LLMQ type used for Platform. (default: llmq_100_67, +Override the default LLMQ type used for EHF. (default: llmq_devnet, devnet\-only) .HP +\fB\-llmqplatform=\fR +.IP +Override the default LLMQ type used for Platform. (default: +llmq_devnet_platform, devnet\-only) +.HP \fB\-minimumdifficultyblocks=\fR .IP The number of blocks that can be mined with the minimum difficulty at @@ -881,7 +950,7 @@ minutes, devnet\-only) .HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR .PP Node relay options: .HP @@ -1001,14 +1070,3 @@ subject to empty whitelists. \fB\-server\fR .IP Accept command line and JSON\-RPC commands -.SH COPYRIGHT -Copyright (C) 2014-2023 The Dash Core developers -Copyright (C) 2009-2023 The Bitcoin Core developers - -Please contribute if you find Dash Core useful. Visit for -further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or