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.168
1 files changed, 58 insertions, 10 deletions
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1
index 129651d8e9..83f60d52ba 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.6.
-.TH BITCOIN-CLI "1" "February 2019" "bitcoin-cli v0.17.99.0" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
+.TH BITCOIN-CLI "1" "November 2020" "bitcoin-cli v0.21.0.0" "User Commands"
.SH NAME
-bitcoin-cli \- manual page for bitcoin-cli v0.17.99.0
+bitcoin-cli \- manual page for bitcoin-cli v0.21.0.0
.SH SYNOPSIS
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
@@ -15,7 +15,7 @@ bitcoin-cli \- manual page for bitcoin-cli v0.17.99.0
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
-Bitcoin Core RPC client version v0.17.99.0
+Bitcoin Core RPC client version v0.21.0.0
.SH OPTIONS
.HP
\-?
@@ -31,6 +31,15 @@ location. (default: bitcoin.conf)
.IP
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:
+bitcoin\-cli \fB\-generate\fR 4 1000
+.HP
\fB\-getinfo\fR
.IP
Get general information from the remote server. Note that unlike
@@ -43,6 +52,12 @@ be as of a different block from the chain state reported)
.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).
+.HP
\fB\-rpcclienttimeout=\fR<n>
.IP
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
@@ -63,8 +78,8 @@ Password for JSON\-RPC connections
.HP
\fB\-rpcport=\fR<port>
.IP
-Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, regtest:
-18443)
+Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, signet:
+38332, regtest: 18443)
.HP
\fB\-rpcuser=\fR<user>
.IP
@@ -92,22 +107,55 @@ is used for the RPC password.
.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.
+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,
+signet, regtest
+.HP
+\fB\-signet\fR
+.IP
+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
+\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
+\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
\fB\-testnet\fR
.IP
-Use the test chain
+Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.SH COPYRIGHT
-Copyright (C) 2009-2019 The Bitcoin Core developers
+Copyright (C) 2009-2020 The Bitcoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
-<https://bitcoincore.org> for further information about the software.
+<https://bitcoincore.org/> for further information about the software.
The source code is available from <https://github.com/bitcoin/bitcoin>.
This is experimental software.