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

Merge #5920: docs: update manpages for 20.1

Browse Source 
e746c698fb docs: update manpages for 20.1 (UdjinM6)

Pull request description:

  ## Issue being fixed or feature implemented
  update man pages

  ## What was done?
  run `./contrib/devtools/gen-manpages.sh`, skip local-dependent changes

  ## How Has This Been Tested?

  ## Breaking Changes
  n/a

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

Top commit has no ACKs.

Tree-SHA512: 22bcd824fa391d044a9924c9135aca9ed346312cfcba7f74fda5e9ae1b5d5e33e405ba51a4ab2024f3b110d3bd303e4368a567ef6069eb2fc74e32adef81380f
This commit is contained in:
pasta 2024-03-04 09:58:36 -06:00
commit 149f72e651
No known key found for this signature in database
GPG Key ID: 52527BEDABE87984
5 changed files with 89 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
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" "November 2023" "dash-cli v20.0.0" "User Commands"
.TH DASH-CLI "1" "March 2024" "dash-cli v20.1.0" "User Commands"
.SH NAME
dash-cli \- manual page for dash-cli v20.0.0
dash-cli \- manual page for dash-cli v20.1.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 v20.0.0
.B dash-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
Dash Core RPC client version v20.0.0
Dash Core RPC client version v20.1.0
.SH OPTIONS
.HP
\-?
@ -33,12 +33,12 @@ Specify data directory
.HP
\fB\-generate\fR
.IP
Generate blocks immediately, equivalent to RPC generatenewaddress
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 1000
Generate blocks immediately, 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
1000
.HP
\fB\-getinfo\fR
.IP
@ -135,7 +135,8 @@ Use devnet chain with provided name
\fB\-highsubsidyblocks=\fR<n>
.IP
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet\-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet\-only)
.HP
\fB\-highsubsidyfactor=\fR<n>
.IP
@ -153,12 +154,6 @@ devnet\-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet\-only)
.HP
\fB\-llmqinstantsend=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default:

62
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" "November 2023" "dash-qt v20.0.0" "User Commands"
.TH DASH-QT "1" "March 2024" "dash-qt v20.1.0" "User Commands"
.SH NAME
dash-qt \- manual page for dash-qt v20.0.0
dash-qt \- manual page for dash-qt v20.1.0
.SH SYNOPSIS
.B dash-qt
[\fI\,command-line options\/\fR]
.SH DESCRIPTION
Dash Core version v20.0.0
Dash Core version v20.1.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:
00000000000000075300e852d5bf5380f905b2768241f8b442498442084807a7,
0000000000000020d5e38b6aef5bc8e430029444d7977b46f710c7d281ef1281,
testnet:
0000014d3b875540ff75517b7fbb1714e25d50ce92f65d7086cfce357928bb02)
0000000386cf5061ea16404c66deb83eb67892fa4f79b9e58e5eaab097ec2bd6)
.HP
\fB\-blockfilterindex=\fR<type>
.IP
@ -62,7 +62,7 @@ by chainlocked block hash)
.HP
\fB\-coinstatsindex\fR
.IP
Maintain coinstats index used by the gettxoutset RPC (default: 0)
Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0)
.HP
\fB\-conf=\fR<file>
.IP
@ -150,6 +150,10 @@ edited by users (use dash.conf instead for custom settings).
Relative paths will be prefixed by datadir location. (default:
settings.json)
.HP
\fB\-startupnotify=\fR<cmd>
.IP
Execute command on startup.
.HP
\fB\-syncmempool\fR
.IP
Sync mempool from other nodes on start (default: 1)
@ -305,9 +309,9 @@ Support filtering of blocks and transaction with bloom filters (default:
.HP
\fB\-peertimeout=\fR<n>
.IP
Specify p2p connection timeout in seconds. This option determines the
amount of time a peer may be inactive before the connection to it
is dropped. (minimum: 1, default: 60)
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
@ -343,7 +347,9 @@ FreeBSD/Apple \- 'kqueue', Windows \- 'select')
.HP
\fB\-timeout=\fR<n>
.IP
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
Specify socket connection timeout in milliseconds. If an initial attempt
to connect is unsuccessful after this amount of time, drop it
(minimum: 1, default: 5000)
.HP
\fB\-torcontrol=\fR<ip>:<port>
.IP
@ -356,7 +362,8 @@ Tor control port password (default: empty)
.HP
\fB\-upnp\fR
.IP
Use UPnP to map the listening port (default: 0)
Use UPnP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
.HP
\fB\-whitebind=\fR<[permissions@]addr>
.IP
@ -557,12 +564,12 @@ insufficient data. 0 to entirely disable the fallbackfee feature.
.HP
\fB\-mintxfee=\fR<amt>
.IP
Fees (in DASH/kB) smaller than this are considered zero fee for
Fee rates (in DASH/kB) smaller than this are considered zero fee for
transaction creation (default: 0.00001)
.HP
\fB\-paytxfee=\fR<amt>
.IP
Fee (in DASH/kB) to add to transactions you send (default: 0.00)
Fee rate (in DASH/kB) to add to transactions you send (default: 0.00)
.HP
\fB\-txconfirmtarget=\fR<n>
.IP
@ -595,7 +602,7 @@ during wallet creation/first start (default: empty string)
\fB\-usehd\fR
.IP
Use hierarchical deterministic key generation (HD) after BIP39/BIP44.
Only has effect during wallet creation/first start (default: 0)
Only has effect during wallet creation/first start (default: 1)
.PP
CoinJoin options:
.HP
@ -809,18 +816,20 @@ Debugging/Testing options:
.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: net, tor,
mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman,
selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej,
libevent, coindb, qt, leveldb, validation, i2p, chainlocks,
gobject, instantsend, llmq, llmq\-dkg, llmq\-sigs, mnpayments,
mnsync, coinjoin, spork, netconn.
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, 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.
.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 one
or more specified categories.
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.
.HP
\fB\-disablegovernance\fR
.IP
@ -889,7 +898,8 @@ Use devnet chain with provided name
\fB\-highsubsidyblocks=\fR<n>
.IP
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet\-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet\-only)
.HP
\fB\-highsubsidyfactor=\fR<n>
.IP
@ -907,12 +917,6 @@ devnet\-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet\-only)
.HP
\fB\-llmqinstantsend=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default:

