sikkienl/dash
1
0
Fork 0
mirror of https://github.com/dashpay/dash.git synced 2024-12-24 19:42:46 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge #6464: chore: update man pages for v22

Browse Source 
2dabd78956 chore: update man pages for v22 (UdjinM6)

Pull request description:

  ## Issue being fixed or feature implemented

  ## What was done?

  ## How Has This Been Tested?

  ## Breaking Changes

  ## 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
  - [ ] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  PastaPastaPasta:
    utACK 2dabd78956
  knst:
    utACK 2dabd78956

Tree-SHA512: fc03af689e9c5be54f150d6727772038c70e1fafad0f450b431203aa0e662873e17095e702c8d970eafdd92e386bb471d7894ba51bb72b166fadefabdfaad116
This commit is contained in:
pasta 2024-12-10 09:25:40 -06:00
commit 11e020bb12
No known key found for this signature in database
GPG Key ID: E2F3D7916E722D38
5 changed files with 131 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/man/dash-cli.1
View File

@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-CLI "1" "August 2024" "dash-cli v21.1.0" "User Commands"
.TH DASH-CLI "1" "December 2024" "dash-cli v22.0.0" "User Commands"
.SH NAME
dash-cli \- manual page for dash-cli v21.1.0
dash-cli \- manual page for dash-cli v22.0.0
.SH SYNOPSIS
.B dash-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Dash Core\/\fR
@ -15,7 +15,7 @@ dash-cli \- manual page for dash-cli v21.1.0
.B dash-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
Dash Core RPC client version v21.1.0
Dash Core RPC client version v22.0.0
.SH OPTIONS
.HP
\-?
@ -136,6 +136,8 @@ for the wallet passphrase.
.IP
Print version and exit
.PP
Debugging/Testing options:
.PP
Chain selection options:
.HP
\fB\-chain=\fR<chain>

97
doc/man/dash-qt.1
View File

@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-QT "1" "August 2024" "dash-qt v21.1.0" "User Commands"
.TH DASH-QT "1" "December 2024" "dash-qt v22.0.0" "User Commands"
.SH NAME
dash-qt \- manual page for dash-qt v21.1.0
dash-qt \- manual page for dash-qt v22.0.0
.SH SYNOPSIS
.B dash-qt
[\fI\,command-line options\/\fR]
.SH DESCRIPTION
Dash Core version v21.1.0
Dash Core version v22.0.0
.SH OPTIONS
.HP
\-?
@ -23,9 +23,9 @@ 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:
000000000000001889bd33ef019065e250d32bd46911f4003d3fdd8128b5358d,
000000000000001cf26547602d982dcaa909231bbcd1e70c0eb3c65de25473ba,
testnet:
00000034bfeb926662ba547c0b8dd4ba8cbb6e0c581f4e7d1bddce8f9ca3a608)
000000eef20eb0062abd4e799967e98bdebb165dd1c567ab4118c1c86c6e948f)
.HP
\fB\-blockfilterindex=\fR<type>
.IP
@ -140,12 +140,11 @@ 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\-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)
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)
.HP
\fB\-settings=\fR<file>
.IP
@ -277,7 +276,8 @@ Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
.HP
\fB\-maxsendbuffer=\fR<n>
.IP
Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
Maximum per\-connection memory usage for the send buffer, <n>*1000 bytes
(default: 1000)
.HP
\fB\-maxtimeadjustment\fR
.IP
@ -287,9 +287,11 @@ amount. (default: 4200 seconds)
.HP
\fB\-maxuploadtarget=\fR<n>
.IP
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)
Tries to keep outbound traffic under the given target per 24h. Limit
does not apply to peers with 'download' permission or blocks
created within past week. 0 = no limit (default: 0M). Optional
suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000
base while uppercase is 1024 base
.HP
\fB\-natpmp\fR
.IP
@ -379,6 +381,10 @@ Tor control port password (default: empty)
Use UPnP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
.HP
\fB\-v2transport\fR
.IP
Support v2 transport (default: 0)
.HP
\fB\-whitebind=\fR<[permissions@]addr>
.IP
Bind to the given address and add permission flags to the peers
@ -410,13 +416,14 @@ unspent outputs for addresses (default: 0)
.HP
\fB\-reindex\fR
.IP
Rebuild chain state and block index from the blk*.dat files on disk
Rebuild chain state and block index from the blk*.dat files on disk.
This will also rebuild active optional indexes.
.HP
\fB\-reindex\-chainstate\fR
.IP
Rebuild chain state from the currently indexed blocks. When in pruning
mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR
instead.
instead. Deactivate all optional indexes before running this.
.HP
\fB\-spentindex\fR
.IP
@ -435,6 +442,11 @@ call (default: 1)
.PP
Masternode options:
.HP
\fB\-deprecated\-platform\-user=\fR<user>
.IP
Set the username for the "platform user", a restricted user intended to
be used by Dash Platform, to the specified username.
.HP
\fB\-llmq\-data\-recovery=\fR<n>
.IP
Enable automated quorum data recovery (default: 1)
@ -451,29 +463,21 @@ defined by <quorum_name> if a member of any of the quorums)
.IP
Set the masternode BLS private key and enable the client to act as a
masternode
.HP
\fB\-platform\-user=\fR<user>
.IP
Set the username for the "platform user", a restricted user intended to
be used by Dash Platform, to the specified username.
.PP
Statsd options:
.HP
\fB\-statsenabled\fR
\fB\-statsbatchsize=\fR<bytes>
.IP
Publish internal stats to statsd (default: 0)
Specify the size of each batch of stats messages (default: 1024)
.HP
\fB\-statsduration=\fR<ms>
.IP
Specify the number of milliseconds between stats messages (default:
1000)
.HP
\fB\-statshost=\fR<ip>
.IP
Specify statsd host (default: 127.0.0.1)
.HP
\fB\-statshostname=\fR<ip>
.IP
Specify statsd host name (default: )
.HP
\fB\-statsns=\fR<ns>
.IP
Specify additional namespace prefix (default: )
Specify statsd host (default: )
.HP
\fB\-statsperiod=\fR<seconds>
.IP
@ -483,6 +487,14 @@ Specify the number of seconds between periodic measurements (default:
\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: )
.HP
\fB\-statssuffix=\fR<string>
.IP
Specify an optional string appended to every stats key (default: )
.PP
Wallet options:
.HP
@ -831,6 +843,14 @@ Enable publish raw transaction (locked via InstantSend) and ISLOCK in
.IP
Set publish raw transaction lock signature outbound message high water
mark (default: 1000)
.HP
\fB\-zmqpubsequence=\fR<address>
.IP
Enable publish hash block and tx sequence in <address>
.HP
\fB\-zmqpubsequencehwm=\fR<n>
.IP
Set publish hash sequence message high water mark (default: 1000)
.PP
Debugging/Testing options:
.HP
@ -840,11 +860,12 @@ 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, leveldb, libevent,
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.
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

