aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/bitcoin-cli.127
-rw-r--r--doc/man/bitcoin-qt.1115
-rw-r--r--doc/man/bitcoin-tx.111
-rw-r--r--doc/man/bitcoind.1115
4 files changed, 156 insertions, 112 deletions
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1
index 0493241b1e..6787638443 100644
--- a/doc/man/bitcoin-cli.1
+++ b/doc/man/bitcoin-cli.1
@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
-.TH BITCOIN-CLI "1" "February 2017" "bitcoin-cli v0.14.99.0" "User Commands"
+.TH BITCOIN-CLI "1" "September 2017" "bitcoin-cli v0.15.99.0" "User Commands"
.SH NAME
-bitcoin-cli \- manual page for bitcoin-cli v0.14.99.0
+bitcoin-cli \- manual page for bitcoin-cli v0.15.99.0
.SH DESCRIPTION
-Bitcoin Core RPC client version v0.14.99.0
+Bitcoin Core RPC client version v0.15.99.0
.SS "Usage:"
.TP
bitcoin\-cli [options] <command> [params]
@@ -64,12 +64,29 @@ Password for JSON\-RPC connections
.HP
\fB\-rpcclienttimeout=\fR<n>
.IP
-Timeout during HTTP requests (default: 900)
+Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
+900)
+.HP
+\fB\-stdinrpcpass\fR
+.TP
+Read RPC password from standard input as a single line.
+When combined
+.IP
+with \fB\-stdin\fR, the first line from standard input is used for the
+RPC password.
.HP
\fB\-stdin\fR
.IP
Read extra arguments from standard input, one per line until EOF/Ctrl\-D
-(recommended for sensitive information such as passphrases)
+(recommended for sensitive information such as passphrases).
+When combined with \fB\-stdinrpcpass\fR, the first line from standard
+input is used for the RPC password.
+.HP
+\fB\-rpcwallet=\fR<walletname>
+.IP
+Send RPC for non\-default wallet on RPC server (argument is wallet
+filename in bitcoind directory, required if bitcoind/\-Qt runs
+with multiple wallets)
.SH COPYRIGHT
Copyright (C) 2009-2017 The Bitcoin Core developers
diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1
index ce252612e5..ae35d50ac3 100644
--- a/doc/man/bitcoin-qt.1
+++ b/doc/man/bitcoin-qt.1
@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
-.TH BITCOIN-QT "1" "February 2017" "bitcoin-qt v0.14.99.0" "User Commands"
+.TH BITCOIN-QT "1" "September 2017" "bitcoin-qt v0.15.99.0" "User Commands"
.SH NAME
-bitcoin-qt \- manual page for bitcoin-qt v0.14.99.0
+bitcoin-qt \- manual page for bitcoin-qt v0.15.99.0
.SH DESCRIPTION
-Bitcoin Core version v0.14.99.0 (64\-bit)
+Bitcoin Core version v0.15.99.0 (64\-bit)
Usage:
.IP
bitcoin\-qt [command\-line options]
@@ -32,9 +32,9 @@ block hash)
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,
+0000000000000000003b9ce759c2a087d52abc4266f8f4ebd6d768b89defa50a,
testnet:
-00000000000128796ee387cf110ccb9d2f36cffaf7f73079c995377c65ac0dcc)
+0000000002e9e7b00e1f6dc5123a04aad68dd0f0968d8c7aa45f6640795c37b1)
.HP
\fB\-conf=\fR<file>
.IP
@@ -46,7 +46,7 @@ Specify data directory
.HP
\fB\-dbcache=\fR<n>
.IP
-Set database cache size in megabytes (4 to 16384, default: 300)
+Set database cache size in megabytes (4 to 16384, default: 450)
.HP
\fB\-loadblock=\fR<file>
.IP
@@ -65,6 +65,10 @@ Keep the transaction memory pool below <n> megabytes (default: 300)
Do not keep transactions in the mempool longer than <n> hours (default:
336)
.HP
+\fB\-persistmempool\fR
+.IP
+Whether to save the mempool on shutdown and load on restart (default: 1)
+.HP
\fB\-blockreconstructionextratxn=\fR<n>
.IP
Extra transactions to keep in memory for compact block reconstructions
@@ -131,8 +135,8 @@ for IPv6
.HP
\fB\-connect=\fR<ip>
.IP
-Connect only to the specified node(s); \fB\-noconnect\fR or \fB\-connect\fR=\fI\,0\/\fR alone to
-disable automatic connections
+Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic
+connections
.HP
\fB\-discover\fR
.IP
@@ -146,7 +150,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/\-noconnect)
+unless \fB\-connect\fR used)
.HP
\fB\-externalip=\fR<ip>
.IP
@@ -158,8 +162,7 @@ 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/\-noconnect)
+Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
.HP
\fB\-listenonion\fR
.IP
@@ -214,11 +217,6 @@ 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
@@ -253,16 +251,6 @@ 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
-Accept relayed transactions received from whitelisted peers even when
-not relaying transactions (default: 1)
-.HP
-\fB\-whitelistforcerelay\fR
-.IP
-Force relay of transactions from whitelisted peers even if they violate
-local relay policy (default: 1)
-.HP
\fB\-maxuploadtarget=\fR<n>
.IP
Tries to keep outbound traffic under the given target (in MiB per 24h),
@@ -276,13 +264,21 @@ Do not load the wallet and disable wallet RPC calls
.HP
\fB\-keypool=\fR<n>
.IP
-Set key pool size to <n> (default: 100)
+Set key pool size to <n> (default: 1000)
.HP
\fB\-fallbackfee=\fR<amt>
.IP
A fee rate (in BTC/kB) that will be used when fee estimation has
insufficient data (default: 0.0002)
.HP
+\fB\-discardfee=\fR<amt>
+.IP
+The fee rate (in BTC/kB) that indicates your tolerance for discarding
+change by adding it to the fee (default: 0.0001). Note: An output
+is discarded if it is dust at this rate, but we will always
+discard up to the dust relay fee and a discard fee above that is
+limited by the fee estimate for the longest target
+.HP
\fB\-mintxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for
@@ -309,11 +305,6 @@ Spend unconfirmed change when sending transactions (default: 1)
If paytxfee is not set, include enough fee so transactions begin
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)
@@ -370,10 +361,16 @@ Append comment to the user agent string
.IP
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, cmpctblock, coindb, db, http, libevent, lock,
-mempool, mempoolrej, net, proxy, prune, rand, reindex, rpc,
-selectcoins, tor, zmq, qt.
+output all debugging information. <category> can be: net, tor,
+mempool, http, bench, zmq, db, rpc, estimatefee, addrman,
+selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej,
+libevent, coindb, qt, leveldb.
+.HP
+\fB\-debugexclude=\fR<category>
+.IP
+Exclude debugging information for a category. Can be used in conjunction
+with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one
+or more specified categories.
.HP
\fB\-help\-debug\fR
.IP
@@ -387,11 +384,6 @@ Include IP addresses in debug output (default: 0)
.IP
Prepend debug output with timestamp (default: 1)
.HP
-\fB\-minrelaytxfee=\fR<amt>
-.IP
-Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
-mining and transaction creation (default: 0.00001)
-.HP
\fB\-maxtxfee=\fR<amt>
.IP
Maximum total fees (in BTC) to use in a single wallet transaction or raw
@@ -431,21 +423,32 @@ Maximum size of data in data carrier transactions we relay and mine
\fB\-mempoolreplacement\fR
.IP
Enable transaction replacement in the memory pool (default: 1)
+.HP
+\fB\-minrelaytxfee=\fR<amt>
+.IP
+Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
+mining and transaction creation (default: 0.00001)
+.HP
+\fB\-whitelistrelay\fR
+.IP
+Accept relayed transactions received from whitelisted peers even when
+not relaying transactions (default: 1)
+.HP
+\fB\-whitelistforcerelay\fR
+.IP
+Force relay of transactions from whitelisted peers even if they violate
+local relay policy (default: 1)
.PP
Block creation options:
.HP
\fB\-blockmaxweight=\fR<n>
.IP
-Set maximum BIP141 block weight (default: 3000000)
+Set maximum BIP141 block weight (default: 3996000)
.HP
\fB\-blockmaxsize=\fR<n>
.IP
-Set maximum block size in bytes (default: 750000)
-.HP
-\fB\-blockprioritysize=\fR<n>
-.IP
-Set maximum size of high\-priority/low\-fee transactions in bytes
-(default: 0)
+Set maximum BIP141 block weight to this * 4. Deprecated, use
+blockmaxweight
.HP
\fB\-blockmintxfee=\fR<amt>
.IP
@@ -462,11 +465,14 @@ Accept command line and JSON\-RPC commands
.IP
Accept public REST requests (default: 0)
.HP
-\fB\-rpcbind=\fR<addr>
+\fB\-rpcbind=\fR<addr>[:port]
.IP
-Bind to given address to listen for JSON\-RPC connections. Use
-[host]:port notation for IPv6. This option can be specified
-multiple times (default: bind to all interfaces)
+Bind to given address to listen for JSON\-RPC connections. This option is
+ignored unless \fB\-rpcallowip\fR is also passed. Port is optional and
+overrides \fB\-rpcport\fR. Use [host]:port notation for IPv6. This
+option can be specified multiple times (default: 127.0.0.1 and
+::1 i.e., localhost, or if \fB\-rpcallowip\fR has been specified,
+0.0.0.0 and :: i.e., all addresses)
.HP
\fB\-rpccookiefile=\fR<loc>
.IP
@@ -501,6 +507,11 @@ single IP (e.g. 1.2.3.4), a network/netmask (e.g.
1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
option can be specified multiple times
.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\-rpcthreads=\fR<n>
.IP
Set the number of threads to service RPC calls (default: 4)
diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1
index 98adf2f5b1..8b72fbde05 100644
--- a/doc/man/bitcoin-tx.1
+++ b/doc/man/bitcoin-tx.1
@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
-.TH BITCOIN-TX "1" "February 2017" "bitcoin-tx v0.14.99.0" "User Commands"
+.TH BITCOIN-TX "1" "September 2017" "bitcoin-tx v0.15.99.0" "User Commands"
.SH NAME
-bitcoin-tx \- manual page for bitcoin-tx v0.14.99.0
+bitcoin-tx \- manual page for bitcoin-tx v0.15.99.0
.SH DESCRIPTION
-Bitcoin Core bitcoin\-tx utility version v0.14.99.0
+Bitcoin Core bitcoin\-tx utility version v0.15.99.0
.SS "Usage:"
.TP
bitcoin\-tx [options] <hex\-tx> [commands]
@@ -63,6 +63,11 @@ nversion=N
.IP
Set TX version to N
.IP
+replaceable(=N)
+.IP
+Set RBF opt\-in sequence number for input N (if not provided, opt\-in all
+available inputs)
+.IP
outaddr=VALUE:ADDRESS
.IP
Add address\-based output to TX
diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1
index fb066e0c6f..baf747436f 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.47.4.
-.TH BITCOIND "1" "February 2017" "bitcoind v0.14.99.0" "User Commands"
+.TH BITCOIND "1" "September 2017" "bitcoind v0.15.99.0" "User Commands"
.SH NAME
-bitcoind \- manual page for bitcoind v0.14.99.0
+bitcoind \- manual page for bitcoind v0.15.99.0
.SH DESCRIPTION
-Bitcoin Core Daemon version v0.14.99.0
+Bitcoin Core Daemon version v0.15.99.0
.SS "Usage:"
.TP
bitcoind [options]
@@ -33,9 +33,9 @@ block hash)
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,
+0000000000000000003b9ce759c2a087d52abc4266f8f4ebd6d768b89defa50a,
testnet:
-00000000000128796ee387cf110ccb9d2f36cffaf7f73079c995377c65ac0dcc)
+0000000002e9e7b00e1f6dc5123a04aad68dd0f0968d8c7aa45f6640795c37b1)
.HP
\fB\-conf=\fR<file>
.IP
@@ -51,7 +51,7 @@ Specify data directory
.HP
\fB\-dbcache=\fR<n>
.IP
-Set database cache size in megabytes (4 to 16384, default: 300)
+Set database cache size in megabytes (4 to 16384, default: 450)
.HP
\fB\-loadblock=\fR<file>
.IP
@@ -70,6 +70,10 @@ Keep the transaction memory pool below <n> megabytes (default: 300)
Do not keep transactions in the mempool longer than <n> hours (default:
336)
.HP
+\fB\-persistmempool\fR
+.IP
+Whether to save the mempool on shutdown and load on restart (default: 1)
+.HP
\fB\-blockreconstructionextratxn=\fR<n>
.IP
Extra transactions to keep in memory for compact block reconstructions
@@ -136,8 +140,8 @@ for IPv6
.HP
\fB\-connect=\fR<ip>
.IP
-Connect only to the specified node(s); \fB\-noconnect\fR or \fB\-connect\fR=\fI\,0\/\fR alone to
-disable automatic connections
+Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic
+connections
.HP
\fB\-discover\fR
.IP
@@ -151,7 +155,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/\-noconnect)
+unless \fB\-connect\fR used)
.HP
\fB\-externalip=\fR<ip>
.IP
@@ -163,8 +167,7 @@ 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/\-noconnect)
+Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
.HP
\fB\-listenonion\fR
.IP
@@ -219,11 +222,6 @@ 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
@@ -258,16 +256,6 @@ 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
-Accept relayed transactions received from whitelisted peers even when
-not relaying transactions (default: 1)
-.HP
-\fB\-whitelistforcerelay\fR
-.IP
-Force relay of transactions from whitelisted peers even if they violate
-local relay policy (default: 1)
-.HP
\fB\-maxuploadtarget=\fR<n>
.IP
Tries to keep outbound traffic under the given target (in MiB per 24h),
@@ -281,13 +269,21 @@ Do not load the wallet and disable wallet RPC calls
.HP
\fB\-keypool=\fR<n>
.IP
-Set key pool size to <n> (default: 100)
+Set key pool size to <n> (default: 1000)
.HP
\fB\-fallbackfee=\fR<amt>
.IP
A fee rate (in BTC/kB) that will be used when fee estimation has
insufficient data (default: 0.0002)
.HP
+\fB\-discardfee=\fR<amt>
+.IP
+The fee rate (in BTC/kB) that indicates your tolerance for discarding
+change by adding it to the fee (default: 0.0001). Note: An output
+is discarded if it is dust at this rate, but we will always
+discard up to the dust relay fee and a discard fee above that is
+limited by the fee estimate for the longest target
+.HP
\fB\-mintxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for
@@ -314,11 +310,6 @@ Spend unconfirmed change when sending transactions (default: 1)
If paytxfee is not set, include enough fee so transactions begin
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)
@@ -375,10 +366,16 @@ Append comment to the user agent string
.IP
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, cmpctblock, coindb, db, http, libevent, lock,
-mempool, mempoolrej, net, proxy, prune, rand, reindex, rpc,
-selectcoins, tor, zmq.
+output all debugging information. <category> can be: net, tor,
+mempool, http, bench, zmq, db, rpc, estimatefee, addrman,
+selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej,
+libevent, coindb, qt, leveldb.
+.HP
+\fB\-debugexclude=\fR<category>
+.IP
+Exclude debugging information for a category. Can be used in conjunction
+with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one
+or more specified categories.
.HP
\fB\-help\-debug\fR
.IP
@@ -392,11 +389,6 @@ Include IP addresses in debug output (default: 0)
.IP
Prepend debug output with timestamp (default: 1)
.HP
-\fB\-minrelaytxfee=\fR<amt>
-.IP
-Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
-mining and transaction creation (default: 0.00001)
-.HP
\fB\-maxtxfee=\fR<amt>
.IP
Maximum total fees (in BTC) to use in a single wallet transaction or raw
@@ -436,21 +428,32 @@ Maximum size of data in data carrier transactions we relay and mine
\fB\-mempoolreplacement\fR
.IP
Enable transaction replacement in the memory pool (default: 1)
+.HP
+\fB\-minrelaytxfee=\fR<amt>
+.IP
+Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
+mining and transaction creation (default: 0.00001)
+.HP
+\fB\-whitelistrelay\fR
+.IP
+Accept relayed transactions received from whitelisted peers even when
+not relaying transactions (default: 1)
+.HP
+\fB\-whitelistforcerelay\fR
+.IP
+Force relay of transactions from whitelisted peers even if they violate
+local relay policy (default: 1)
.PP
Block creation options:
.HP
\fB\-blockmaxweight=\fR<n>
.IP
-Set maximum BIP141 block weight (default: 3000000)
+Set maximum BIP141 block weight (default: 3996000)
.HP
\fB\-blockmaxsize=\fR<n>
.IP
-Set maximum block size in bytes (default: 750000)
-.HP
-\fB\-blockprioritysize=\fR<n>
-.IP
-Set maximum size of high\-priority/low\-fee transactions in bytes
-(default: 0)
+Set maximum BIP141 block weight to this * 4. Deprecated, use
+blockmaxweight
.HP
\fB\-blockmintxfee=\fR<amt>
.IP
@@ -467,11 +470,14 @@ Accept command line and JSON\-RPC commands
.IP
Accept public REST requests (default: 0)
.HP
-\fB\-rpcbind=\fR<addr>
+\fB\-rpcbind=\fR<addr>[:port]
.IP
-Bind to given address to listen for JSON\-RPC connections. Use
-[host]:port notation for IPv6. This option can be specified
-multiple times (default: bind to all interfaces)
+Bind to given address to listen for JSON\-RPC connections. This option is
+ignored unless \fB\-rpcallowip\fR is also passed. Port is optional and
+overrides \fB\-rpcport\fR. Use [host]:port notation for IPv6. This
+option can be specified multiple times (default: 127.0.0.1 and
+::1 i.e., localhost, or if \fB\-rpcallowip\fR has been specified,
+0.0.0.0 and :: i.e., all addresses)
.HP
\fB\-rpccookiefile=\fR<loc>
.IP
@@ -506,6 +512,11 @@ single IP (e.g. 1.2.3.4), a network/netmask (e.g.
1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
option can be specified multiple times
.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\-rpcthreads=\fR<n>
.IP
Set the number of threads to service RPC calls (default: 4)