15
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" "November 2023" "dash-tx v20.0.0" "User Commands"
.TH DASH-TX "1" "March 2024" "dash-tx v20.1.0" "User Commands"
.SH NAME
dash-tx \- manual page for dash-tx v20.0.0
dash-tx \- manual page for dash-tx v20.1.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 v20.0.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.0.0
Dash Core dash\-tx utility version v20.1.0
.SH OPTIONS
.HP
\-?
@ -46,7 +46,8 @@ Use devnet chain with provided name
\fB\-highsubsidyblocks=\fR<n>
.IP
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet\-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet\-only)
.HP
\fB\-highsubsidyfactor=\fR<n>
.IP
@ -64,12 +65,6 @@ devnet\-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet\-only)
.HP
\fB\-llmqinstantsend=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default:

15
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" "November 2023" "dash-wallet v20.0.0" "User Commands"
.TH DASH-WALLET "1" "March 2024" "dash-wallet v20.1.0" "User Commands"
.SH NAME
dash-wallet \- manual page for dash-wallet v20.0.0
dash-wallet \- manual page for dash-wallet v20.1.0
.SH DESCRIPTION
Dash Core dash\-wallet version v20.0.0
Dash Core dash\-wallet version v20.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.
@ -54,7 +54,8 @@ Use devnet chain with provided name
\fB\-highsubsidyblocks=\fR<n>
.IP
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet\-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet\-only)
.HP
\fB\-highsubsidyfactor=\fR<n>
.IP
@ -72,12 +73,6 @@ devnet\-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet\-only)
.HP
\fB\-llmqinstantsend=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default:

66
doc/man/dashd.1
View File

