Skip to content

Commit

Permalink
Merge #5920: docs: update manpages for 20.1
Browse files Browse the repository at this point in the history
e746c69 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
  • Loading branch information
PastaPastaPasta committed Mar 4, 2024
2 parents 39c1778 + e746c69 commit 149f72e
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 96 deletions.
27 changes: 11 additions & 16 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" "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
Expand All @@ -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
\-?
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down
62 changes: 33 additions & 29 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" "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
\-?
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down
15 changes: 5 additions & 10 deletions doc/man/dash-tx.1
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" "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
.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 v20.0.0
Dash Core dash\-tx utility version v20.1.0
.SH OPTIONS
.HP
\-?
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down
15 changes: 5 additions & 10 deletions doc/man/dash-wallet.1
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" "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.
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down
Loading

0 comments on commit 149f72e

Please sign in to comment.