Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Version | Supported |
| ------- | ------------------ |
| 22 | :white_check_mark: |
| 22.x | :white_check_mark: |
| < 22 | :x: |

## Reporting a Vulnerability
Expand Down
4 changes: 2 additions & 2 deletions contrib/devtools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ year rather than two hyphenated years.
If the file already has a copyright for `The Dash Core developers`, the
script will exit.

gen-manpages.sh
gen-manpages.py
===============

A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option.
Expand All @@ -87,7 +87,7 @@ repository. To use this tool with out-of-tree builds set `BUILDDIR`. For
example:

```bash
BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh
BUILDDIR=$PWD/build contrib/devtools/gen-manpages.py
```

github-merge.py
Expand Down
73 changes: 73 additions & 0 deletions contrib/devtools/gen-manpages.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
#!/usr/bin/env python3
# Copyright (c) 2022 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
import os
import subprocess
import sys
import tempfile

BINARIES = [
'src/dashd',
'src/dash-cli',
'src/dash-tx',
'src/dash-wallet',
#'src/dash-util',
'src/qt/dash-qt',
]

# Paths to external utilities.
git = os.getenv('GIT', 'git')
help2man = os.getenv('HELP2MAN', 'help2man')

# If not otherwise specified, get top directory from git.
topdir = os.getenv('TOPDIR')
if not topdir:
r = subprocess.run([git, 'rev-parse', '--show-toplevel'], stdout=subprocess.PIPE, check=True, universal_newlines=True)
topdir = r.stdout.rstrip()

# Get input and output directories.
builddir = os.getenv('BUILDDIR', topdir)
mandir = os.getenv('MANDIR', os.path.join(topdir, 'doc/man'))

# Verify that all the required binaries are usable, and extract copyright
# message in a first pass.
copyright = None
versions = []
for relpath in BINARIES:
abspath = os.path.join(builddir, relpath)
try:
r = subprocess.run([abspath, '--version'], stdout=subprocess.PIPE, universal_newlines=True)
except IOError:
print(f'{abspath} not found or not an executable', file=sys.stderr)
sys.exit(1)
# take first line (which must contain version)
verstr = r.stdout.split('\n')[0]
# last word of line is the actual version e.g. v22.99.0-5c6b3d5b3508
verstr = verstr.split()[-1]
assert verstr.startswith('v')

# Only dash-qt prints the copyright message on --version, so store it specifically.
if relpath == 'src/qt/dash-qt':
copyright = r.stdout.split('\n')[1:]

versions.append((abspath, verstr))

if any(verstr.endswith('-dirty') for (_, verstr) in versions):
print("WARNING: Binaries were built from a dirty tree.")
print('man pages generated from dirty binaries should NOT be committed.')
print('To properly generate man pages, please commit your changes (or discard them), rebuild, then run this script again.')
print()

with tempfile.NamedTemporaryFile('w', suffix='.h2m') as footer:
# Create copyright footer, and write it to a temporary include file.
assert copyright
footer.write('[COPYRIGHT]\n')
footer.write('\n'.join(copyright).strip())
footer.flush()

# Call the binaries through help2man to produce a manual page for each of them.
for (abspath, verstr) in versions:
outname = os.path.join(mandir, os.path.basename(abspath) + '.1')
print(f'Generating {outname}…')
subprocess.run([help2man, '-N', '--version-string=' + verstr, '--include=' + footer.name, '-o', outname, abspath], check=True)
52 changes: 0 additions & 52 deletions contrib/devtools/gen-manpages.sh

This file was deleted.

69 changes: 17 additions & 52 deletions doc/man/dash-cli.1
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" "December 2024" "dash-cli v22.0.0" "User Commands"
.TH DASH-CLI "1" "February 2025" "dash-cli v22.1.0" "User Commands"
.SH NAME
dash-cli \- manual page for dash-cli v22.0.0
dash-cli \- manual page for dash-cli v22.1.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.0.0
.B dash-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
Dash Core RPC client version v22.0.0
Dash Core RPC client version v22.1.0
.SH OPTIONS
.HP
\-?
Expand All @@ -24,7 +24,9 @@ Print this help message and exit
.HP
\fB\-addrinfo\fR
.IP
Get the number of addresses known to the node, per network and total.
Get the number of addresses known to the node, per network and total,
after filtering for quality and recency. The total number of
addresses known to the node may be higher.
.HP
\fB\-color=\fR<when>
.IP
Expand Down Expand Up @@ -136,8 +138,6 @@ for the wallet passphrase.
.IP
Print version and exit
.PP
Debugging/Testing options:
.PP
Chain selection options:
.HP
\fB\-chain=\fR<chain>
Expand All @@ -149,52 +149,17 @@ regtest
.IP
Use devnet chain with provided name
.HP
\fB\-highsubsidyblocks=\fR<n>
.IP
The number of blocks with a higher than normal subsidy to mine at the
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet\-only)
.HP
\fB\-highsubsidyfactor=\fR<n>
.IP
The factor to multiply the normal block subsidy by while in the
highsubsidyblocks window of a chain (default: 1, devnet\-only)
.HP
\fB\-llmqchainlocks=\fR<quorum name>
.IP
Override the default LLMQ type used for ChainLocks. Allows using
ChainLocks with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqdevnetparams=\fR<size>:<threshold>
.IP
Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default:
llmq_devnet_dip0024, devnet\-only)
.HP
\fB\-llmqmnhf=\fR<quorum name>
.IP
Override the default LLMQ type used for EHF. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqplatform=\fR<quorum name>
.IP
Override the default LLMQ type used for Platform. (default:
llmq_devnet_platform, devnet\-only)
.HP
\fB\-minimumdifficultyblocks=\fR<n>
.IP
The number of blocks that can be mined with the minimum difficulty at
the start of a chain (default: 0, devnet\-only)
.HP
\fB\-powtargetspacing=\fR<n>
.IP
Override the default PowTargetSpacing value in seconds (default: 2.5
minutes, devnet\-only)
.HP
\fB\-testnet\fR
.IP
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR
.SH COPYRIGHT
Copyright (C) 2014-2025 The Dash Core developers
Copyright (C) 2009-2025 The Bitcoin Core developers

