aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/man/bitcoin-cli.115
-rw-r--r--doc/man/bitcoin-qt.1101
-rw-r--r--doc/man/bitcoin-tx.115
-rw-r--r--doc/man/bitcoin-wallet.115
-rw-r--r--doc/man/bitcoind.1102
5 files changed, 183 insertions, 65 deletions
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1
index 95c1d24dff..5ff6e5e2cb 100644
--- a/doc/man/bitcoin-cli.1
+++ b/doc/man/bitcoin-cli.1
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
-.TH BITCOIN-CLI "1" "February 2019" "bitcoin-cli v0.17.99.0" "User Commands"
+.TH BITCOIN-CLI "1" "October 2019" "bitcoin-cli v0.19.0.0" "User Commands"
.SH NAME
-bitcoin-cli \- manual page for bitcoin-cli v0.17.99.0
+bitcoin-cli \- manual page for bitcoin-cli v0.19.0.0
.SH SYNOPSIS
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
@@ -15,7 +15,7 @@ bitcoin-cli \- manual page for bitcoin-cli v0.17.99.0
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
-Bitcoin Core RPC client version v0.17.99.0
+Bitcoin Core RPC client version v0.19.0.0
.SH OPTIONS
.HP
\-?
@@ -98,11 +98,18 @@ RPC password.
.IP
Print version and exit
.PP
+Debugging/Testing options:
+.PP
Chain selection options:
.HP
+\fB\-chain=\fR<chain>
+.IP
+Use the chain <chain> (default: main). Allowed values: main, test,
+regtest
+.HP
\fB\-testnet\fR
.IP
-Use the test chain
+Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.SH COPYRIGHT
Copyright (C) 2009-2019 The Bitcoin Core developers
diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1
index 1e8443b1d3..12238d2aa5 100644
--- a/doc/man/bitcoin-qt.1
+++ b/doc/man/bitcoin-qt.1
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
-.TH BITCOIN-QT "1" "February 2019" "bitcoin-qt v0.17.99.0" "User Commands"
+.TH BITCOIN-QT "1" "October 2019" "bitcoin-qt v0.19.0.0" "User Commands"
.SH NAME
-bitcoin-qt \- manual page for bitcoin-qt v0.17.99.0
+bitcoin-qt \- manual page for bitcoin-qt v0.19.0.0
.SH SYNOPSIS
.B bitcoin-qt
[\fI\,command-line options\/\fR]
.SH DESCRIPTION
-Bitcoin Core version v0.17.99.0 (64\-bit)
+Bitcoin Core version v0.19.0.0 (64\-bit)
.SH OPTIONS
.HP
\-?
@@ -23,9 +23,15 @@ long fork (%s in cmd is replaced by message)
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:
-0000000000000000002e63058c023a9a1de233554f28c7b21380b6c9003f36a8,
+00000000000000000005f8920febd3925f8272a6a71237563d78c2edfdd09ddf,
testnet:
-0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75)
+00000000000000b7ab6ce61eb6d571003fbe5fe892da4c9b740c49a07542462d)
+.HP
+\fB\-blockfilterindex=\fR<type>
+.IP
+Maintain an index of compact filters by block (default: 0, values:
+basic). If <type> is not supplied or if <type> = 1, indexes for
+all known types are enabled.
.HP
\fB\-blocknotify=\fR<cmd>
.IP
@@ -39,7 +45,14 @@ Extra transactions to keep in memory for compact block reconstructions
.HP
\fB\-blocksdir=\fR<dir>
.IP
-Specify blocks directory (default: <datadir>/blocks)
+Specify directory to hold blocks subdirectory for *.dat files (default:
+<datadir>)
+.HP
+\fB\-blocksonly\fR
+.IP
+Whether to reject transactions from network peers. Transactions from the
+wallet, RPC and relay whitelisted inbound peers are not affected.
+(default: 0)
.HP
\fB\-conf=\fR<file>
.IP
@@ -56,7 +69,9 @@ Specify data directory
.HP
\fB\-dbcache=\fR<n>
.IP
-Set database cache size in MiB (4 to 16384, default: 450)
+Maximum database cache size <n> MiB (4 to 16384, default: 450). In
+addition, unused mempool memory is shared for this cache (see
+\fB\-maxmempool\fR).
.HP
\fB\-debuglogfile=\fR<file>
.IP
@@ -88,7 +103,7 @@ Do not keep transactions in the mempool longer than <n> hours (default:
.HP
\fB\-par=\fR<n>
.IP
-Set the number of script verification threads (\fB\-8\fR to 16, 0 = auto, <0 =
+Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-persistmempool\fR
@@ -237,7 +252,7 @@ networks.
\fB\-peerbloomfilters\fR
.IP
Support filtering of blocks and transaction with bloom filters (default:
-1)
+0)
.HP
\fB\-permitbaremultisig\fR
.IP
@@ -281,18 +296,22 @@ Tor control port password (default: empty)
.IP
Use UPnP to map the listening port (default: 0)
.HP
-\fB\-whitebind=\fR<addr>
+\fB\-whitebind=\fR<[permissions@]addr>
.IP
Bind to given address and whitelist peers connecting to it. Use
-[host]:port notation for IPv6
+[host]:port notation for IPv6. Allowed permissions are
+bloomfilter (allow requesting BIP37 filtered blocks and
+transactions), noban (do not ban for misbehavior), forcerelay
+(relay even non\-standard transactions), relay (relay even in
+\fB\-blocksonly\fR mode), and mempool (allow requesting BIP35 mempool
+contents). Specify multiple permissions separated by commas
+(default: noban,mempool,relay). Can be specified multiple times.
.HP
-\fB\-whitelist=\fR<IP address or network>
+\fB\-whitelist=\fR<[permissions@]IP address or network>
.IP
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
+CIDR notated network(e.g. 1.2.3.0/24). Uses same permissions as
+\fB\-whitebind\fR. Can be specified multiple times.
.PP
Wallet options:
.HP
@@ -307,7 +326,8 @@ Group outputs by address, selecting all or none, instead of selecting on
a per\-output basis. Privacy is improved as an address is only
used once (unless someone sends to it after spending from it),
but may result in slightly higher fees as suboptimal coin
-selection may result due to the added limitation (default: 0)
+selection may result due to the added limitation (default: 0
+(always enabled for wallets with "avoid_reuse" enabled))
.HP
\fB\-changetype\fR
.IP
@@ -406,17 +426,35 @@ ZeroMQ notification options:
.IP
Enable publish hash block in <address>
.HP
+\fB\-zmqpubhashblockhwm=\fR<n>
+.IP
+Set publish hash block outbound message high water mark (default: 1000)
+.HP
\fB\-zmqpubhashtx=\fR<address>
.IP
Enable publish hash transaction in <address>
.HP
+\fB\-zmqpubhashtxhwm=\fR<n>
+.IP
+Set publish hash transaction outbound message high water mark (default:
+1000)
+.HP
\fB\-zmqpubrawblock=\fR<address>
.IP
Enable publish raw block in <address>
.HP
+\fB\-zmqpubrawblockhwm=\fR<n>
+.IP
+Set publish raw block outbound message high water mark (default: 1000)
+.HP
\fB\-zmqpubrawtx=\fR<address>
.IP
Enable publish raw transaction in <address>
+.HP
+\fB\-zmqpubrawtxhwm=\fR<n>
+.IP
+Set publish raw transaction outbound message high water mark (default:
+1000)
.PP
Debugging/Testing options:
.HP
@@ -443,15 +481,19 @@ Print help message with debugging options and exit
.IP
Include IP addresses in debug output (default: 0)
.HP
+\fB\-logthreadnames\fR
+.IP
+Prepend debug output with name of the originating thread (only available
+on platforms supporting thread_local) (default: 0)
+.HP
\fB\-logtimestamps\fR
.IP
Prepend debug output with timestamp (default: 1)
.HP
\fB\-maxtxfee=\fR<amt>
.IP
-Maximum total fees (in BTC) to use in a single wallet transaction or raw
-transaction; setting this too low may abort large transactions
-(default: 0.10)
+Maximum total fees (in BTC) to use in a single wallet transaction;
+setting this too low may abort large transactions (default: 0.10)
.HP
\fB\-printtoconsole\fR
.IP
@@ -468,9 +510,14 @@ Append comment to the user agent string
.PP
Chain selection options:
.HP
+\fB\-chain=\fR<chain>
+.IP
+Use the chain <chain> (default: main). Allowed values: main, test,
+regtest
+.HP
\fB\-testnet\fR
.IP
-Use the test chain
+Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.PP
Node relay options:
.HP
@@ -488,7 +535,6 @@ Relay and mine data carrier transactions (default: 1)
Maximum size of data in data carrier transactions we relay and mine
(default: 83)
.HP
-.HP
\fB\-minrelaytxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
@@ -496,13 +542,16 @@ mining and transaction creation (default: 0.00001)
.HP
\fB\-whitelistforcerelay\fR
.IP
-Force relay of transactions from whitelisted peers even if they violate
-local relay policy (default: 0)
+Add 'forcerelay' permission to whitelisted inbound peers with default
+permissions. This will relay transactions even if the
+transactions were already in the mempool or violate local relay
+policy. (default: 0)
.HP
\fB\-whitelistrelay\fR
.IP
-Accept relayed transactions received from whitelisted peers even when
-not relaying transactions (default: 1)
+Add 'relay' permission to whitelisted inbound peers with default
+permissions. The will accept relayed transactions even when not
+relaying transactions (default: 1)
.PP
Block creation options:
.HP
diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1
index 6b6071d9b7..9023d1ace4 100644
--- a/doc/man/bitcoin-tx.1
+++ b/doc/man/bitcoin-tx.1
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
-.TH BITCOIN-TX "1" "February 2019" "bitcoin-tx v0.17.99.0" "User Commands"
+.TH BITCOIN-TX "1" "October 2019" "bitcoin-tx v0.19.0.0" "User Commands"
.SH NAME
-bitcoin-tx \- manual page for bitcoin-tx v0.17.99.0
+bitcoin-tx \- manual page for bitcoin-tx v0.19.0.0
.SH SYNOPSIS
.B bitcoin-tx
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR
@@ -9,7 +9,7 @@ bitcoin-tx \- manual page for bitcoin-tx v0.17.99.0
.B bitcoin-tx
[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR
.SH DESCRIPTION
-Bitcoin Core bitcoin\-tx utility version v0.17.99.0
+Bitcoin Core bitcoin\-tx utility version v0.19.0.0
.SH OPTIONS
.HP
\-?
@@ -28,11 +28,18 @@ Select JSON output
.IP
Output only the hex\-encoded transaction id of the resultant transaction.
.PP
+Debugging/Testing options:
+.PP
Chain selection options:
.HP
+\fB\-chain=\fR<chain>
+.IP
+Use the chain <chain> (default: main). Allowed values: main, test,
+regtest
+.HP
\fB\-testnet\fR
.IP
-Use the test chain
+Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.PP
Commands:
.IP
diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1
index 1cb8cdebcd..f671e29843 100644
--- a/doc/man/bitcoin-wallet.1
+++ b/doc/man/bitcoin-wallet.1
@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
-.TH BITCOIN-WALLET "1" "February 2019" "bitcoin-wallet v0.17.99.0" "User Commands"
+.TH BITCOIN-WALLET "1" "October 2019" "bitcoin-wallet v0.19.0.0" "User Commands"
.SH NAME
-bitcoin-wallet \- manual page for bitcoin-wallet v0.17.99.0
+bitcoin-wallet \- manual page for bitcoin-wallet v0.19.0.0
.SH DESCRIPTION
-Bitcoin Core bitcoin\-wallet version v0.17.99.0
+Bitcoin Core bitcoin\-wallet version v0.19.0.0
.PP
wallet\-tool is an offline tool for creating and interacting with Bitcoin Core wallet files.
By default wallet\-tool will act on wallets in the default mainnet wallet directory in the datadir.
@@ -34,13 +34,18 @@ Output debugging information (default: 0).
\fB\-printtoconsole\fR
.IP
Send trace/debug info to console (default: 1 when no \fB\-debug\fR is true, 0
-otherwise.
+otherwise).
.PP
Chain selection options:
.HP
+\fB\-chain=\fR<chain>
+.IP
+Use the chain <chain> (default: main). Allowed values: main, test,
+regtest
+.HP
\fB\-testnet\fR
.IP
-Use the test chain
+Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.PP
Commands:
.IP
diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1
index 2a79b6cb46..f79fd3a0e0 100644
--- a/doc/man/bitcoind.1
+++ b/doc/man/bitcoind.1
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
-.TH BITCOIND "1" "February 2019" "bitcoind v0.17.99.0" "User Commands"
+.TH BITCOIND "1" "October 2019" "bitcoind v0.19.0.0" "User Commands"
.SH NAME
-bitcoind \- manual page for bitcoind v0.17.99.0
+bitcoind \- manual page for bitcoind v0.19.0.0
.SH SYNOPSIS
.B bitcoind
-[\fI\,options\/\fR] \fI\,Start Bitcoin Core Daemon\/\fR
+[\fI\,options\/\fR] \fI\,Start Bitcoin Core\/\fR
.SH DESCRIPTION
-Bitcoin Core Daemon version v0.17.99.0
+Bitcoin Core version v0.19.0.0
.SH OPTIONS
.HP
\-?
@@ -23,9 +23,15 @@ long fork (%s in cmd is replaced by message)
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:
-0000000000000000002e63058c023a9a1de233554f28c7b21380b6c9003f36a8,
+00000000000000000005f8920febd3925f8272a6a71237563d78c2edfdd09ddf,
testnet:
-0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75)
+00000000000000b7ab6ce61eb6d571003fbe5fe892da4c9b740c49a07542462d)
+.HP
+\fB\-blockfilterindex=\fR<type>
+.IP
+Maintain an index of compact filters by block (default: 0, values:
+basic). If <type> is not supplied or if <type> = 1, indexes for
+all known types are enabled.
.HP
\fB\-blocknotify=\fR<cmd>
.IP
@@ -39,7 +45,14 @@ Extra transactions to keep in memory for compact block reconstructions
.HP
\fB\-blocksdir=\fR<dir>
.IP
-Specify blocks directory (default: <datadir>/blocks)
+Specify directory to hold blocks subdirectory for *.dat files (default:
+<datadir>)
+.HP
+\fB\-blocksonly\fR
+.IP
+Whether to reject transactions from network peers. Transactions from the
+wallet, RPC and relay whitelisted inbound peers are not affected.
+(default: 0)
.HP
\fB\-conf=\fR<file>
.IP
@@ -56,7 +69,9 @@ Specify data directory
.HP
\fB\-dbcache=\fR<n>
.IP
-Set database cache size in MiB (4 to 16384, default: 450)
+Maximum database cache size <n> MiB (4 to 16384, default: 450). In
+addition, unused mempool memory is shared for this cache (see
+\fB\-maxmempool\fR).
.HP
\fB\-debuglogfile=\fR<file>
.IP
@@ -88,7 +103,7 @@ Do not keep transactions in the mempool longer than <n> hours (default:
.HP
\fB\-par=\fR<n>
.IP
-Set the number of script verification threads (\fB\-8\fR to 16, 0 = auto, <0 =
+Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-persistmempool\fR
@@ -237,7 +252,7 @@ networks.
\fB\-peerbloomfilters\fR
.IP
Support filtering of blocks and transaction with bloom filters (default:
-1)
+0)
.HP
\fB\-permitbaremultisig\fR
.IP
@@ -281,18 +296,22 @@ Tor control port password (default: empty)
.IP
Use UPnP to map the listening port (default: 0)
.HP
-\fB\-whitebind=\fR<addr>
+\fB\-whitebind=\fR<[permissions@]addr>
.IP
Bind to given address and whitelist peers connecting to it. Use
-[host]:port notation for IPv6
+[host]:port notation for IPv6. Allowed permissions are
+bloomfilter (allow requesting BIP37 filtered blocks and
+transactions), noban (do not ban for misbehavior), forcerelay
+(relay even non\-standard transactions), relay (relay even in
+\fB\-blocksonly\fR mode), and mempool (allow requesting BIP35 mempool
+contents). Specify multiple permissions separated by commas
+(default: noban,mempool,relay). Can be specified multiple times.
.HP
-\fB\-whitelist=\fR<IP address or network>
+\fB\-whitelist=\fR<[permissions@]IP address or network>
.IP
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
+CIDR notated network(e.g. 1.2.3.0/24). Uses same permissions as
+\fB\-whitebind\fR. Can be specified multiple times.
.PP
Wallet options:
.HP
@@ -307,7 +326,8 @@ Group outputs by address, selecting all or none, instead of selecting on
a per\-output basis. Privacy is improved as an address is only
used once (unless someone sends to it after spending from it),
but may result in slightly higher fees as suboptimal coin
-selection may result due to the added limitation (default: 0)
+selection may result due to the added limitation (default: 0
+(always enabled for wallets with "avoid_reuse" enabled))
.HP
\fB\-changetype\fR
.IP
@@ -406,17 +426,35 @@ ZeroMQ notification options:
.IP
Enable publish hash block in <address>
.HP
+\fB\-zmqpubhashblockhwm=\fR<n>
+.IP
+Set publish hash block outbound message high water mark (default: 1000)
+.HP
\fB\-zmqpubhashtx=\fR<address>
.IP
Enable publish hash transaction in <address>
.HP
+\fB\-zmqpubhashtxhwm=\fR<n>
+.IP
+Set publish hash transaction outbound message high water mark (default:
+1000)
+.HP
\fB\-zmqpubrawblock=\fR<address>
.IP
Enable publish raw block in <address>
.HP
+\fB\-zmqpubrawblockhwm=\fR<n>
+.IP
+Set publish raw block outbound message high water mark (default: 1000)
+.HP
\fB\-zmqpubrawtx=\fR<address>
.IP
Enable publish raw transaction in <address>
+.HP
+\fB\-zmqpubrawtxhwm=\fR<n>
+.IP
+Set publish raw transaction outbound message high water mark (default:
+1000)
.PP
Debugging/Testing options:
.HP
@@ -443,15 +481,19 @@ Print help message with debugging options and exit
.IP
Include IP addresses in debug output (default: 0)
.HP
+\fB\-logthreadnames\fR
+.IP
+Prepend debug output with name of the originating thread (only available
+on platforms supporting thread_local) (default: 0)
+.HP
\fB\-logtimestamps\fR
.IP
Prepend debug output with timestamp (default: 1)
.HP
\fB\-maxtxfee=\fR<amt>
.IP
-Maximum total fees (in BTC) to use in a single wallet transaction or raw
-transaction; setting this too low may abort large transactions
-(default: 0.10)
+Maximum total fees (in BTC) to use in a single wallet transaction;
+setting this too low may abort large transactions (default: 0.10)
.HP
\fB\-printtoconsole\fR
.IP
@@ -468,9 +510,14 @@ Append comment to the user agent string
.PP
Chain selection options:
.HP
+\fB\-chain=\fR<chain>
+.IP
+Use the chain <chain> (default: main). Allowed values: main, test,
+regtest
+.HP
\fB\-testnet\fR
.IP
-Use the test chain
+Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
.PP
Node relay options:
.HP
@@ -495,13 +542,16 @@ mining and transaction creation (default: 0.00001)
.HP
\fB\-whitelistforcerelay\fR
.IP
-Force relay of transactions from whitelisted peers even if they violate
-local relay policy (default: 0)
+Add 'forcerelay' permission to whitelisted inbound peers with default
+permissions. This will relay transactions even if the
+transactions were already in the mempool or violate local relay
+policy. (default: 0)
.HP
\fB\-whitelistrelay\fR
.IP
-Accept relayed transactions received from whitelisted peers even when
-not relaying transactions (default: 1)
+Add 'relay' permission to whitelisted inbound peers with default
+permissions. The will accept relayed transactions even when not
+relaying transactions (default: 1)
.PP
Block creation options:
.HP
generated by cgit v1.2.3 (git 2.26.2) at 2024-11-21 23:00:43 +0000