mirror of
https://github.com/dashpay/dash.git
synced 2024-12-25 03:52:49 +01:00
d7cd9f10fd
2dabd78956chore: 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: utACK2dabd78956knst: utACK2dabd78956Tree-SHA512: fc03af689e9c5be54f150d6727772038c70e1fafad0f450b431203aa0e662873e17095e702c8d970eafdd92e386bb471d7894ba51bb72b166fadefabdfaad116
201 lines
5.7 KiB
Groff
201 lines
5.7 KiB
Groff
.\" 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"
|
|
.SH NAME
|
|
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
|
|
.br
|
|
.B dash-cli
|
|
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Dash Core (with named arguments)\/\fR
|
|
.br
|
|
.B dash-cli
|
|
[\fI\,options\/\fR] \fI\,help List commands\/\fR
|
|
.br
|
|
.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
|
|
.SH OPTIONS
|
|
.HP
|
|
\-?
|
|
.IP
|
|
Print this help message and exit
|
|
.HP
|
|
\fB\-addrinfo\fR
|
|
.IP
|
|
Get the number of addresses known to the node, per network and total.
|
|
.HP
|
|
\fB\-color=\fR<when>
|
|
.IP
|
|
Color setting for CLI output (default: auto). Valid values: always, auto
|
|
(add color codes when standard output is connected to a terminal
|
|
and OS is not WIN32), never.
|
|
.HP
|
|
\fB\-conf=\fR<file>
|
|
.IP
|
|
Specify configuration file. Relative paths will be prefixed by datadir
|
|
location. (default: dash.conf)
|
|
.HP
|
|
\fB\-datadir=\fR<dir>
|
|
.IP
|
|
Specify data directory
|
|
.HP
|
|
\fB\-generate\fR
|
|
.IP
|
|
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
|
|
Get general information from the remote server. Note that unlike
|
|
server\-side RPC calls, the results of \fB\-getinfo\fR is the result of
|
|
multiple non\-atomic requests. Some entries in the result may
|
|
represent results from different states (e.g. wallet balance may
|
|
be as of a different block from the chain state reported)
|
|
.HP
|
|
\fB\-named\fR
|
|
.IP
|
|
Pass named instead of positional arguments (default: false)
|
|
.HP
|
|
\fB\-netinfo\fR
|
|
.IP
|
|
Get network peer connection information from the remote server. An
|
|
optional integer argument from 0 to 4 can be passed for different
|
|
peers listings (default: 0). Pass "help" for detailed help
|
|
documentation.
|
|
.HP
|
|
\fB\-rpcclienttimeout=\fR<n>
|
|
.IP
|
|
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
|
|
900)
|
|
.HP
|
|
\fB\-rpcconnect=\fR<ip>
|
|
.IP
|
|
Send commands to node running on <ip> (default: 127.0.0.1)
|
|
.HP
|
|
\fB\-rpccookiefile=\fR<loc>
|
|
.IP
|
|
Location of the auth cookie. Relative paths will be prefixed by a
|
|
net\-specific datadir location. (default: data dir)
|
|
.HP
|
|
\fB\-rpcpassword=\fR<pw>
|
|
.IP
|
|
Password for JSON\-RPC connections
|
|
.HP
|
|
\fB\-rpcport=\fR<port>
|
|
.IP
|
|
Connect to JSON\-RPC on <port> (default: 9998, testnet: 19998, regtest:
|
|
19898)
|
|
.HP
|
|
\fB\-rpcuser=\fR<user>
|
|
.IP
|
|
Username for JSON\-RPC connections
|
|
.HP
|
|
\fB\-rpcwait\fR
|
|
.IP
|
|
Wait for RPC server to start
|
|
.HP
|
|
\fB\-rpcwaittimeout=\fR<n>
|
|
.IP
|
|
Timeout in seconds to wait for the RPC server to start, or 0 for no
|
|
timeout. (default: 0)
|
|
.HP
|
|
\fB\-rpcwallet=\fR<walletname>
|
|
.IP
|
|
Send RPC for non\-default wallet on RPC server (needs to exactly match
|
|
corresponding \fB\-wallet\fR option passed to dashd). This changes the
|
|
RPC endpoint used, e.g. http://127.0.0.1:9998/wallet/<walletname>
|
|
.HP
|
|
\fB\-stdin\fR
|
|
.IP
|
|
Read extra arguments from standard input, one per line until EOF/Ctrl\-D
|
|
(recommended for sensitive information such as passphrases). When
|
|
combined with \fB\-stdinrpcpass\fR, the first line from standard input
|
|
is used for the RPC password.
|
|
.HP
|
|
\fB\-stdinrpcpass\fR
|
|
.IP
|
|
Read RPC password from standard input as a single line. When combined
|
|
with \fB\-stdin\fR, the first line from standard input is used for the
|
|
RPC password. When combined with \fB\-stdinwalletpassphrase\fR,
|
|
\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR
|
|
consumes the second.
|
|
.HP
|
|
\fB\-stdinwalletpassphrase\fR
|
|
.IP
|
|
Read wallet passphrase from standard input as a single line. When
|
|
combined with \fB\-stdin\fR, the first line from standard input is used
|
|
for the wallet passphrase.
|
|
.HP
|
|
\fB\-version\fR
|
|
.IP
|
|
Print version and exit
|
|
.PP
|
|
Debugging/Testing options:
|
|
.PP
|
|
Chain selection options:
|
|
.HP
|
|
\fB\-chain=\fR<chain>
|
|
.IP
|
|
Use the chain <chain> (default: main). Allowed values: main, test,
|
|
regtest
|
|
.HP
|
|
\fB\-devnet=\fR<name>
|
|
.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
|