Skip to content

Commit

Permalink
Update manpages & example bitcoin.conf
Browse files Browse the repository at this point in the history
  • Loading branch information
luke-jr committed Nov 15, 2023
1 parent 5961e01 commit aed49ce
Show file tree
Hide file tree
Showing 7 changed files with 516 additions and 139 deletions.
37 changes: 25 additions & 12 deletions doc/man/bitcoin-cli.1
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH BITCOIN-CLI "1" "October 2023" "bitcoin-cli v25.1.0" "User Commands"
.TH BITCOIN-CLI "1" "November 2023" "bitcoin-cli v25.1.0" "User Commands"
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli v25.1.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 v25.1.0
Bitcoin Knots RPC client version v25.1.0
.SH OPTIONS
.HP
\-?
Expand All @@ -39,6 +39,12 @@ and OS is not WIN32), never.
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
Expand All @@ -54,11 +60,12 @@ nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4
.HP
\fB\-getinfo\fR
.IP
Get general information from the remote server. Note that unlike
server\-side RPC calls, the output of \fB\-getinfo\fR is the result of
multiple non\-atomic requests. Some entries in the output 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 @@ -153,6 +160,12 @@ signet, regtest
Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
is defined by the \fB\-signetchallenge\fR parameter
.HP
\fB\-signetblocktime\fR
.IP
Difficulty adjustment will target a block time of the given amount in
seconds (only for custom signet networks, must have
\fB\-signetchallenge\fR set; defaults to 10 minutes)
.HP
\fB\-signetchallenge\fR
.IP
Blocks must satisfy the given script to be considered valid (only for
Expand All @@ -172,9 +185,9 @@ Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.SH COPYRIGHT
Copyright (C) 2009-2023 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 aed49ce

Please sign in to comment.