Skip to content

docs: update man pages for 23.0 #6928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 4, 2025
Merged

docs: update man pages for 23.0 #6928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
faa58da
docs: update man pages for 23.0
knst Oct 28, 2025
28a0689
fix: fixup checkpoints in man
knst Oct 29, 2025
25ecd50
fix: follow-up for 6920 to update checkpoints for testnet in man pages
knst Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions doc/man/dash-cli.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-CLI "1" "February 2025" "dash-cli v22.1.0" "User Commands"
.TH DASH-CLI "1" "October 2025" "dash-cli v23.0.0" "User Commands"
.SH NAME
dash-cli \- manual page for dash-cli v22.1.0
dash-cli \- manual page for dash-cli v23.0.0
.SH SYNOPSIS
.B dash-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Dash Core\/\fR
Expand All @@ -15,7 +15,7 @@ dash-cli \- manual page for dash-cli v22.1.0
.B dash-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
Dash Core RPC client version v22.1.0
Dash Core RPC client version v23.0.0
.SH OPTIONS
.HP
\-?
Expand Down Expand Up @@ -45,8 +45,8 @@ Specify data directory
.HP
\fB\-generate\fR
.IP
Generate blocks immediately, equivalent to RPC getnewaddress followed by
RPC generatetoaddress. Optional positional integer arguments are
Generate blocks, equivalent to RPC getnewaddress 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
Expand All @@ -55,8 +55,8 @@ nblocks and maxtries arguments. Example: dash\-cli \fB\-generate\fR 4
\fB\-getinfo\fR
.IP
Get general information from the remote server. Note that unlike
server\-side RPC calls, the results of \fB\-getinfo\fR is the result of
multiple non\-atomic requests. Some entries in the result may
server\-side RPC calls, the output of \fB\-getinfo\fR is the result of
multiple non\-atomic requests. Some entries in the output may
represent results from different states (e.g. wallet balance may
be as of a different block from the chain state reported)
.HP
Expand Down Expand Up @@ -162,4 +162,4 @@ The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>
or <https://opensource.org/licenses/MIT>
74 changes: 44 additions & 30 deletions doc/man/dash-qt.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-QT "1" "February 2025" "dash-qt v22.1.0" "User Commands"
.TH DASH-QT "1" "October 2025" "dash-qt v23.0.0" "User Commands"
.SH NAME
dash-qt \- manual page for dash-qt v22.1.0
dash-qt \- manual page for dash-qt v23.0.0
.SH SYNOPSIS
.B dash-qt
[\fI\,command-line options\/\fR]
[\fI\,command-line options\/\fR] [\fI\,URI\/\fR]
.SH DESCRIPTION
Dash Core version v22.1.0
Dash Core version v23.0.0
.PP
Optional URI is a Dash address in BIP21 URI format.
.SH OPTIONS
.HP
\-?
Expand All @@ -23,15 +25,16 @@ message)
If this block is in the chain assume that it and its ancestors are valid
and potentially skip their script verification (0 to verify all,
default:
000000000000001cf26547602d982dcaa909231bbcd1e70c0eb3c65de25473ba,
0000000000000009ba1e8f47851d036bb618a4f6565eb3c32d1f647d450ff195,
testnet:
000000eef20eb0062abd4e799967e98bdebb165dd1c567ab4118c1c86c6e948f)
00000107d42829a38e31c1a38c660d621e1ca376a880df1520e85e38af175d3a)
.HP
\fB\-blockfilterindex=\fR<type>
.IP
Maintain an index of compact filters by block (default: 0, values:
basic). If <type> is not supplied or if <type> = 1, indexes for
all known types are enabled.
all known types are enabled. Automatically enabled for
masternodes with value 'basic'.
.HP
\fB\-blocknotify=\fR<cmd>
.IP
Expand Down Expand Up @@ -122,7 +125,12 @@ Do not keep transactions in the mempool longer than <n> hours (default:
.HP
\fB\-par=\fR<n>
.IP
Set the number of script verification threads (\fB\-16\fR to 15, 0 = auto, <0 =
Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-parbls=\fR<n>
.IP
Set the number of BLS verification threads (\fB\-24\fR to 33, 0 = auto, <0 =
leave that many cores free, default: 0)
Comment on lines +128 to 134
Copy link

@coderabbitai coderabbitai bot Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Hardcoded minimum value doesn't reflect dynamic implementation.

Same issue as in dashd.1: the documented ranges show -24 as the minimum for both -par and -parbls, but the implementation uses -GetNumCores() which varies per system.

Consider updating the documentation to indicate the minimum is dynamic (e.g., "-(number of CPU cores)") rather than the fixed "-24" value.

Based on past review comments.

🤖 Prompt for AI Agents 
In doc/man/dash-qt.1 around lines 128 to 134, the manpage shows a hardcoded
minimum value "-24" for the -par and -parbls options but the implementation uses
-GetNumCores() (dynamic per system); update the text to reflect a dynamic
minimum (for example, replace "-24" with "-(number of CPU cores)" or a phrasing
like "-(number of CPU cores)" and mention 0 = auto and <0 leaves that many cores
free) so the documented range matches the actual behavior.

.HP
Comment on lines +128 to 135
Copy link

@coderabbitai coderabbitai bot Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Check -par and -parbls ranges (GUI doc).

Same concern as dashd: confirm documented ranges align with v23 defaults.

🏁 Script executed:

#!/bin/bash
rg -n '^-par=|^-parbls=' doc/man/dash-qt.1

Length of output: 0

I need to view the actual file content to see the exact ranges documented. Let me search more broadly in the file:


Also, let me search for any references to these parameters more broadly:

🏁 Script executed:

#!/bin/bash
# View the specific lines in the man page file
sed -n '128,135p' doc/man/dash-qt.1

Length of output: 267

🏁 Script executed:

#!/bin/bash
# Search for parbls and par with broader context
rg -n 'parbls|par=' doc/man/dash-qt.1 -C2

Length of output: 292

Let me search the codebase to find the actual parameter definitions and their valid ranges:


Also, let me check the dashd man page for comparison:

🏁 Script executed:

#!/bin/bash
# Search for -par parameter definition in source code
rg -n '\-par|par\s*=' src/ --type=cpp --type=h -C3 | grep -i 'arg\|param\|range\|min\|max' -C2

Length of output: 7456

🏁 Script executed:

#!/bin/bash
# Check if dashd man page has similar parameters with ranges
if [ -f doc/man/dashd.1 ]; then
  rg -n 'parbls|par=' doc/man/dashd.1 -C3
fi

Length of output: 412

Update documented ranges to reflect dynamic core-based minimums.

The documented ranges in dash-qt.1 lines 128 and 133 hardcode -24 as the minimum, but the actual implementation in src/init.cpp uses -GetNumCores(), which varies per system. The maximums are correct (15 for -par, 33 for -parbls), but the minimums should be updated to accurately reflect that the lower bound is dynamic based on the number of CPU cores, not a fixed -24.

🤖 Prompt for AI Agents 
In doc/man/dash-qt.1 around lines 128–135, the minimum values for the -par and
-parbls options are hardcoded as "-24" but the implementation uses a dynamic
minimum of -GetNumCores(); update both occurrences to describe the dynamic
core-based minimum (e.g., "-(number of CPU cores)" or "-(number of cores on the
system)") instead of "-24", keep the rest of the sentence (0 = auto, <0 = leave
that many cores free, default: 0) and preserve the existing max values (15 for
-par, 33 for -parbls) and man formatting.

\fB\-persistmempool\fR
Expand Down Expand Up @@ -229,7 +237,7 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def
\fB\-dnsseed\fR
.IP
Query for peer addresses via DNS lookup, if low on addresses (default: 1
unless \fB\-connect\fR used)
unless \fB\-connect\fR used or \fB\-maxconnections\fR=\fI\,0\/\fR)
.HP
\fB\-externalip=\fR<ip>
.IP
Expand Down Expand Up @@ -257,7 +265,8 @@ none)
.HP
\fB\-listen\fR
.IP
Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
Accept connections from outside (default: 1 if no \fB\-proxy\fR, \fB\-connect\fR or
\fB\-maxconnections\fR=\fI\,0\/\fR)
.HP
\fB\-listenonion\fR
.IP
Expand Down Expand Up @@ -302,10 +311,11 @@ Use NAT\-PMP to map the listening port (default: 0)
Enable all P2P network activity (default: 1). Can be changed by the
setnetworkactive RPC command
.HP
\fB\-onion=\fR<ip:port>
\fB\-onion=\fR<ip:port|path>
.IP
Use separate SOCKS5 proxy to reach peers via Tor onion services, set
\fB\-noonion\fR to disable (default: \fB\-proxy\fR)
\fB\-noonion\fR to disable (default: \fB\-proxy\fR). May be a local file path
prefixed with 'unix:'.
.HP
\fB\-onlynet=\fR<net>
.IP
Expand All @@ -316,7 +326,8 @@ allow multiple networks.
.HP
\fB\-peerblockfilters\fR
.IP
Serve compact block filters to peers per BIP 157 (default: 0)
Serve compact block filters to peers per BIP 157 (default: 0,
automatically enabled for masternodes)
.HP
\fB\-peerbloomfilters\fR
.IP
Expand All @@ -329,20 +340,17 @@ Specify a p2p connection timeout delay in seconds. After connecting to a
peer, wait this amount of time before considering disconnection
based on inactivity (minimum: 1, default: 60)
.HP
\fB\-permitbaremultisig\fR
.IP
Relay non\-P2SH multisig (default: 1)
.HP
\fB\-port=\fR<port>
.IP
Listen for connections on <port>. 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:port>
\fB\-proxy=\fR<ip:port|path>
.IP
Connect through SOCKS5 proxy, set \fB\-noproxy\fR to disable (default:
disabled)
disabled). May be a local file path prefixed with 'unix:' if the
proxy supports it.
.HP
\fB\-proxyrandomize\fR
.IP
Expand Down Expand Up @@ -378,8 +386,7 @@ Tor control port password (default: empty)
.HP
\fB\-upnp\fR
.IP
Use UPnP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
Use UPnP to map the listening port (default: 0)
.HP
\fB\-v2transport\fR
.IP
Expand Down Expand Up @@ -484,10 +491,6 @@ Specify statsd host (default: )
Specify the number of seconds between periodic measurements (default:
60)
.HP
\fB\-statsport=\fR<port>
.IP
Specify statsd port (default: 8125)
.HP
\fB\-statsprefix=\fR<string>
.IP
Specify an optional string prepended to every stats key (default: )
Expand All @@ -509,6 +512,12 @@ 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\-consolidatefeerate=\fR<amt>
.IP
The maximum feerate (in DASH/kvB) at which transaction building may use
more inputs than strictly necessary so that the wallet's UTXO
pool can be reduced (default: 0.00001).
.HP
\fB\-createwalletbackups=\fR<n>
.IP
Number of automatic wallet backups (default: 10)
Expand Down Expand Up @@ -1014,6 +1023,10 @@ Maximum size of data in data carrier transactions we relay and mine
Fees (in DASH/kB) smaller than this are considered zero fee for
relaying, mining and transaction creation (default: 0.00001)
.HP
\fB\-permitbaremultisig\fR
.IP
Relay non\-P2SH multisig (default: 1)
.HP
\fB\-whitelistforcerelay\fR
.IP
Add 'forcerelay' permission to whitelisted inbound peers with default
Expand Down Expand Up @@ -1045,10 +1058,11 @@ Accept public REST requests (default: 0)
.HP
\fB\-rpcallowip=\fR<ip>
.IP
Allow JSON\-RPC connections from specified source. Valid for <ip> are a
single IP (e.g. 1.2.3.4), a network/netmask (e.g.
1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
option can be specified multiple times
Allow JSON\-RPC connections from specified source. Valid values for <ip>
are a single IP (e.g. 1.2.3.4), a network/netmask (e.g.
1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all
ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be
specified multiple times
.HP
\fB\-rpcauth=\fR<userpw>
.IP
Expand Down Expand Up @@ -1174,4 +1188,4 @@ The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>
or <https://opensource.org/licenses/MIT>
8 changes: 4 additions & 4 deletions doc/man/dash-tx.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-TX "1" "February 2025" "dash-tx v22.1.0" "User Commands"
.TH DASH-TX "1" "October 2025" "dash-tx v23.0.0" "User Commands"
.SH NAME
dash-tx \- manual page for dash-tx v22.1.0
dash-tx \- manual page for dash-tx v23.0.0
.SH SYNOPSIS
.B dash-tx
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded dash transaction\/\fR
.br
.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 v22.1.0
Dash Core dash\-tx utility version v23.0.0
.SH OPTIONS
.HP
\-?
Expand Down Expand Up @@ -119,4 +119,4 @@ The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>
or <https://opensource.org/licenses/MIT>
8 changes: 4 additions & 4 deletions doc/man/dash-wallet.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-WALLET "1" "February 2025" "dash-wallet v22.1.0" "User Commands"
.TH DASH-WALLET "1" "October 2025" "dash-wallet v23.0.0" "User Commands"
.SH NAME
dash-wallet \- manual page for dash-wallet v22.1.0
dash-wallet \- manual page for dash-wallet v23.0.0
.SH DESCRIPTION
Dash Core dash\-wallet version v22.1.0
Dash Core dash\-wallet version v23.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.
Expand Down Expand Up @@ -109,4 +109,4 @@ The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>
or <https://opensource.org/licenses/MIT>
Loading
Loading