From e2f56de7f471d278779e832eb62a06b03e230e3b Mon Sep 17 00:00:00 2001 From: Konstantin Akimov Date: Thu, 18 Jul 2024 12:43:14 +0700 Subject: [PATCH] docs: update manpages for 21.0 run `./contrib/devtools/gen-manpages.sh`, sanitize version name --- doc/man/dash-cli.1 | 24 +++++++++--- doc/man/dash-qt.1 | 85 ++++++++++++++++++++++++++++--------------- doc/man/dash-tx.1 | 9 ++--- doc/man/dash-wallet.1 | 35 +++++++++++++++--- doc/man/dashd.1 | 85 ++++++++++++++++++++++++++++--------------- 5 files changed, 165 insertions(+), 73 deletions(-) diff --git a/doc/man/dash-cli.1 b/doc/man/dash-cli.1 index 523e441f3e..025e7a09fe 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" "March 2024" "dash-cli v20.1.0" "User Commands" +.TH DASH-CLI "1" "July 2024" "dash-cli v21.0.0" "User Commands" .SH NAME -dash-cli \- manual page for dash-cli v20.1.0 +dash-cli \- manual page for dash-cli v21.0.0 .SH SYNOPSIS .B dash-cli [\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] \fI\,Send command to Dash Core\/\fR @@ -15,13 +15,23 @@ dash-cli \- manual page for dash-cli v20.1.0 .B dash-cli [\fI\,options\/\fR] \fI\,help Get help for a command\/\fR .SH DESCRIPTION -Dash Core RPC client version v20.1.0 +Dash Core RPC client version v21.0.0 .SH OPTIONS .HP \-? .IP Print this help message and exit .HP +\fB\-addrinfo\fR +.IP +Get the number of addresses known to the node, per network and total. +.HP +\fB\-color=\fR +.IP +Color setting for CLI output (default: auto). Valid values: always, auto +(add color codes when standard output is connected to a terminal +and OS is not WIN32), never. +.HP \fB\-conf=\fR .IP Specify configuration file. Relative paths will be prefixed by datadir @@ -90,6 +100,11 @@ Username for JSON\-RPC connections .IP Wait for RPC server to start .HP +\fB\-rpcwaittimeout=\fR +.IP +Timeout in seconds to wait for the RPC server to start, or 0 for no +timeout. (default: 0) +.HP \fB\-rpcwallet=\fR .IP Send RPC for non\-default wallet on RPC server (needs to exactly match @@ -151,8 +166,7 @@ devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP -Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2, -devnet\-only) +Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP diff --git a/doc/man/dash-qt.1 b/doc/man/dash-qt.1 index dc416e8765..a17ccace6c 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" "March 2024" "dash-qt v20.1.0" "User Commands" +.TH DASH-QT "1" "July 2024" "dash-qt v21.0.0" "User Commands" .SH NAME -dash-qt \- manual page for dash-qt v20.1.0 +dash-qt \- manual page for dash-qt v21.0.0 .SH SYNOPSIS .B dash-qt [\fI\,command-line options\/\fR] .SH DESCRIPTION -Dash Core version v20.1.0 +Dash Core version v21.0.0 .SH OPTIONS .HP \-? @@ -71,7 +71,12 @@ prefixed by datadir location. (default: dash.conf) .HP \fB\-daemon\fR .IP -Run in the background as a daemon and accept commands +Run in the background as a daemon and accept commands (default: 0) +.HP +\fB\-daemonwait\fR +.IP +Wait for initialization to be finished before exiting. This implies +\fB\-daemon\fR (default: 0) .HP \fB\-datadir=\fR .IP @@ -117,7 +122,7 @@ Do not keep transactions in the mempool longer than hours (default: .HP \fB\-par=\fR .IP -Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 = +Set the number of script verification threads (\fB\-16\fR to 15, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-persistmempool\fR @@ -172,8 +177,10 @@ Connection options: \fB\-addnode=\fR .IP Add a node to connect to and attempt to keep the connection open (see -the `addnode` RPC command help for more info). This option can be -specified multiple times to add multiple nodes. +the addnode RPC help for more info). This option can be specified +multiple times to add multiple nodes; connections are limited to +8 at a time and are counted separately from the \fB\-maxconnections\fR +limit. .HP \fB\-allowprivatenet\fR .IP @@ -185,11 +192,6 @@ Specify asn mapping used for bucketing of the peers (default: ip_asn.map). Relative paths will be prefixed by the net\-specific datadir location. .HP -\fB\-banscore=\fR -.IP -Threshold for disconnecting and discouraging misbehaving peers (default: -100) -.HP \fB\-bantime=\fR .IP Default duration (in seconds) of manually configured bans (default: @@ -203,6 +205,12 @@ 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\-cjdnsreachable\fR +.IP +If set, then this host is configured for CJDNS (connecting to fc00::/8 +addresses would lead us to the CJDNS network, see doc/cjdns.md) +(default: 0) +.HP \fB\-connect=\fR .IP Connect only to the specified node; \fB\-noconnect\fR disables automatic @@ -228,18 +236,20 @@ unless \fB\-connect\fR used) .IP Specify your own public address .HP +\fB\-fixedseeds\fR +.IP +Allow fixed seeds if DNS seeds don't provide peers (default: 1) +.HP \fB\-forcednsseed\fR .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) +Whether to accept inbound I2P connections (default: 1). Ignored if +\fB\-i2psam\fR is not set. Listening for inbound I2P connections is done +through the SAM proxy, not by binding to a local address and +port. .HP \fB\-i2psam=\fR .IP @@ -257,7 +267,9 @@ Automatically create Tor onion service (default: 1) \fB\-maxconnections=\fR .IP Maintain at most connections to peers (temporary service connections -excluded) (default: 125) +excluded) (default: 125). This limit does not apply to +connections manually added via \fB\-addnode\fR or the addnode RPC, which +have a separate limit of 8. .HP \fB\-maxreceivebuffer=\fR .IP @@ -283,6 +295,11 @@ limit (default: 0) .IP Use NAT\-PMP to map the listening port (default: 0) .HP +\fB\-networkactive\fR +.IP +Enable all P2P network activity (default: 1). Can be changed by the +setnetworkactive RPC command +.HP \fB\-onion=\fR .IP Use separate SOCKS5 proxy to reach peers via Tor onion services, set @@ -290,13 +307,10 @@ Use separate SOCKS5 proxy to reach peers via Tor onion services, set .HP \fB\-onlynet=\fR .IP -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. +Make automatic outbound connections only to network (ipv4, ipv6, +onion, i2p, cjdns). Inbound and manual connections are not +affected by this option. It can be specified multiple times to +allow multiple networks. .HP \fB\-peerblockfilters\fR .IP @@ -506,6 +520,11 @@ increase the risk of losing funds when restoring from an old backup, if none of the addresses in the original keypool have been used. .HP +\fB\-maxapsfee=\fR +.IP +Spend up to this amount in additional (absolute) fees (in DASH) if it +allows the use of partial spend avoidance (default: 0.00) +.HP \fB\-rescan=\fR .IP Rescan the block chain for missing wallet transactions on startup (1 = @@ -819,7 +838,7 @@ optional). If is not supplied or if = 1, output all debugging information. can be: addrman, bench, chainlocks, cmpctblock, coindb, coinjoin, creditpool, ehf, estimatefee, gobject, http, i2p, instantsend, leveldb, libevent, -llmq, llmq\-dkg, llmq\-sigs, mempool, mempoolrej, mnpayments, +llmq, llmq\-dkg, llmq\-sigs, lock, mempool, mempoolrej, mnpayments, mnsync, net, netconn, proxy, prune, qt, rand, reindex, rpc, selectcoins, spork, tor, validation, walletdb, zmq. This option can be specified multiple times to output multiple categories. @@ -843,6 +862,11 @@ Print help message with debugging options and exit .IP Include IP addresses in debug output (default: 0) .HP +\fB\-logsourcelocations\fR +.IP +Prepend debug output with name of the originating source location +(source file, line number and function name) (default: 0) +.HP \fB\-logtimestamps\fR .IP Prepend debug output with timestamp (default: 1) @@ -914,8 +938,7 @@ devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP -Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2, -devnet\-only) +Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP @@ -1027,6 +1050,10 @@ specified, 0.0.0.0 and :: i.e., all addresses) Location of the auth cookie. Relative paths will be prefixed by a net\-specific datadir location. (default: data dir) .HP +\fB\-rpcexternaluser=\fR +.IP +List of comma\-separated usernames for JSON\-RPC external connections +.HP \fB\-rpcpassword=\fR .IP Password for JSON\-RPC connections diff --git a/doc/man/dash-tx.1 b/doc/man/dash-tx.1 index d722260cd0..e5e75b188f 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" "March 2024" "dash-tx v20.1.0" "User Commands" +.TH DASH-TX "1" "July 2024" "dash-tx v21.0.0" "User Commands" .SH NAME -dash-tx \- manual page for dash-tx v20.1.0 +dash-tx \- manual page for dash-tx v21.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 v20.1.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 v20.1.0 +Dash Core dash\-tx utility version v21.0.0 .SH OPTIONS .HP \-? @@ -62,8 +62,7 @@ devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP -Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2, -devnet\-only) +Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP diff --git a/doc/man/dash-wallet.1 b/doc/man/dash-wallet.1 index bc0bcd2e87..922fa1d959 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" "March 2024" "dash-wallet v20.1.0" "User Commands" +.TH DASH-WALLET "1" "July 2024" "dash-wallet v21.0.0" "User Commands" .SH NAME -dash-wallet \- manual page for dash-wallet v20.1.0 +dash-wallet \- manual page for dash-wallet v21.0.0 .SH DESCRIPTION -Dash Core dash\-wallet version v20.1.0 +Dash Core dash\-wallet version v21.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,24 @@ Print this help message and exit .IP Specify data directory .HP +\fB\-descriptors\fR +.IP +Create descriptors wallet. Only for 'create' +.HP +\fB\-dumpfile=\fR +.IP +When used with 'dump', writes out the records to this file. When used +with 'createfromdump', loads the records into a new wallet. +.HP +\fB\-format=\fR +.IP +The format of the wallet file to create. Either "bdb" or "sqlite". Only +used with 'createfromdump' +.HP +\fB\-usehd\fR +.IP +Create HD (hierarchical deterministic) wallet (default: 1) +.HP \fB\-version\fR .IP Print version and exit @@ -70,8 +88,7 @@ devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP -Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2, -devnet\-only) +Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP @@ -108,6 +125,14 @@ create .IP Create new wallet file .IP +createfromdump +.IP +Create new wallet file from dumped records +.IP +dump +.IP +Print out all of the wallet key\-value records +.IP info .IP Get wallet info diff --git a/doc/man/dashd.1 b/doc/man/dashd.1 index 047dd714f9..1c6b5f0556 100644 --- a/doc/man/dashd.1 +++ b/doc/man/dashd.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH DASHD "1" "March 2024" "dashd v20.1.0" "User Commands" +.TH DASHD "1" "July 2024" "dashd v21.0.0" "User Commands" .SH NAME -dashd \- manual page for dashd v20.1.0 +dashd \- manual page for dashd v21.0.0 .SH SYNOPSIS .B dashd [\fI\,options\/\fR] \fI\,Start Dash Core\/\fR .SH DESCRIPTION -Dash Core version v20.1.0 +Dash Core version v21.0.0 Copyright \(co 2014\-2024 The Dash Core developers Copyright \(co 2009\-2024 The Bitcoin Core developers .PP @@ -81,7 +81,12 @@ prefixed by datadir location. (default: dash.conf) .HP \fB\-daemon\fR .IP -Run in the background as a daemon and accept commands +Run in the background as a daemon and accept commands (default: 0) +.HP +\fB\-daemonwait\fR +.IP +Wait for initialization to be finished before exiting. This implies +\fB\-daemon\fR (default: 0) .HP \fB\-datadir=\fR .IP @@ -127,7 +132,7 @@ Do not keep transactions in the mempool longer than hours (default: .HP \fB\-par=\fR .IP -Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 = +Set the number of script verification threads (\fB\-16\fR to 15, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-persistmempool\fR @@ -182,8 +187,10 @@ Connection options: \fB\-addnode=\fR .IP Add a node to connect to and attempt to keep the connection open (see -the `addnode` RPC command help for more info). This option can be -specified multiple times to add multiple nodes. +the addnode RPC help for more info). This option can be specified +multiple times to add multiple nodes; connections are limited to +8 at a time and are counted separately from the \fB\-maxconnections\fR +limit. .HP \fB\-allowprivatenet\fR .IP @@ -195,11 +202,6 @@ Specify asn mapping used for bucketing of the peers (default: ip_asn.map). Relative paths will be prefixed by the net\-specific datadir location. .HP -\fB\-banscore=\fR -.IP -Threshold for disconnecting and discouraging misbehaving peers (default: -100) -.HP \fB\-bantime=\fR .IP Default duration (in seconds) of manually configured bans (default: @@ -213,6 +215,12 @@ 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\-cjdnsreachable\fR +.IP +If set, then this host is configured for CJDNS (connecting to fc00::/8 +addresses would lead us to the CJDNS network, see doc/cjdns.md) +(default: 0) +.HP \fB\-connect=\fR .IP Connect only to the specified node; \fB\-noconnect\fR disables automatic @@ -238,18 +246,20 @@ unless \fB\-connect\fR used) .IP Specify your own public address .HP +\fB\-fixedseeds\fR +.IP +Allow fixed seeds if DNS seeds don't provide peers (default: 1) +.HP \fB\-forcednsseed\fR .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) +Whether to accept inbound I2P connections (default: 1). Ignored if +\fB\-i2psam\fR is not set. Listening for inbound I2P connections is done +through the SAM proxy, not by binding to a local address and +port. .HP \fB\-i2psam=\fR .IP @@ -267,7 +277,9 @@ Automatically create Tor onion service (default: 1) \fB\-maxconnections=\fR .IP Maintain at most connections to peers (temporary service connections -excluded) (default: 125) +excluded) (default: 125). This limit does not apply to +connections manually added via \fB\-addnode\fR or the addnode RPC, which +have a separate limit of 8. .HP \fB\-maxreceivebuffer=\fR .IP @@ -293,6 +305,11 @@ limit (default: 0) .IP Use NAT\-PMP to map the listening port (default: 0) .HP +\fB\-networkactive\fR +.IP +Enable all P2P network activity (default: 1). Can be changed by the +setnetworkactive RPC command +.HP \fB\-onion=\fR .IP Use separate SOCKS5 proxy to reach peers via Tor onion services, set @@ -300,13 +317,10 @@ Use separate SOCKS5 proxy to reach peers via Tor onion services, set .HP \fB\-onlynet=\fR .IP -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. +Make automatic outbound connections only to network (ipv4, ipv6, +onion, i2p, cjdns). Inbound and manual connections are not +affected by this option. It can be specified multiple times to +allow multiple networks. .HP \fB\-peerblockfilters\fR .IP @@ -516,6 +530,11 @@ increase the risk of losing funds when restoring from an old backup, if none of the addresses in the original keypool have been used. .HP +\fB\-maxapsfee=\fR +.IP +Spend up to this amount in additional (absolute) fees (in DASH) if it +allows the use of partial spend avoidance (default: 0.00) +.HP \fB\-rescan=\fR .IP Rescan the block chain for missing wallet transactions on startup (1 = @@ -829,7 +848,7 @@ optional). If is not supplied or if = 1, output all debugging information. can be: addrman, bench, chainlocks, cmpctblock, coindb, coinjoin, creditpool, ehf, estimatefee, gobject, http, i2p, instantsend, leveldb, libevent, -llmq, llmq\-dkg, llmq\-sigs, mempool, mempoolrej, mnpayments, +llmq, llmq\-dkg, llmq\-sigs, lock, mempool, mempoolrej, mnpayments, mnsync, net, netconn, proxy, prune, qt, rand, reindex, rpc, selectcoins, spork, tor, validation, walletdb, zmq. This option can be specified multiple times to output multiple categories. @@ -853,6 +872,11 @@ Print help message with debugging options and exit .IP Include IP addresses in debug output (default: 0) .HP +\fB\-logsourcelocations\fR +.IP +Prepend debug output with name of the originating source location +(source file, line number and function name) (default: 0) +.HP \fB\-logtimestamps\fR .IP Prepend debug output with timestamp (default: 1) @@ -924,8 +948,7 @@ devnet\-only) .HP \fB\-llmqdevnetparams=\fR: .IP -Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2, -devnet\-only) +Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet\-only) .HP \fB\-llmqinstantsenddip0024=\fR .IP @@ -1037,6 +1060,10 @@ specified, 0.0.0.0 and :: i.e., all addresses) Location of the auth cookie. Relative paths will be prefixed by a net\-specific datadir location. (default: data dir) .HP +\fB\-rpcexternaluser=\fR +.IP +List of comma\-separated usernames for JSON\-RPC external connections +.HP \fB\-rpcpassword=\fR .IP Password for JSON\-RPC connections