8
doc/man/dash-tx.1
View File

@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-TX "1" "August 2024" "dash-tx v21.1.0" "User Commands"
.TH DASH-TX "1" "December 2024" "dash-tx v22.0.0" "User Commands"
.SH NAME
dash-tx \- manual page for dash-tx v21.1.0
dash-tx \- manual page for dash-tx v22.0.0
.SH SYNOPSIS
.B dash-tx
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded dash transaction\/\fR
@ -9,7 +9,7 @@ dash-tx \- manual page for dash-tx v21.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 v21.1.0
Dash Core dash\-tx utility version v22.0.0
.SH OPTIONS
.HP
\-?
@ -32,6 +32,8 @@ 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>

6
doc/man/dash-wallet.1
View File

@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-WALLET "1" "August 2024" "dash-wallet v21.1.0" "User Commands"
.TH DASH-WALLET "1" "December 2024" "dash-wallet v22.0.0" "User Commands"
.SH NAME
dash-wallet \- manual page for dash-wallet v21.1.0
dash-wallet \- manual page for dash-wallet v22.0.0
.SH DESCRIPTION
Dash Core dash\-wallet version v21.1.0
Dash Core dash\-wallet version v22.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.

97
doc/man/dashd.1
View File

@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASHD "1" "August 2024" "dashd v21.1.0" "User Commands"
.TH DASHD "1" "December 2024" "dashd v22.0.0" "User Commands"
.SH NAME
dashd \- manual page for dashd v21.1.0
dashd \- manual page for dashd v22.0.0
.SH SYNOPSIS
.B dashd
[\fI\,options\/\fR] \fI\,Start Dash Core\/\fR
.SH DESCRIPTION
Dash Core version v21.1.0
Dash Core version v22.0.0
Copyright \(co 2014\-2024 The Dash Core developers
Copyright \(co 2009\-2024 The Bitcoin Core developers
.PP
@ -33,9 +33,9 @@ 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:
000000000000001889bd33ef019065e250d32bd46911f4003d3fdd8128b5358d,
000000000000001cf26547602d982dcaa909231bbcd1e70c0eb3c65de25473ba,
testnet:
00000034bfeb926662ba547c0b8dd4ba8cbb6e0c581f4e7d1bddce8f9ca3a608)
000000eef20eb0062abd4e799967e98bdebb165dd1c567ab4118c1c86c6e948f)
.HP
\fB\-blockfilterindex=\fR<type>
.IP
@ -150,12 +150,11 @@ 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\-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)
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)
.HP
\fB\-settings=\fR<file>
.IP
@ -287,7 +286,8 @@ Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
.HP
\fB\-maxsendbuffer=\fR<n>
.IP
Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
Maximum per\-connection memory usage for the send buffer, <n>*1000 bytes
(default: 1000)
.HP
\fB\-maxtimeadjustment\fR
.IP
@ -297,9 +297,11 @@ amount. (default: 4200 seconds)
.HP
\fB\-maxuploadtarget=\fR<n>
.IP
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)
Tries to keep outbound traffic under the given target per 24h. Limit
does not apply to peers with 'download' permission or blocks
created within past week. 0 = no limit (default: 0M). Optional
suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000
base while uppercase is 1024 base
.HP
\fB\-natpmp\fR
.IP
@ -389,6 +391,10 @@ Tor control port password (default: empty)
Use UPnP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
.HP
\fB\-v2transport\fR
.IP
Support v2 transport (default: 0)
.HP
\fB\-whitebind=\fR<[permissions@]addr>
.IP
Bind to the given address and add permission flags to the peers
@ -420,13 +426,14 @@ unspent outputs for addresses (default: 0)
.HP
\fB\-reindex\fR
.IP
Rebuild chain state and block index from the blk*.dat files on disk
Rebuild chain state and block index from the blk*.dat files on disk.
This will also rebuild active optional indexes.
.HP
\fB\-reindex\-chainstate\fR
.IP
Rebuild chain state from the currently indexed blocks. When in pruning
mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR
instead.
instead. Deactivate all optional indexes before running this.
.HP
\fB\-spentindex\fR
.IP
@ -445,6 +452,11 @@ call (default: 1)
.PP
Masternode options:
.HP
\fB\-deprecated\-platform\-user=\fR<user>
.IP
Set the username for the "platform user", a restricted user intended to
be used by Dash Platform, to the specified username.
.HP
\fB\-llmq\-data\-recovery=\fR<n>
.IP
Enable automated quorum data recovery (default: 1)
@ -461,29 +473,21 @@ defined by <quorum_name> if a member of any of the quorums)
.IP
Set the masternode BLS private key and enable the client to act as a
masternode
.HP
\fB\-platform\-user=\fR<user>
.IP
Set the username for the "platform user", a restricted user intended to
be used by Dash Platform, to the specified username.
.PP
Statsd options:
.HP
\fB\-statsenabled\fR
\fB\-statsbatchsize=\fR<bytes>
.IP
Publish internal stats to statsd (default: 0)
Specify the size of each batch of stats messages (default: 1024)
.HP
\fB\-statsduration=\fR<ms>
.IP
Specify the number of milliseconds between stats messages (default:
1000)
.HP
\fB\-statshost=\fR<ip>
.IP
Specify statsd host (default: 127.0.0.1)
.HP
\fB\-statshostname=\fR<ip>
.IP
Specify statsd host name (default: )
.HP
\fB\-statsns=\fR<ns>
.IP
Specify additional namespace prefix (default: )
Specify statsd host (default: )
.HP
\fB\-statsperiod=\fR<seconds>
.IP
@ -493,6 +497,14 @@ Specify the number of seconds between periodic measurements (default:
\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: )
.HP
\fB\-statssuffix=\fR<string>
.IP
Specify an optional string appended to every stats key (default: )
.PP
Wallet options:
.HP
@ -841,6 +853,14 @@ Enable publish raw transaction (locked via InstantSend) and ISLOCK in
.IP
Set publish raw transaction lock signature outbound message high water
mark (default: 1000)
.HP
\fB\-zmqpubsequence=\fR<address>
.IP
Enable publish hash block and tx sequence in <address>
.HP
\fB\-zmqpubsequencehwm=\fR<n>
.IP
Set publish hash sequence message high water mark (default: 1000)
.PP
Debugging/Testing options:
.HP
@ -850,11 +870,12 @@ 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, leveldb, libevent,
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.
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