aboutsummaryrefslogtreecommitdiff
path: root/doc/man/bitcoin-cli.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/bitcoin-cli.1')
-rw-r--r--doc/man/bitcoin-cli.194
1 files changed, 47 insertions, 47 deletions
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1
index 8bcbe08a9b..aee651cac0 100644
--- a/doc/man/bitcoin-cli.1
+++ b/doc/man/bitcoin-cli.1
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
-.TH BITCOIN-CLI "1" "August 2021" "bitcoin-cli v22.0rc2" "User Commands"
+.TH BITCOIN-CLI "1" "August 2021" "bitcoin-cli v22.0.0rc3" "User Commands"
.SH NAME
-bitcoin-cli manual page for bitcoin-cli v22.0rc2
+bitcoin-cli \- manual page for bitcoin-cli v22.0.0rc3
.SH SYNOPSIS
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
@@ -15,119 +15,119 @@ bitcoin-cli manual page for bitcoin-cli v22.0rc2
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
-Bitcoin Core RPC client version v22.0rc2
+Bitcoin Core RPC client version v22.0.0rc3
.SH OPTIONS
.HP
-?
+\-?
.IP
Print this help message and exit
.HP
-\fBaddrinfo\fR
+\fB\-addrinfo\fR
.IP
Get the number of addresses known to the node, per network and total.
.HP
-\fBconf=\fR<file>
+\fB\-conf=\fR<file>
.IP
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: bitcoin.conf)
.HP
-\fBdatadir=\fR<dir>
+\fB\-datadir=\fR<dir>
.IP
Specify data directory
.HP
-\fBgenerate\fR
+\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: bitcoincli \fBgenerate\fR 4
+nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4
1000
.HP
-\fBgetinfo\fR
+\fB\-getinfo\fR
.IP
Get general information from the remote server. Note that unlike
-serverside RPC calls, the results of \fBgetinfo\fR is the result of
-multiple nonatomic requests. Some entries in the result may
+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
-\fBnamed\fR
+\fB\-named\fR
.IP
Pass named instead of positional arguments (default: false)
.HP
-\fBnetinfo\fR
+\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
-\fBrpcclienttimeout=\fR<n>
+\fB\-rpcclienttimeout=\fR<n>
.IP
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
900)
.HP
-\fBrpcconnect=\fR<ip>
+\fB\-rpcconnect=\fR<ip>
.IP
Send commands to node running on <ip> (default: 127.0.0.1)
.HP
-\fBrpccookiefile=\fR<loc>
+\fB\-rpccookiefile=\fR<loc>
.IP
Location of the auth cookie. Relative paths will be prefixed by a
-netspecific datadir location. (default: data dir)
+net\-specific datadir location. (default: data dir)
.HP
-\fBrpcpassword=\fR<pw>
+\fB\-rpcpassword=\fR<pw>
.IP
-Password for JSONRPC connections
+Password for JSON\-RPC connections
.HP
-\fBrpcport=\fR<port>
+\fB\-rpcport=\fR<port>
.IP
-Connect to JSONRPC on <port> (default: 8332, testnet: 18332, signet:
+Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, signet:
38332, regtest: 18443)
.HP
-\fBrpcuser=\fR<user>
+\fB\-rpcuser=\fR<user>
.IP
-Username for JSONRPC connections
+Username for JSON\-RPC connections
.HP
-\fBrpcwait\fR
+\fB\-rpcwait\fR
.IP
Wait for RPC server to start
.HP
-\fBrpcwaittimeout=\fR<n>
+\fB\-rpcwaittimeout=\fR<n>
.IP
Timeout in seconds to wait for the RPC server to start, or 0 for no
timeout. (default: 0)
.HP
-\fBrpcwallet=\fR<walletname>
+\fB\-rpcwallet=\fR<walletname>
.IP
-Send RPC for nondefault wallet on RPC server (needs to exactly match
-corresponding \fBwallet\fR option passed to bitcoind). This changes
+Send RPC for non\-default wallet on RPC server (needs to exactly match
+corresponding \fB\-wallet\fR option passed to bitcoind). This changes
the RPC endpoint used, e.g.
http://127.0.0.1:8332/wallet/<walletname>
.HP
-\fBstdin\fR
+\fB\-stdin\fR
.IP
-Read extra arguments from standard input, one per line until EOF/CtrlD
+Read extra arguments from standard input, one per line until EOF/Ctrl\-D
(recommended for sensitive information such as passphrases). When
-combined with \fBstdinrpcpass\fR, the first line from standard input
+combined with \fB\-stdinrpcpass\fR, the first line from standard input
is used for the RPC password.
.HP
-\fBstdinrpcpass\fR
+\fB\-stdinrpcpass\fR
.IP
Read RPC password from standard input as a single line. When combined
-with \fBstdin\fR, the first line from standard input is used for the
-RPC password. When combined with \fBstdinwalletpassphrase\fR,
-\fBstdinrpcpass\fR consumes the first line, and \fBstdinwalletpassphrase\fR
+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
-\fBstdinwalletpassphrase\fR
+\fB\-stdinwalletpassphrase\fR
.IP
Read wallet passphrase from standard input as a single line. When
-combined with \fBstdin\fR, the first line from standard input is used
+combined with \fB\-stdin\fR, the first line from standard input is used
for the wallet passphrase.
.HP
-\fBversion\fR
+\fB\-version\fR
.IP
Print version and exit
.PP
@@ -135,29 +135,29 @@ Debugging/Testing options:
.PP
Chain selection options:
.HP
-\fBchain=\fR<chain>
+\fB\-chain=\fR<chain>
.IP
Use the chain <chain> (default: main). Allowed values: main, test,
signet, regtest
.HP
-\fBsignet\fR
+\fB\-signet\fR
.IP
-Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network
-is defined by the \fBsignetchallenge\fR parameter
+Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
+is defined by the \fB\-signetchallenge\fR parameter
.HP
-\fBsignetchallenge\fR
+\fB\-signetchallenge\fR
.IP
Blocks must satisfy the given script to be considered valid (only for
signet networks; defaults to the global default signet test
network challenge)
.HP
-\fBsignetseednode\fR
+\fB\-signetseednode\fR
.IP
Specify a seed node for the signet network, in the hostname[:port]
format, e.g. sig.net:1234 (may be used multiple times to specify
multiple seed nodes; defaults to the global default signet test
network seed node(s))
.HP
-\fBtestnet\fR
+\fB\-testnet\fR
.IP
-Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR.
+Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.