Skip to content

Commit 88f0419

Browse files
committed
Merge bitcoin#30726: [28.x] Bump to 28.0rc1
bd45bc6 doc: Point release notes to wiki draft (Ava Chow) 27b6300 examples: Generate example bitcoin.conf (Ava Chow) 08887d3 doc: Generate manpages (Ava Chow) 6974e30 build: Bump to 28.0rc1 (Ava Chow) Pull request description: * Bump version to 28.0rc1 * Generated manpages * Generated example bitcoin.conf * Point release notes to wiki ACKs for top commit: hebasto: ACK bd45bc6. Tree-SHA512: c3cd28b003ead64631b8c2d1bdbf7403d4d9f53ee5ccdc448d89ca25941678f6d1d8966c2f9a92fa021c815b3e36a84056342caa4eaacdab371f0d581e4e58dc
2 parents 1248d0d + bd45bc6 commit 88f0419

File tree

10 files changed

+2922
-121
lines changed

10 files changed

+2922
-121
lines changed

configure.ac

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
AC_PREREQ([2.69])
22
define(_CLIENT_VERSION_MAJOR, 28)
3-
define(_CLIENT_VERSION_MINOR, 99)
3+
define(_CLIENT_VERSION_MINOR, 0)
44
define(_CLIENT_VERSION_BUILD, 0)
5-
define(_CLIENT_VERSION_RC, 0)
6-
define(_CLIENT_VERSION_IS_RELEASE, false)
5+
define(_CLIENT_VERSION_RC, 1)
6+
define(_CLIENT_VERSION_IS_RELEASE, true)
77
define(_COPYRIGHT_YEAR, 2024)
88
define(_COPYRIGHT_HOLDERS,[The %s developers])
99
define(_COPYRIGHT_HOLDERS_SUBSTITUTION,[[Bitcoin Core]])

doc/man/bitcoin-cli.1

