Skip to content

Commit

Permalink
Merge dashpay#6554: docs: update man pages for 22.1
Browse files Browse the repository at this point in the history 
ff785ed docs: update man pages for 22.1 (Konstantin Akimov)

Pull request description:

  ## Issue being fixed or feature implemented
  dashpay#6551

  ## What was done?
  Updated man pages by new script `contrib/devtools/gen-manpages.py` see dashpay#6555

  ## How Has This Been Tested?
  N/A

  ## Breaking Changes
  N/A

  ## Checklist:
  - [ ] 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)_

ACKs for top commit:
  PastaPastaPasta:
    utACK ff785ed; diff looks good
  UdjinM6:
    utACK ff785ed

Tree-SHA512: 60a81c880e6ff824fc661dc6c6da20d85aa662fe228f7080dcb8c47db69c88adc30a40ab84832d83994ab56a26ed1de4d800dd45cd282c61233fde2d4e2212b7
  • Loading branch information
@PastaPastaPasta
PastaPastaPasta committed Feb 4, 2025
1 parent bc91a83 commit 4571d89
Show file tree
Hide file tree
Showing 5 changed files with 106 additions and 191 deletions.
69 changes: 17 additions & 52 deletions doc/man/dash-cli.1
View file
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
View file
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>
65 changes: 14 additions & 51 deletions doc/man/dash-tx.1
View file
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" "December 2024" "dash-tx v22.0.0" "User Commands"
.TH DASH-TX "1" "February 2025" "dash-tx v22.1.0" "User Commands"
.SH NAME
dash-tx \- manual page for dash-tx v22.0.0
dash-tx \- manual page for dash-tx v22.1.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.0.0
Dash Core dash\-tx utility version v22.1.0
.SH OPTIONS
.HP
\-?
Expand All @@ -32,8 +32,6 @@ Output only the hex\-encoded transaction id of the resultant transaction.
.IP
Print version and exit
.PP
Debugging/Testing options:
.PP
Chain selection options:
.HP
\fB\-chain=\fR<chain>
Expand All @@ -45,52 +43,6 @@ 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
Expand Down Expand Up @@ -157,3 +109,14 @@ Load JSON file FILENAME into register NAME
set=NAME:JSON\-STRING
.IP
Set register NAME to given JSON\-STRING
.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>
65 changes: 15 additions & 50 deletions doc/man/dash-wallet.1
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-WALLET "1" "December 2024" "dash-wallet v22.0.0" "User Commands"
.TH DASH-WALLET "1" "February 2025" "dash-wallet v22.1.0" "User Commands"
.SH NAME
dash-wallet \- manual page for dash-wallet v22.0.0
dash-wallet \- manual page for dash-wallet v22.1.0
.SH DESCRIPTION
Dash Core dash\-wallet version v22.0.0
Dash Core dash\-wallet version v22.1.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.
To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-testnet\fR/\-regtest arguments.
To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-regtest\fR/\-testnet arguments.
.SS "Usage:"
.IP
dash\-wallet [options] <command>
Expand Down Expand Up @@ -69,52 +69,6 @@ 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
Expand Down Expand Up @@ -145,3 +99,14 @@ Attempt to recover private keys from a corrupt wallet. Warning:
wipetxes
.IP
Wipe all transactions from a wallet
.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

0 comments on commit 4571d89

Please sign in to comment.