diff options
Diffstat (limited to 'contrib/debian/manpages/bitcoin-cli.1')
-rw-r--r-- | contrib/debian/manpages/bitcoin-cli.1 | 95 |
1 files changed, 79 insertions, 16 deletions
diff --git a/contrib/debian/manpages/bitcoin-cli.1 b/contrib/debian/manpages/bitcoin-cli.1 index 16c338dd3e..dbd4745d19 100644 --- a/contrib/debian/manpages/bitcoin-cli.1 +++ b/contrib/debian/manpages/bitcoin-cli.1 @@ -1,21 +1,84 @@ -.TH BITCOIN-CLI "1" "February 2016" "bitcoin-cli 0.12" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. +.TH BITCOIN-CLI "1" "December 2016" "bitcoin-cli v0.13.2.0" "User Commands" .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. +bitcoin-cli \- manual page for bitcoin-cli v0.13.2.0 .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 +Bitcoin Core RPC client version v0.13.2.0 +.SS "Usage:" +.TP +bitcoin\-cli [options] <command> [params] +Send command to Bitcoin Core .TP -\fB\-?\fR -Show possible options. +bitcoin\-cli [options] help +List commands +.TP +bitcoin\-cli [options] help <command> +Get help for a command +.SH OPTIONS +.HP +\-? +.IP +This help message +.HP +\fB\-conf=\fR<file> +.IP +Specify configuration file (default: bitcoin.conf) +.HP +\fB\-datadir=\fR<dir> +.IP +Specify data directory +.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 +\fB\-rpcconnect=\fR<ip> +.IP +Send commands to node running on <ip> (default: 127.0.0.1) +.HP +\fB\-rpcport=\fR<port> +.IP +Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332) +.HP +\fB\-rpcwait\fR +.IP +Wait for RPC server to start +.HP +\fB\-rpcuser=\fR<user> +.IP +Username for JSON\-RPC connections +.HP +\fB\-rpcpassword=\fR<pw> +.IP +Password for JSON\-RPC connections +.HP +\fB\-rpcclienttimeout=\fR<n> +.IP +Timeout during HTTP requests (default: 900) +.HP +\fB\-stdin\fR +.IP +Read extra arguments from standard input, one per line until EOF/Ctrl\-D +(recommended for sensitive information such as passphrases) +.SH COPYRIGHT +Copyright (C) 2009-2016 The Bitcoin Core developers + +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>. -.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. +This is experimental software. +Distributed under the MIT software license, see the accompanying file COPYING +or <http://www.opensource.org/licenses/mit-license.php>. -The complete text of the MIT License can be found on the web at \fIhttp://opensource.org/licenses/MIT\fP. +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. |