Lines changed: 187 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,189 @@
1-
.TH BITCOIN-CLI "1"
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2+
.TH BITCOIN-CLI "1" "August 2024" "bitcoin-cli v28.0.0rc1" "User Commands"
23
.SH NAME
3-
bitcoin-cli \- manual page for bitcoin-cli
4+
bitcoin-cli \- manual page for bitcoin-cli v28.0.0rc1
5+
.SH SYNOPSIS
6+
.B bitcoin-cli
7+
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
8+
.br
9+
.B bitcoin-cli
10+
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (with named arguments)\/\fR
11+
.br
12+
.B bitcoin-cli
13+
[\fI\,options\/\fR] \fI\,help List commands\/\fR
14+
.br
15+
.B bitcoin-cli
16+
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
17+
.SH DESCRIPTION
18+
Bitcoin Core RPC client version v28.0.0rc1
19+
.SH OPTIONS
20+
.HP
21+
\-?
22+
.IP
23+
Print this help message and exit
24+
.HP
25+
\fB\-addrinfo\fR
26+
.IP
27+
Get the number of addresses known to the node, per network and total,
28+
after filtering for quality and recency. The total number of
29+
addresses known to the node may be higher.
30+
.HP
31+
\fB\-color=\fR<when>
32+
.IP
33+
Color setting for CLI output (default: auto). Valid values: always, auto
34+
(add color codes when standard output is connected to a terminal
35+
and OS is not WIN32), never.
36+
.HP
37+
\fB\-conf=\fR<file>
38+
.IP
39+
Specify configuration file. Relative paths will be prefixed by datadir
40+
location. (default: bitcoin.conf)
41+
.HP
42+
\fB\-datadir=\fR<dir>
43+
.IP
44+
Specify data directory
45+
.HP
46+
\fB\-generate\fR
47+
.IP
48+
Generate blocks, equivalent to RPC getnewaddress followed by RPC
49+
generatetoaddress. Optional positional integer arguments are
50+
number of blocks to generate (default: 1) and maximum iterations
51+
to try (default: 1000000), equivalent to RPC generatetoaddress
52+
nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4
53+
1000
54+
.HP
55+
\fB\-getinfo\fR
56+
.IP
57+
Get general information from the remote server. Note that unlike
58+
server\-side RPC calls, the output of \fB\-getinfo\fR is the result of
59+
multiple non\-atomic requests. Some entries in the output may
60+
represent results from different states (e.g. wallet balance may
61+
be as of a different block from the chain state reported)
62+
.HP
63+
\fB\-named\fR
64+
.IP
65+
Pass named instead of positional arguments (default: false)
66+
.HP
67+
\fB\-netinfo\fR
68+
.IP
69+
Get network peer connection information from the remote server. An
70+
optional integer argument from 0 to 4 can be passed for different
71+
peers listings (default: 0). Pass "help" for detailed help
72+
documentation.
73+
.HP
74+
\fB\-rpcclienttimeout=\fR<n>
75+
.IP
76+
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
77+
900)
78+
.HP
79+
\fB\-rpcconnect=\fR<ip>
80+
.IP
81+
Send commands to node running on <ip> (default: 127.0.0.1)
82+
.HP
83+
\fB\-rpccookiefile=\fR<loc>
84+
.IP
85+
Location of the auth cookie. Relative paths will be prefixed by a
86+
net\-specific datadir location. (default: data dir)
87+
.HP
88+
\fB\-rpcpassword=\fR<pw>
89+
.IP
90+
Password for JSON\-RPC connections
91+
.HP
92+
\fB\-rpcport=\fR<port>
93+
.IP
94+
Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, testnet4:
95+
48332, signet: 38332, regtest: 18443)
96+
.HP
97+
\fB\-rpcuser=\fR<user>
98+
.IP
99+
Username for JSON\-RPC connections
100+
.HP
101+
\fB\-rpcwait\fR
102+
.IP
103+
Wait for RPC server to start
104+
.HP
105+
\fB\-rpcwaittimeout=\fR<n>
106+
.IP
107+
Timeout in seconds to wait for the RPC server to start, or 0 for no
108+
timeout. (default: 0)
109+
.HP
110+
\fB\-rpcwallet=\fR<walletname>
111+
.IP
112+
Send RPC for non\-default wallet on RPC server (needs to exactly match
113+
corresponding \fB\-wallet\fR option passed to bitcoind). This changes
114+
the RPC endpoint used, e.g.
115+
http://127.0.0.1:8332/wallet/<walletname>
116+
.HP
117+
\fB\-stdin\fR
118+
.IP
119+
Read extra arguments from standard input, one per line until EOF/Ctrl\-D
120+
(recommended for sensitive information such as passphrases). When
121+
combined with \fB\-stdinrpcpass\fR, the first line from standard input
122+
is used for the RPC password.
123+
.HP
124+
\fB\-stdinrpcpass\fR
125+
.IP
126+
Read RPC password from standard input as a single line. When combined
127+
with \fB\-stdin\fR, the first line from standard input is used for the
128+
RPC password. When combined with \fB\-stdinwalletpassphrase\fR,
129+
\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR
130+
consumes the second.
131+
.HP
132+
\fB\-stdinwalletpassphrase\fR
133+
.IP
134+
Read wallet passphrase from standard input as a single line. When
135+
combined with \fB\-stdin\fR, the first line from standard input is used
136+
for the wallet passphrase.
137+
.HP
138+
\fB\-version\fR
139+
.IP
140+
Print version and exit
141+
.PP
142+
Debugging/Testing options:
143+
.PP
144+
Chain selection options:
145+
.HP
146+
\fB\-chain=\fR<chain>
147+
.IP
148+
Use the chain <chain> (default: main). Allowed values: main, test,
149+
testnet4, signet, regtest
150+
.HP
151+
\fB\-signet\fR
152+
.IP
153+
Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
154+
is defined by the \fB\-signetchallenge\fR parameter
155+
.HP
156+
\fB\-signetchallenge\fR
157+
.IP
158+
Blocks must satisfy the given script to be considered valid (only for
159+
signet networks; defaults to the global default signet test
160+
network challenge)
161+
.HP
162+
\fB\-signetseednode\fR
163+
.IP
164+
Specify a seed node for the signet network, in the hostname[:port]
165+
format, e.g. sig.net:1234 (may be used multiple times to specify
166+
multiple seed nodes; defaults to the global default signet test
167+
network seed node(s))
168+
.HP
169+
\fB\-testnet\fR
170+
.IP
171+
Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3
172+
is deprecated and will be removed in an upcoming release.
173+
Consider moving to testnet4 now by using \fB\-testnet4\fR.
174+
.HP
175+
\fB\-testnet4\fR
176+
.IP
177+
Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR.
178+
.SH COPYRIGHT
179+
Copyright (C) 2009-2024 The Bitcoin Core developers
4180

5-
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
181+
Please contribute if you find Bitcoin Core useful. Visit
182+
<https://bitcoincore.org/> for further information about the software.
183+
The source code is available from <https://github.com/bitcoin/bitcoin>.
184+
185+
This is experimental software.
186+
Distributed under the MIT software license, see the accompanying file COPYING
187+
or <https://opensource.org/licenses/MIT>
188+
.SH "SEE ALSO"
189+
bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1)

0 commit comments

Comments
 (0)