diff options
| author | Ciemon <ciemon@gmail.com> | 2015-02-20 17:33:58 +0000 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2015-02-26 11:07:41 +0100 |
| commit | 96c19a3a8e08047f6639de91b1ea871bc142a46a (patch) | |
| tree | 07c9a604cb96736fb33ec8e18c76c255a220977f /contrib | |
| parent | 25d713c941d1a73597c90e4feed317660cb9af6d (diff) | |
Add bitcoin-cli man page
Diffstat (limited to 'contrib')
| -rw-r--r-- | contrib/debian/bitcoind.manpages | 1 | ||||
| -rw-r--r-- | contrib/debian/manpages/bitcoin-cli.1 | 48 |
2 files changed, 49 insertions, 0 deletions
diff --git a/contrib/debian/bitcoind.manpages b/contrib/debian/bitcoind.manpages index 3e4ca63d4e..6d3e683855 100644 --- a/contrib/debian/bitcoind.manpages +++ b/contrib/debian/bitcoind.manpages @@ -1,2 +1,3 @@ debian/manpages/bitcoind.1 debian/manpages/bitcoin.conf.5 +debian/manpages/bitcoin-cli.1 diff --git a/contrib/debian/manpages/bitcoin-cli.1 b/contrib/debian/manpages/bitcoin-cli.1 new file mode 100644 index 0000000000..f953ae9db7 --- /dev/null +++ b/contrib/debian/manpages/bitcoin-cli.1 @@ -0,0 +1,48 @@ +.TH BITCOIN-CLI "1" "February 2015" "bitcoin-cli 0.10" +.SH NAME +bitcoin-cli \- a remote procedure call client for Bitcoin Core. +.SH SYNOPSIS +bitcoin-cli [options] <command> [params] \- Send command to Bitcoin Core. +.TP +bitcoin-cli [options] help \- Asks Bitcoin Core for a list of supported commands. +.SH DESCRIPTION +This manual page documents the bitcoin-cli program. bitcoin-cli is an RPC client used to send commands to Bitcoin Core. + +.SH OPTIONS +.TP +\fB\-?\fR +Show the help message. +.TP +\fB\-conf=\fR<file> +Specify configuration file (default: bitcoin.conf). +.TP +\fB\-datadir=\fR<dir> +Specify data directory. +.TP +\fB\-testnet\fR +Connect to a Bitcoin Core instance running in testnet mode. +.TP +\fB\-regtest\fR +Connect to a Bitcoin Core instance running in regtest mode (see documentation for -regtest on bitcoind). +.TP +\fB\-rpcuser=\fR<user> +Username for JSON\-RPC connections. +.TP +\fB\-rpcpassword=\fR<pw> +Password for JSON\-RPC connections. +.TP +\fB\-rpcport=\fR<port> +Listen for JSON\-RPC connections on <port> (default: 8332 or testnet: 18332). +.TP +\fB\-rpcconnect=\fR<ip> +Send commands to node running on <ip> (default: 127.0.0.1). +.TP +\fB\-rpcssl\fR=\fI1\fR +Use OpenSSL (https) for JSON\-RPC connections (see the Bitcoin Wiki for SSL setup instructions). + +.SH "SEE ALSO" +\fBbitcoind\fP, \fBbitcoin.conf\fP +.SH AUTHOR +This manual page was written by Ciemon Dunville <ciemon@gmail.com>. Permission is granted to copy, distribute and/or modify this document under the terms of the MIT License. + +The complete text of the MIT License can be found on the web at \fIhttp://opensource.org/licenses/MIT\fP. |