aboutsummaryrefslogtreecommitdiff
path: root/doc/man/bitcoind.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/bitcoind.1')
-rw-r--r--doc/man/bitcoind.1105
1 files changed, 69 insertions, 36 deletions
diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1
index b99657a5fa..fb066e0c6f 100644
--- a/doc/man/bitcoind.1
+++ b/doc/man/bitcoind.1
@@ -1,9 +1,9 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
-.TH BITCOIND "1" "September 2016" "bitcoind v0.13.0.0" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
+.TH BITCOIND "1" "February 2017" "bitcoind v0.14.99.0" "User Commands"
.SH NAME
-bitcoind \- manual page for bitcoind v0.13.0.0
+bitcoind \- manual page for bitcoind v0.14.99.0
.SH DESCRIPTION
-Bitcoin Core Daemon version v0.13.0.0
+Bitcoin Core Daemon version v0.14.99.0
.SS "Usage:"
.TP
bitcoind [options]
@@ -28,13 +28,14 @@ long fork (%s in cmd is replaced by message)
Execute command when the best block changes (%s in cmd is replaced by
block hash)
.HP
-\fB\-checkblocks=\fR<n>
+\fB\-assumevalid=\fR<hex>
.IP
-How many blocks to check at startup (default: 288, 0 = all)
-.HP
-\fB\-checklevel=\fR<n>
-.IP
-How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3)
+If this block is in the chain assume that it and its ancestors are valid
+and potentially skip their script verification (0 to verify all,
+default:
+00000000000000000013176bf8d7dfeab4e1db31dc93bc311b436e82ab226b90,
+testnet:
+00000000000128796ee387cf110ccb9d2f36cffaf7f73079c995377c65ac0dcc)
.HP
\fB\-conf=\fR<file>
.IP
@@ -67,11 +68,16 @@ Keep the transaction memory pool below <n> megabytes (default: 300)
\fB\-mempoolexpiry=\fR<n>
.IP
Do not keep transactions in the mempool longer than <n> hours (default:
-72)
+336)
+.HP
+\fB\-blockreconstructionextratxn=\fR<n>
+.IP
+Extra transactions to keep in memory for compact block reconstructions
+(default: 100)
.HP
\fB\-par=\fR<n>
.IP
-Set the number of script verification threads (\fB\-4\fR to 16, 0 = auto, <0 =
+Set the number of script verification threads (\fB\-2\fR to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-pid=\fR<file>
@@ -80,11 +86,15 @@ Specify pid file (default: bitcoind.pid)
.HP
\fB\-prune=\fR<n>
.IP
-Reduce storage requirements by pruning (deleting) old blocks. This mode
-is incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting
-this setting requires re\-downloading the entire blockchain.
-(default: 0 = disable pruning blocks, >550 = target size in MiB
-to use for block files)
+Reduce storage requirements by enabling pruning (deleting) of old
+blocks. This allows the pruneblockchain RPC to be called to
+delete specific blocks, and enables automatic pruning of old
+blocks if a target size in MiB is provided. This mode is
+incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this
+setting requires re\-downloading the entire blockchain. (default:
+0 = disable pruning blocks, 1 = allow manual pruning via RPC,
+>550 = automatically prune block files to stay under the
+specified target size in MiB)
.HP
\fB\-reindex\-chainstate\fR
.IP
@@ -126,7 +136,8 @@ for IPv6
.HP
\fB\-connect=\fR<ip>
.IP
-Connect only to the specified node(s)
+Connect only to the specified node(s); \fB\-noconnect\fR or \fB\-connect\fR=\fI\,0\/\fR alone to
+disable automatic connections
.HP
\fB\-discover\fR
.IP
@@ -140,7 +151,7 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def
\fB\-dnsseed\fR
.IP
Query for peer addresses via DNS lookup, if low on addresses (default: 1
-unless \fB\-connect\fR)
+unless \fB\-connect\fR/\-noconnect)
.HP
\fB\-externalip=\fR<ip>
.IP
@@ -152,7 +163,8 @@ Always query for peer addresses via DNS lookup (default: 0)
.HP
\fB\-listen\fR
.IP
-Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
+Accept connections from outside (default: 1 if no \fB\-proxy\fR or
+\fB\-connect\fR/\-noconnect)
.HP
\fB\-listenonion\fR
.IP
@@ -207,6 +219,11 @@ Connect through SOCKS5 proxy
Randomize credentials for every proxy connection. This enables Tor
stream isolation (default: 1)
.HP
+\fB\-rpcserialversion\fR
+.IP
+Sets the serialization of raw transaction or block hex returned in
+non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1)
+.HP
\fB\-seednode=\fR<ip>
.IP
Connect to a node to retrieve peer addresses, and disconnect
@@ -224,17 +241,22 @@ Tor control port to use if onion listening enabled (default:
.IP
Tor control port password (default: empty)
.HP
+\fB\-upnp\fR
+.IP
+Use UPnP to map the listening port (default: 0)
+.HP
\fB\-whitebind=\fR<addr>
.IP
Bind to given address and whitelist peers connecting to it. Use
[host]:port notation for IPv6
.HP
-\fB\-whitelist=\fR<netmask>
+\fB\-whitelist=\fR<IP address or network>
.IP
-Whitelist peers connecting from the given netmask or IP address. Can be
-specified multiple times. Whitelisted peers cannot be DoS banned
-and their transactions are always relayed, even if they are
-already in the mempool, useful e.g. for a gateway
+Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or
+CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple
+times. Whitelisted peers cannot be DoS banned and their
+transactions are always relayed, even if they are already in the
+mempool, useful e.g. for a gateway
.HP
\fB\-whitelistrelay\fR
.IP
@@ -243,7 +265,7 @@ not relaying transactions (default: 1)
.HP
\fB\-whitelistforcerelay\fR
.IP
-Force relay of transactions from whitelisted peers even they violate
+Force relay of transactions from whitelisted peers even if they violate
local relay policy (default: 1)
.HP
\fB\-maxuploadtarget=\fR<n>
@@ -290,13 +312,17 @@ Spend unconfirmed change when sending transactions (default: 1)
\fB\-txconfirmtarget=\fR<n>
.IP
If paytxfee is not set, include enough fee so transactions begin
-confirmation on average within n blocks (default: 2)
+confirmation on average within n blocks (default: 6)
.HP
\fB\-usehd\fR
.IP
Use hierarchical deterministic key generation (HD) after BIP32. Only has
effect during wallet creation/first start (default: 1)
.HP
+\fB\-walletrbf\fR
+.IP
+Send transactions with full\-RBF opt\-in enabled (default: 0)
+.HP
\fB\-upgradewallet\fR
.IP
Upgrade wallet to latest format on startup
@@ -350,9 +376,9 @@ Append comment to the user agent string
Output debugging information (default: 0, supplying <category> is
optional). If <category> is not supplied or if <category> = 1,
output all debugging information.<category> can be: addrman,
-alert, bench, coindb, db, http, libevent, lock, mempool,
-mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins,
-tor, zmq.
+alert, bench, cmpctblock, coindb, db, http, libevent, lock,
+mempool, mempoolrej, net, proxy, prune, rand, reindex, rpc,
+selectcoins, tor, zmq.
.HP
\fB\-help\-debug\fR
.IP
@@ -425,6 +451,11 @@ Set maximum block size in bytes (default: 750000)
.IP
Set maximum size of high\-priority/low\-fee transactions in bytes
(default: 0)
+.HP
+\fB\-blockmintxfee=\fR<amt>
+.IP
+Set lowest fee rate (in BTC/kB) for transactions to be included in block
+creation. (default: 0.00001)
.PP
RPC server options:
.HP
@@ -458,8 +489,10 @@ Password for JSON\-RPC connections
.IP
Username and hashed password for JSON\-RPC connections. The field
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
-canonical python script is included in share/rpcuser. This option
-can be specified multiple times
+canonical python script is included in share/rpcuser. The client
+then connects normally using the
+rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
+option can be specified multiple times
.HP
\fB\-rpcport=\fR<port>
.IP
@@ -477,7 +510,7 @@ option can be specified multiple times
.IP
Set the number of threads to service RPC calls (default: 4)
.SH COPYRIGHT
-Copyright (C) 2009-2016 The Bitcoin Core developers
+Copyright (C) 2009-2017 The Bitcoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
<https://bitcoincore.org> for further information about the software.
@@ -485,8 +518,8 @@ The source code is available from <https://github.com/bitcoin/bitcoin>.
This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
-or <http://www.opensource.org/licenses/mit-license.php>.
+or <https://opensource.org/licenses/MIT>
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.
+OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
+Eric Young and UPnP software written by Thomas Bernard.