Please contribute if you find Dash Core useful. Visit <https://dash.org/> for
further information about the software.
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>
47 changes: 29 additions & 18 deletions doc/man/dash-qt.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-QT "1" "December 2024" "dash-qt v22.0.0" "User Commands"
.TH DASH-QT "1" "February 2025" "dash-qt v22.1.0" "User Commands"
.SH NAME
dash-qt \- manual page for dash-qt v22.0.0
dash-qt \- manual page for dash-qt v22.1.0
.SH SYNOPSIS
.B dash-qt
[\fI\,command-line options\/\fR]
.SH DESCRIPTION
Dash Core version v22.0.0
Dash Core version v22.1.0
.SH OPTIONS
.HP
\-?
Expand Down Expand Up @@ -282,8 +282,8 @@ Maximum per\-connection memory usage for the send buffer, <n>*1000 bytes
\fB\-maxtimeadjustment\fR
.IP
Maximum allowed median peer time offset adjustment. Local perspective of
time may be influenced by peers forward or backward by this
amount. (default: 4200 seconds)
time may be influenced by outbound peers forward or backward by
this amount (default: 4200 seconds).
.HP
\fB\-maxuploadtarget=\fR<n>
.IP
Expand Down Expand Up @@ -383,7 +383,7 @@ Use UPnP to map the listening port (default: 1 when listening and no
.HP
\fB\-v2transport\fR
.IP
Support v2 transport (default: 0)
Support v2 transport (default: 1)
.HP
\fB\-whitebind=\fR<[permissions@]addr>
.IP
Expand Down Expand Up @@ -856,23 +856,23 @@ Debugging/Testing options:
.HP
\fB\-debug=\fR<category>
.IP
Output debugging information (default: \fB\-nodebug\fR, supplying <category> is
optional). If <category> is not supplied or if <category> = 1,
output all debugging information. <category> can be: addrman,
bench, chainlocks, cmpctblock, coindb, coinjoin, creditpool, ehf,
estimatefee, gobject, http, i2p, instantsend, ipc, leveldb,
libevent, llmq, llmq\-dkg, llmq\-sigs, lock, mempool, mempoolrej,
mnpayments, mnsync, net, netconn, proxy, prune, qt, rand,
reindex, rpc, selectcoins, spork, tor, txreconciliation,
Output debug and trace logging (default: \fB\-nodebug\fR, supplying <category>
is optional). If <category> is not supplied or if <category> = 1,
output all debug and trace logging. <category> can be: addrman,
bench, blockstorage, chainlocks, cmpctblock, coindb, coinjoin,
creditpool, ehf, estimatefee, gobject, http, i2p, instantsend,
ipc, leveldb, libevent, llmq, llmq\-dkg, llmq\-sigs, lock, mempool,
mempoolrej, mnpayments, mnsync, net, netconn, proxy, prune, qt,
rand, reindex, rpc, selectcoins, spork, tor, txreconciliation,
validation, walletdb, zmq. This option can be specified multiple
times to output multiple categories.
.HP
\fB\-debugexclude=\fR<category>
.IP
Exclude debugging information for a category. Can be used in conjunction
with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except the
specified category. This option can be specified multiple times
to exclude multiple categories.
Exclude debug and trace logging for a category. Can be used in
conjunction with \fB\-debug\fR=\fI\,1\/\fR to output debug and trace logging for
all categories except the specified category. This option can be
specified multiple times to exclude multiple categories.
.HP
\fB\-disablegovernance\fR
.IP
Expand Down Expand Up @@ -1164,3 +1164,14 @@ Show splash screen on startup (default: 1)
\fB\-windowtitle=\fR<name>
.IP
Sets a window title which is appended to "Dash Core \- "
.SH COPYRIGHT
Copyright (C) 2014-2025 The Dash Core developers
Copyright (C) 2009-2025 The Bitcoin Core developers

Please contribute if you find Dash Core useful. Visit <https://dash.org/> for
further information about the software.
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>
Loading
Loading