@ -1,14 +1,14 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASHD "1" "November 2023" "dashd v20.0.0" "User Commands"
.TH DASHD "1" "March 2024" "dashd v20.1.0" "User Commands"
.SH NAME
dashd \- manual page for dashd v20.0.0
dashd \- manual page for dashd v20.1.0
.SH SYNOPSIS
.B dashd
[\fI\,options\/\fR] \fI\,Start Dash Core\/\fR
.SH DESCRIPTION
Dash Core version v20.0.0
Copyright \(co 2014\-2023 The Dash Core developers
Copyright \(co 2009\-2023 The Bitcoin Core developers
Dash Core version v20.1.0
Copyright \(co 2014\-2024 The Dash Core developers
Copyright \(co 2009\-2024 The Bitcoin Core developers
.PP
Please contribute if you find Dash Core useful. Visit <https://dash.org/> for
further information about the software.
@ -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:
00000000000000075300e852d5bf5380f905b2768241f8b442498442084807a7,
0000000000000020d5e38b6aef5bc8e430029444d7977b46f710c7d281ef1281,
testnet:
0000014d3b875540ff75517b7fbb1714e25d50ce92f65d7086cfce357928bb02)
0000000386cf5061ea16404c66deb83eb67892fa4f79b9e58e5eaab097ec2bd6)
.HP
\fB\-blockfilterindex=\fR<type>
.IP
@ -72,7 +72,7 @@ by chainlocked block hash)
.HP
\fB\-coinstatsindex\fR
.IP
Maintain coinstats index used by the gettxoutset RPC (default: 0)
Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0)
.HP
\fB\-conf=\fR<file>
.IP
@ -160,6 +160,10 @@ edited by users (use dash.conf instead for custom settings).
Relative paths will be prefixed by datadir location. (default:
settings.json)
.HP
\fB\-startupnotify=\fR<cmd>
.IP
Execute command on startup.
.HP
\fB\-syncmempool\fR
.IP
Sync mempool from other nodes on start (default: 1)
@ -315,9 +319,9 @@ Support filtering of blocks and transaction with bloom filters (default:
.HP
\fB\-peertimeout=\fR<n>
.IP
Specify p2p connection timeout in seconds. This option determines the
amount of time a peer may be inactive before the connection to it
is dropped. (minimum: 1, default: 60)
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
@ -353,7 +357,9 @@ FreeBSD/Apple \- 'kqueue', Windows \- 'select')
.HP
\fB\-timeout=\fR<n>
.IP
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
Specify socket connection timeout in milliseconds. If an initial attempt
to connect is unsuccessful after this amount of time, drop it
(minimum: 1, default: 5000)
.HP
\fB\-torcontrol=\fR<ip>:<port>
.IP
@ -366,7 +372,8 @@ Tor control port password (default: empty)
.HP
\fB\-upnp\fR
.IP
Use UPnP to map the listening port (default: 0)
Use UPnP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
.HP
\fB\-whitebind=\fR<[permissions@]addr>
.IP
@ -567,12 +574,12 @@ insufficient data. 0 to entirely disable the fallbackfee feature.
.HP
\fB\-mintxfee=\fR<amt>
.IP
Fees (in DASH/kB) smaller than this are considered zero fee for
Fee rates (in DASH/kB) smaller than this are considered zero fee for
transaction creation (default: 0.00001)
.HP
\fB\-paytxfee=\fR<amt>
.IP
Fee (in DASH/kB) to add to transactions you send (default: 0.00)
Fee rate (in DASH/kB) to add to transactions you send (default: 0.00)
.HP
\fB\-txconfirmtarget=\fR<n>
.IP
@ -605,7 +612,7 @@ during wallet creation/first start (default: empty string)
\fB\-usehd\fR
.IP
Use hierarchical deterministic key generation (HD) after BIP39/BIP44.
Only has effect during wallet creation/first start (default: 0)
Only has effect during wallet creation/first start (default: 1)
.PP
CoinJoin options:
.HP
@ -819,18 +826,20 @@ Debugging/Testing options:
.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: net, tor,
mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman,
selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej,
libevent, coindb, qt, leveldb, validation, i2p, chainlocks,
gobject, instantsend, llmq, llmq\-dkg, llmq\-sigs, mnpayments,
mnsync, coinjoin, spork, netconn.
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, 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.
.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 one
or more specified categories.
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.
.HP
\fB\-disablegovernance\fR
.IP
@ -899,7 +908,8 @@ Use devnet chain with provided name
\fB\-highsubsidyblocks=\fR<n>
.IP
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet\-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet\-only)
.HP
\fB\-highsubsidyfactor=\fR<n>
.IP
@ -917,12 +927,6 @@ devnet\-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet\-only)
.HP
\fB\-llmqinstantsend=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default: