Skip to content

Commit eb49101

Browse files
laanwjMarcoFalke
laanwj
authored and
MarcoFalke
committed
doc: Update manpages for master
(cherry picked from commit 268c390)
1 parent 50a2265 commit eb49101

File tree

4 files changed

+179
-100
lines changed

4 files changed

+179
-100
lines changed

‎doc/man/bitcoin-cli.1‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
2-
.TH BITCOIN-CLI "1" "September 2016" "bitcoin-cli v0.13.0.0" "User Commands"
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2+
.TH BITCOIN-CLI "1" "February 2017" "bitcoin-cli v0.14.99.0" "User Commands"
33
.SH NAME
4-
bitcoin-cli \- manual page for bitcoin-cli v0.13.0.0
4+
bitcoin-cli \- manual page for bitcoin-cli v0.14.99.0
55
.SH DESCRIPTION
6-
Bitcoin Core RPC client version v0.13.0.0
6+
Bitcoin Core RPC client version v0.14.99.0
77
.SS "Usage:"
88
.TP
99
bitcoin\-cli [options] <command> [params]
1010
Send command to Bitcoin Core
11-
.TP
12-
bitcoin\-cli [options] help
13-
List commands
14-
.TP
15-
bitcoin\-cli [options] help <command>
16-
Get help for a command
11+
.IP
12+
bitcoin\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Bitcoin Core (with named arguments)
13+
bitcoin\-cli [options] help List commands
14+
bitcoin\-cli [options] help <command> Get help for a command
1715
.SH OPTIONS
1816
.HP
1917
\-?
@@ -40,6 +38,10 @@ Enter regression test mode, which uses a special chain in which blocks
4038
can be solved instantly. This is intended for regression testing
4139
tools and app development.
4240
.HP
41+
\fB\-named\fR
42+
.IP
43+
Pass named instead of positional arguments (default: false)
44+
.HP
4345
\fB\-rpcconnect=\fR<ip>
4446
.IP
4547
Send commands to node running on <ip> (default: 127.0.0.1)
@@ -69,16 +71,16 @@ Timeout during HTTP requests (default: 900)
6971
Read extra arguments from standard input, one per line until EOF/Ctrl\-D
7072
(recommended for sensitive information such as passphrases)
7173
.SH COPYRIGHT
72-
Copyright (C) 2009-2016 The Bitcoin Core developers
74+
Copyright (C) 2009-2017 The Bitcoin Core developers
7375

7476
Please contribute if you find Bitcoin Core useful. Visit
7577
<https://bitcoincore.org> for further information about the software.
7678
The source code is available from <https://github.com/bitcoin/bitcoin>.
7779

7880
This is experimental software.
7981
Distributed under the MIT software license, see the accompanying file COPYING
80-
or <http://www.opensource.org/licenses/mit-license.php>.
82+
or <https://opensource.org/licenses/MIT>
8183

8284
This product includes software developed by the OpenSSL Project for use in the
83-
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
84-
by Eric Young and UPnP software written by Thomas Bernard.
85+
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
86+
Eric Young and UPnP software written by Thomas Bernard.

‎doc/man/bitcoin-qt.1‎

Lines changed: 69 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
2-
.TH BITCOIN-QT "1" "September 2016" "bitcoin-qt v0.13.0.0" "User Commands"
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2+
.TH BITCOIN-QT "1" "February 2017" "bitcoin-qt v0.14.99.0" "User Commands"
33
.SH NAME
4-
bitcoin-qt \- manual page for bitcoin-qt v0.13.0.0
4+
bitcoin-qt \- manual page for bitcoin-qt v0.14.99.0
55
.SH DESCRIPTION
6-
Bitcoin Core version v0.13.0.0 (64\-bit)
6+
Bitcoin Core version v0.14.99.0 (64\-bit)
77
Usage:
88
.IP
99
bitcoin\-qt [command\-line options]
@@ -27,13 +27,14 @@ long fork (%s in cmd is replaced by message)
2727
Execute command when the best block changes (%s in cmd is replaced by
2828
block hash)
2929
.HP
30-
\fB\-checkblocks=\fR<n>
30+
\fB\-assumevalid=\fR<hex>
3131
.IP
32-
How many blocks to check at startup (default: 288, 0 = all)
33-
.HP
34-
\fB\-checklevel=\fR<n>
35-
.IP
36-
How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3)
32+
If this block is in the chain assume that it and its ancestors are valid
33+
and potentially skip their script verification (0 to verify all,
34+
default:
35+
00000000000000000013176bf8d7dfeab4e1db31dc93bc311b436e82ab226b90,
36+
testnet:
37+
00000000000128796ee387cf110ccb9d2f36cffaf7f73079c995377c65ac0dcc)
3738
.HP
3839
\fB\-conf=\fR<file>
3940
.IP
@@ -62,11 +63,16 @@ Keep the transaction memory pool below <n> megabytes (default: 300)
6263
\fB\-mempoolexpiry=\fR<n>
6364
.IP
6465
Do not keep transactions in the mempool longer than <n> hours (default:
65-
72)
66+
336)
67+
.HP
68+
\fB\-blockreconstructionextratxn=\fR<n>
69+
.IP
70+
Extra transactions to keep in memory for compact block reconstructions
71+
(default: 100)
6672
.HP
6773
\fB\-par=\fR<n>
6874
.IP
69-
Set the number of script verification threads (\fB\-4\fR to 16, 0 = auto, <0 =
75+
Set the number of script verification threads (\fB\-2\fR to 16, 0 = auto, <0 =
7076
leave that many cores free, default: 0)
7177
.HP
7278
\fB\-pid=\fR<file>
@@ -75,13 +81,15 @@ Specify pid file (default: bitcoind.pid)
7581
.HP
7682
\fB\-prune=\fR<n>
7783
.IP
78-
Reduce storage requirements by enabling pruning (deleting) of old blocks.
79-
This allows the pruneblockchain RPC to be called to delete specific blocks,
80-
and enables automatic pruning of old blocks if a target size in MiB is
81-
provided. This mode is incompatible with \fB\-txindex\fR and \fB\-rescan\fR.
82-
Warning: Reverting this setting requires re\-downloading the entire blockchain.
83-
(default: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >550 =
84-
automatically prune block files to stay under the specified target size in MiB)
84+
Reduce storage requirements by enabling pruning (deleting) of old
85+
blocks. This allows the pruneblockchain RPC to be called to
86+
delete specific blocks, and enables automatic pruning of old
87+
blocks if a target size in MiB is provided. This mode is
88+
incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this
89+
setting requires re\-downloading the entire blockchain. (default:
90+
0 = disable pruning blocks, 1 = allow manual pruning via RPC,
91+
>550 = automatically prune block files to stay under the
92+
specified target size in MiB)
8593
.HP
8694
\fB\-reindex\-chainstate\fR
8795
.IP
@@ -123,7 +131,8 @@ for IPv6
123131
.HP
124132
\fB\-connect=\fR<ip>
125133
.IP
126-
Connect only to the specified node(s)
134+
Connect only to the specified node(s); \fB\-noconnect\fR or \fB\-connect\fR=\fI\,0\/\fR alone to
135+
disable automatic connections
127136
.HP
128137
\fB\-discover\fR
129138
.IP
@@ -137,7 +146,7 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def
137146
\fB\-dnsseed\fR
138147
.IP
139148
Query for peer addresses via DNS lookup, if low on addresses (default: 1
140-
unless \fB\-connect\fR)
149+
unless \fB\-connect\fR/\-noconnect)
141150
.HP
142151
\fB\-externalip=\fR<ip>
143152
.IP
@@ -149,7 +158,8 @@ Always query for peer addresses via DNS lookup (default: 0)
149158
.HP
150159
\fB\-listen\fR
151160
.IP
152-
Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
161+
Accept connections from outside (default: 1 if no \fB\-proxy\fR or
162+
\fB\-connect\fR/\-noconnect)
153163
.HP
154164
\fB\-listenonion\fR
155165
.IP
@@ -204,6 +214,11 @@ Connect through SOCKS5 proxy
204214
Randomize credentials for every proxy connection. This enables Tor
205215
stream isolation (default: 1)
206216
.HP
217+
\fB\-rpcserialversion\fR
218+
.IP
219+
Sets the serialization of raw transaction or block hex returned in
220+
non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1)
221+
.HP
207222
\fB\-seednode=\fR<ip>
208223
.IP
209224
Connect to a node to retrieve peer addresses, and disconnect
@@ -221,17 +236,22 @@ Tor control port to use if onion listening enabled (default:
221236
.IP
222237
Tor control port password (default: empty)
223238
.HP
239+
\fB\-upnp\fR
240+
.IP
241+
Use UPnP to map the listening port (default: 0)
242+
.HP
224243
\fB\-whitebind=\fR<addr>
225244
.IP
226245
Bind to given address and whitelist peers connecting to it. Use
227246
[host]:port notation for IPv6
228247
.HP
229-
\fB\-whitelist=\fR<netmask>
248+
\fB\-whitelist=\fR<IP address or network>
230249
.IP
231-
Whitelist peers connecting from the given netmask or IP address. Can be
232-
specified multiple times. Whitelisted peers cannot be DoS banned
233-
and their transactions are always relayed, even if they are
234-
already in the mempool, useful e.g. for a gateway
250+
Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or
251+
CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple
252+
times. Whitelisted peers cannot be DoS banned and their
253+
transactions are always relayed, even if they are already in the
254+
mempool, useful e.g. for a gateway
235255
.HP
236256
\fB\-whitelistrelay\fR
237257
.IP
@@ -240,7 +260,7 @@ not relaying transactions (default: 1)
240260
.HP
241261
\fB\-whitelistforcerelay\fR
242262
.IP
243-
Force relay of transactions from whitelisted peers even they violate
263+
Force relay of transactions from whitelisted peers even if they violate
244264
local relay policy (default: 1)
245265
.HP
246266
\fB\-maxuploadtarget=\fR<n>
@@ -287,13 +307,17 @@ Spend unconfirmed change when sending transactions (default: 1)
287307
\fB\-txconfirmtarget=\fR<n>
288308
.IP
289309
If paytxfee is not set, include enough fee so transactions begin
290-
confirmation on average within n blocks (default: 2)
310+
confirmation on average within n blocks (default: 6)
291311
.HP
292312
\fB\-usehd\fR
293313
.IP
294314
Use hierarchical deterministic key generation (HD) after BIP32. Only has
295315
effect during wallet creation/first start (default: 1)
296316
.HP
317+
\fB\-walletrbf\fR
318+
.IP
319+
Send transactions with full\-RBF opt\-in enabled (default: 0)
320+
.HP
297321
\fB\-upgradewallet\fR
298322
.IP
299323
Upgrade wallet to latest format on startup
@@ -347,9 +371,9 @@ Append comment to the user agent string
347371
Output debugging information (default: 0, supplying <category> is
348372
optional). If <category> is not supplied or if <category> = 1,
349373
output all debugging information.<category> can be: addrman,
350-
alert, bench, coindb, db, http, libevent, lock, mempool,
351-
mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins,
352-
tor, zmq, qt.
374+
alert, bench, cmpctblock, coindb, db, http, libevent, lock,
375+
mempool, mempoolrej, net, proxy, prune, rand, reindex, rpc,
376+
selectcoins, tor, zmq, qt.
353377
.HP
354378
\fB\-help\-debug\fR
355379
.IP
@@ -422,6 +446,11 @@ Set maximum block size in bytes (default: 750000)
422446
.IP
423447
Set maximum size of high\-priority/low\-fee transactions in bytes
424448
(default: 0)
449+
.HP
450+
\fB\-blockmintxfee=\fR<amt>
451+
.IP
452+
Set lowest fee rate (in BTC/kB) for transactions to be included in block
453+
creation. (default: 0.00001)
425454
.PP
426455
RPC server options:
427456
.HP
@@ -455,8 +484,10 @@ Password for JSON\-RPC connections
455484
.IP
456485
Username and hashed password for JSON\-RPC connections. The field
457486
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
458-
canonical python script is included in share/rpcuser. This option
459-
can be specified multiple times
487+
canonical python script is included in share/rpcuser. The client
488+
then connects normally using the
489+
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
490+
option can be specified multiple times
460491
.HP
461492
\fB\-rpcport=\fR<port>
462493
.IP
@@ -500,16 +531,16 @@ Show splash screen on startup (default: 1)
500531
.IP
501532
Reset all settings changed in the GUI
502533
.SH COPYRIGHT
503-
Copyright (C) 2009-2016 The Bitcoin Core developers
534+
Copyright (C) 2009-2017 The Bitcoin Core developers
504535

505536
Please contribute if you find Bitcoin Core useful. Visit
506537
<https://bitcoincore.org> for further information about the software.
507538
The source code is available from <https://github.com/bitcoin/bitcoin>.
508539

509540
This is experimental software.
510541
Distributed under the MIT software license, see the accompanying file COPYING
511-
or <http://www.opensource.org/licenses/mit-license.php>.
542+
or <https://opensource.org/licenses/MIT>
512543

513544
This product includes software developed by the OpenSSL Project for use in the
514-
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
515-
by Eric Young and UPnP software written by Thomas Bernard.
545+
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
546+
Eric Young and UPnP software written by Thomas Bernard.

‎doc/man/bitcoin-tx.1‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
2-
.TH BITCOIN-TX "1" "September 2016" "bitcoin-tx v0.13.0.0" "User Commands"
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2+
.TH BITCOIN-TX "1" "February 2017" "bitcoin-tx v0.14.99.0" "User Commands"
33
.SH NAME
4-
bitcoin-tx \- manual page for bitcoin-tx v0.13.0.0
4+
bitcoin-tx \- manual page for bitcoin-tx v0.14.99.0
55
.SH DESCRIPTION
6-
Bitcoin Core bitcoin\-tx utility version v0.13.0.0
6+
Bitcoin Core bitcoin\-tx utility version v0.14.99.0
77
.SS "Usage:"
88
.TP
99
bitcoin\-tx [options] <hex\-tx> [commands]
@@ -67,13 +67,28 @@ outaddr=VALUE:ADDRESS
6767
.IP
6868
Add address\-based output to TX
6969
.IP
70+
outpubkey=VALUE:PUBKEY[:FLAGS]
71+
.IP
72+
Add pay\-to\-pubkey output to TX. Optionally add the "W" flag to produce a
73+
pay\-to\-witness\-pubkey\-hash output. Optionally add the "S" flag to
74+
wrap the output in a pay\-to\-script\-hash.
75+
.IP
7076
outdata=[VALUE:]DATA
7177
.IP
7278
Add data\-based output to TX
7379
.IP
74-
outscript=VALUE:SCRIPT
80+
outscript=VALUE:SCRIPT[:FLAGS]
81+
.IP
82+
Add raw script output to TX. Optionally add the "W" flag to produce a
83+
pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to
84+
wrap the output in a pay\-to\-script\-hash.
85+
.IP
86+
outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS]
7587
.IP
76-
Add raw script output to TX
88+
Add Pay To n\-of\-m Multi\-sig output to TX. n = REQUIRED, m = PUBKEYS.
89+
Optionally add the "W" flag to produce a
90+
pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to
91+
wrap the output in a pay\-to\-script\-hash.
7792
.IP
7893
sign=SIGHASH\-FLAGS
7994
.IP
@@ -92,16 +107,16 @@ set=NAME:JSON\-STRING
92107
.IP
93108
Set register NAME to given JSON\-STRING
94109
.SH COPYRIGHT
95-
Copyright (C) 2009-2016 The Bitcoin Core developers
110+
Copyright (C) 2009-2017 The Bitcoin Core developers
96111

97112
Please contribute if you find Bitcoin Core useful. Visit
98113
<https://bitcoincore.org> for further information about the software.
99114
The source code is available from <https://github.com/bitcoin/bitcoin>.
100115

101116
This is experimental software.
102117
Distributed under the MIT software license, see the accompanying file COPYING
103-
or <http://www.opensource.org/licenses/mit-license.php>.
118+
or <https://opensource.org/licenses/MIT>
104119

105120
This product includes software developed by the OpenSSL Project for use in the
106-
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
107-
by Eric Young and UPnP software written by Thomas Bernard.
121+
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
122+
Eric Young and UPnP software written by Thomas Bernard.

0 commit comments

Comments
 (0)