Skip to content

Commit

Permalink
Update manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
luke-jr committed Dec 13, 2021
2 parents f1e6ee7 + 6addc3e commit 42a7a1b
Show file tree
Hide file tree
Showing 5 changed files with 367 additions and 119 deletions.
58 changes: 37 additions & 21 deletions doc/man/bitcoin-cli.1
Original file line number Diff line number Diff line change
@@ -1,52 +1,63 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH BITCOIN-CLI "1" "August 2021" "bitcoin-cli v0.21.2.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
.TH BITCOIN-CLI "1" "December 2021" "bitcoin-cli v21.2.0" "User Commands"
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli v0.21.2.0
bitcoin-cli \- manual page for bitcoin-cli v21.2.0
.SH SYNOPSIS
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Knots\/\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
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Knots (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
Bitcoin Core RPC client version v0.21.2.0
Bitcoin Knots RPC client version v21.2.0
.SH OPTIONS
.HP
\-?
.IP
Print this help message and exit
.HP
\fB\-addrinfo\fR
.IP
Get the number of addresses known to the node, per network and total.
.HP
\fB\-conf=\fR<file>
.IP
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: bitcoin.conf)
.HP
\fB\-confrw=\fR<file>
.IP
Specify read/write configuration file. Relative paths will be prefixed
by the network\-specific datadir location. (default:
bitcoin_rw.conf)
.HP
\fB\-datadir=\fR<dir>
.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
Generate blocks immediately, equivalent to RPC getnewaddress 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
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)
Get general information from the remote server, including the total
balance and the balances of each loaded wallet when in
multiwallet mode. Note that \fB\-getinfo\fR is the combined result of
several RPCs (getnetworkinfo, getblockchaininfo, getwalletinfo,
getbalances, and in multiwallet mode, listwallets), each with
potentially different state.
.HP
\fB\-named\fR
.IP
Expand Down Expand Up @@ -89,6 +100,11 @@ Username for JSON\-RPC connections
.IP
Wait for RPC server to start
.HP
\fB\-rpcwaittimeout=\fR<n>
.IP
Timeout in seconds to wait for the RPC server to start, or 0 for no
timeout. (default: 0)
.HP
\fB\-rpcwallet=\fR<walletname>
.IP
Send RPC for non\-default wallet on RPC server (needs to exactly match
Expand Down Expand Up @@ -152,11 +168,11 @@ network seed node(s))
.IP
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.SH COPYRIGHT
Copyright (C) 2009-2020 The Bitcoin Core developers
Copyright (C) 2009-2021 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>.
Please contribute if you find Bitcoin Knots useful. Visit
<https://bitcoinknots.org/> for further information about the software.
The source code is available from <https://github.com/bitcoinknots/bitcoin>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
Expand Down
Loading

0 comments on commit 42a7a1b

Please sign in to comment.