Changeset View
Changeset View
Standalone View
Standalone View
doc/man/bitcoin-cli.1
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. | ||||
.TH BITCOIN-CLI "1" "May 2019" "bitcoin-cli v0.19.6.0" "User Commands" | .TH BITCOIN-CLI "1" "May 2019" "bitcoin-cli v0.19.7.0" "User Commands" | ||||
.SH NAME | .SH NAME | ||||
bitcoin-cli \- manual page for bitcoin-cli v0.19.6.0 | bitcoin-cli \- manual page for bitcoin-cli v0.19.7.0 | ||||
.SH SYNOPSIS | |||||
.B bitcoin-cli | |||||
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin ABC\/\fR | |||||
.br | |||||
.B bitcoin-cli | |||||
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin ABC (with named arguments)\/\fR | |||||
.br | |||||
.B bitcoin-cli | |||||
[\fI\,options\/\fR] \fI\,help List commands\/\fR | |||||
.br | |||||
.B bitcoin-cli | |||||
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR | |||||
.SH DESCRIPTION | .SH DESCRIPTION | ||||
Bitcoin ABC RPC client version v0.19.6.0 | Bitcoin ABC RPC client version v0.19.7.0 | ||||
.SS "Usage:" | |||||
.TP | |||||
bitcoin\-cli [options] <command> [params] | |||||
Send command to Bitcoin ABC | |||||
.IP | |||||
bitcoin\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Bitcoin ABC (with named arguments) | |||||
bitcoin\-cli [options] help List commands | |||||
bitcoin\-cli [options] help <command> Get help for a command | |||||
.SH OPTIONS | .SH OPTIONS | ||||
.HP | .HP | ||||
\-? | \-? | ||||
.IP | .IP | ||||
This help message | This help message | ||||
.HP | .HP | ||||
\fB\-conf=\fR<file> | \fB\-conf=\fR<file> | ||||
.IP | .IP | ||||
Specify configuration file (default: bitcoin.conf) | Specify configuration file (default: bitcoin.conf) | ||||
.HP | .HP | ||||
\fB\-datadir=\fR<dir> | \fB\-datadir=\fR<dir> | ||||
.IP | .IP | ||||
Specify data directory | Specify data directory | ||||
.HP | .HP | ||||
\fB\-getinfo\fR | \fB\-getinfo\fR | ||||
.IP | .IP | ||||
Get general information from the remote server. Note that unlike | Get general information from the remote server. Note that unlike | ||||
server\-side RPC calls, the results of \fB\-getinfo\fR is the result of | server\-side RPC calls, the results of \fB\-getinfo\fR is the result of | ||||
multiple non\-atomic requests. Some entries in the result may | multiple non\-atomic requests. Some entries in the result may | ||||
represent results from different states (e.g. wallet balance may | represent results from different states (e.g. wallet balance may | ||||
be as of a different block from the chain state reported) | be as of a different block from the chain state reported) | ||||
.PP | |||||
Chain selection options: | |||||
.HP | |||||
\fB\-testnet\fR | |||||
.IP | |||||
Use the test chain | |||||
.HP | |||||
\fB\-regtest\fR | |||||
.IP | |||||
Enter regression test mode, which uses a special chain in which blocks | |||||
can be solved instantly. This is intended for regression testing | |||||
tools and app development. | |||||
.HP | .HP | ||||
\fB\-named\fR | \fB\-named\fR | ||||
.IP | .IP | ||||
Pass named instead of positional arguments (default: false) | Pass named instead of positional arguments (default: false) | ||||
.HP | .HP | ||||
\fB\-rpcclienttimeout=\fR<n> | |||||
.IP | |||||
Timeout in seconds during HTTP requests, or 0 for no timeout. (default: | |||||
900) | |||||
.HP | |||||
\fB\-rpcconnect=\fR<ip> | \fB\-rpcconnect=\fR<ip> | ||||
.IP | .IP | ||||
Send commands to node running on <ip> (default: 127.0.0.1) | Send commands to node running on <ip> (default: 127.0.0.1) | ||||
.HP | .HP | ||||
\fB\-rpcport=\fR<port> | \fB\-rpcpassword=\fR<pw> | ||||
.IP | .IP | ||||
Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332) | Password for JSON\-RPC connections | ||||
.HP | .HP | ||||
\fB\-rpcwait\fR | \fB\-rpcport=\fR<port> | ||||
.IP | .IP | ||||
Wait for RPC server to start | Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332) | ||||
.HP | .HP | ||||
\fB\-rpcuser=\fR<user> | \fB\-rpcuser=\fR<user> | ||||
.IP | .IP | ||||
Username for JSON\-RPC connections | Username for JSON\-RPC connections | ||||
.HP | .HP | ||||
\fB\-rpcpassword=\fR<pw> | \fB\-rpcwait\fR | ||||
.IP | |||||
Password for JSON\-RPC connections | |||||
.HP | |||||
\fB\-rpcclienttimeout=\fR<n> | |||||
.IP | .IP | ||||
Timeout in seconds during HTTP requests, or 0 for no timeout. (default: | Wait for RPC server to start | ||||
900) | |||||
.HP | .HP | ||||
\fB\-stdinrpcpass\fR | \fB\-rpcwallet=\fR<walletname> | ||||
.TP | |||||
Read RPC password from standard input as a single line. | |||||
When combined | |||||
.IP | .IP | ||||
with \fB\-stdin\fR, the first line from standard input is used for the | Send RPC for non\-default wallet on RPC server (needs to exactly match | ||||
RPC password. | corresponding \fB\-wallet\fR option passed to bitcoind) | ||||
.HP | .HP | ||||
\fB\-stdin\fR | \fB\-stdin\fR | ||||
.IP | .IP | ||||
Read extra arguments from standard input, one per line until EOF/Ctrl\-D | Read extra arguments from standard input, one per line until EOF/Ctrl\-D | ||||
(recommended for sensitive information such as passphrases) | (recommended for sensitive information such as passphrases) | ||||
.HP | .HP | ||||
\fB\-rpcwallet=\fR<walletname> | \fB\-stdinrpcpass\fR | ||||
.IP | .IP | ||||
Send RPC for non\-default wallet on RPC server (argument is wallet | Read RPC password from standard input as a single line. When combined | ||||
filename in bitcoind directory, required if bitcoind/\-Qt runs | with \fB\-stdin\fR, the first line from standard input is used for the | ||||
with multiple wallets) | RPC password. | ||||
.PP | |||||
Chain selection options: | |||||
.HP | |||||
\fB\-testnet\fR | |||||
.IP | |||||
Use the test chain | |||||
.SH COPYRIGHT | .SH COPYRIGHT | ||||
Copyright (C) 2009-2019 The Bitcoin developers | Copyright (C) 2009-2019 The Bitcoin developers | ||||
Please contribute if you find Bitcoin ABC useful. Visit | Please contribute if you find Bitcoin ABC useful. Visit | ||||
<https://www.bitcoinabc.org> for further information about the software. | <https://www.bitcoinabc.org> for further information about the software. | ||||
The source code is available from <https://github.com/Bitcoin-ABC/bitcoin-abc>. | The source code is available from <https://github.com/Bitcoin-ABC/bitcoin-abc>. | ||||
This is experimental software. | This is experimental software. | ||||
Distributed under the MIT software license, see the accompanying file COPYING | Distributed under the MIT software license, see the accompanying file COPYING | ||||
or <https://opensource.org/licenses/MIT> | or <https://opensource.org/licenses/MIT> | ||||
This product includes software developed by the OpenSSL Project for use in the | This product includes software developed by the OpenSSL Project for use in the | ||||
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by | OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by | ||||
Eric Young and UPnP software written by Thomas Bernard. | Eric Young and UPnP software written by Thomas Bernard. |