dash/doc/man/dash-cli.1

169 lines
4.8 KiB
Groff
Raw Permalink Normal View History

2022-08-11 00:56:34 +02:00
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
2022-08-17 18:40:59 +02:00
.TH DASH-CLI "1" "August 2022" "dash-cli v18.0.1" "User Commands"
.SH NAME
2022-08-17 18:40:59 +02:00
dash-cli \- manual page for dash-cli v18.0.1
2022-08-11 00:56:34 +02:00
.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
2022-08-17 18:40:59 +02:00
Dash Core RPC client version v18.0.1
.SH OPTIONS
.HP
\-?
.IP
Print this help message and exit
.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\-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\-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
2022-08-11 00:56:34 +02:00
\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
2022-08-11 00:56:34 +02:00
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\-rpcwallet=\fR<walletname>
.IP
Send RPC for non\-default wallet on RPC server (needs to exactly match
2022-08-11 00:56:34 +02:00
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
2022-08-11 00:56:34 +02:00
(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
2022-08-11 00:56:34 +02:00
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
2022-08-11 00:56:34 +02:00
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
Chain selection options:
.HP
\fB\-devnet=\fR<name>
.IP
Use devnet chain with provided name
.HP
2022-08-11 00:56:34 +02:00
\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)
.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_50_60, devnet\-only)
.HP
\fB\-llmqdevnetparams=\fR<size>:<threshold>
.IP
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_50_60,
devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default:
llmq_60_75, 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
.SH COPYRIGHT
2022-08-11 00:56:34 +02:00
Copyright (C) 2014-2022 The Dash Core developers
Copyright (C) 2009-2022 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>