lbrycrd/doc/man/bitcoin-cli.1

127 lines
3.6 KiB
Groff
Raw Normal View History

2018-07-27 00:39:42 +02:00
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH BITCOIN-CLI "1" "February 2020" "bitcoin-cli v0.19.1.0" "User Commands"
2016-08-27 01:03:06 +02:00
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli v0.19.1.0
2018-12-29 10:22:49 +01:00
.SH SYNOPSIS
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
.br
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (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
2016-08-27 01:03:06 +02:00
.SH DESCRIPTION
Bitcoin Core RPC client version v0.19.1.0
2016-08-27 01:03:06 +02:00
.SH OPTIONS
.HP
\-?
.IP
2019-02-06 19:57:52 +01:00
Print this help message and exit
2016-08-27 01:03:06 +02:00
.HP
\fB\-conf=\fR<file>
.IP
2018-07-27 00:39:42 +02:00
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: bitcoin.conf)
2016-08-27 01:03:06 +02:00
.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)
2016-08-27 01:03:06 +02:00
.HP
\fB\-named\fR
.IP
Pass named instead of positional arguments (default: false)
.HP
2018-07-27 00:39:42 +02:00
\fB\-rpcclienttimeout=\fR<n>
.IP
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
900)
.HP
2016-08-27 01:03:06 +02:00
\fB\-rpcconnect=\fR<ip>
.IP
Send commands to node running on <ip> (default: 127.0.0.1)
.HP
2018-07-27 00:39:42 +02:00
\fB\-rpccookiefile=\fR<loc>
2016-08-27 01:03:06 +02:00
.IP
2018-07-27 00:39:42 +02:00
Location of the auth cookie. Relative paths will be prefixed by a
net\-specific datadir location. (default: data dir)
2016-08-27 01:03:06 +02:00
.HP
2018-07-27 00:39:42 +02:00
\fB\-rpcpassword=\fR<pw>
2016-08-27 01:03:06 +02:00
.IP
2018-07-27 00:39:42 +02:00
Password for JSON\-RPC connections
.HP
\fB\-rpcport=\fR<port>
.IP
2018-12-29 10:22:49 +01:00
Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, regtest:
18443)
2016-08-27 01:03:06 +02:00
.HP
\fB\-rpcuser=\fR<user>
.IP
Username for JSON\-RPC connections
.HP
2018-07-27 00:39:42 +02:00
\fB\-rpcwait\fR
2016-08-27 01:03:06 +02:00
.IP
2018-07-27 00:39:42 +02:00
Wait for RPC server to start
2016-08-27 01:03:06 +02:00
.HP
2018-07-27 00:39:42 +02:00
\fB\-rpcwallet=\fR<walletname>
2016-08-27 01:03:06 +02:00
.IP
2018-07-27 00:39:42 +02:00
Send RPC for non\-default wallet on RPC server (needs to exactly match
2018-12-29 10:22:49 +01:00
corresponding \fB\-wallet\fR option passed to bitcoind). This changes
the RPC endpoint used, e.g.
http://127.0.0.1:8332/wallet/<walletname>
2018-07-27 00:39:42 +02:00
.HP
\fB\-stdin\fR
.IP
Read extra arguments from standard input, one per line until EOF/Ctrl\-D
2018-12-29 10:22:49 +01: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.
2017-09-12 09:34:12 +02:00
.HP
\fB\-stdinrpcpass\fR
.IP
2018-12-29 10:22:49 +01:00
Read RPC password from standard input as a single line. When combined
2017-09-12 09:34:12 +02:00
with \fB\-stdin\fR, the first line from standard input is used for the
RPC password.
2016-08-27 01:03:06 +02:00
.HP
2018-07-27 00:39:42 +02:00
\fB\-version\fR
2016-08-27 01:03:06 +02:00
.IP
2018-07-27 00:39:42 +02:00
Print version and exit
.PP
Debugging/Testing options:
.PP
2018-07-27 00:39:42 +02:00
Chain selection options:
2017-09-12 09:34:12 +02:00
.HP
\fB\-chain=\fR<chain>
.IP
Use the chain <chain> (default: main). Allowed values: main, test,
regtest
.HP
2018-07-27 00:39:42 +02:00
\fB\-testnet\fR
2017-09-12 09:34:12 +02:00
.IP
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
2016-08-27 01:03:06 +02:00
.SH COPYRIGHT
2019-02-06 16:20:28 +01:00
Copyright (C) 2009-2019 The Bitcoin Core developers
2016-08-27 01:03:06 +02:00
Please contribute if you find Bitcoin Core useful. Visit
<https://bitcoincore.org> for further information about the software.
The source code is available from <https://github.com/bitcoin/bitcoin>.
This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>
2016-08-27 01:03:06 +02:00
This product includes software developed by the OpenSSL Project for use in the
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
Eric Young and UPnP software written by Thomas Bernard.