diff options
author | Wladimir J. van der Laan <laanwj@protonmail.com> | 2020-04-10 19:41:02 +0200 |
---|---|---|
committer | Wladimir J. van der Laan <laanwj@protonmail.com> | 2020-04-10 19:41:14 +0200 |
commit | cd0c99890587e6588160570420d330e80a2b44c1 (patch) | |
tree | 2d60ad299ccf93fc8cd687efeceab8dd03c3d39c | |
parent | 004b0e1b92fc5a2a4de51c5a37c8fd71682ecf9a (diff) |
doc: Update manpages pre-rc1
Tree-SHA512: 2db55d73d5e4531e8e0699b5572c5f10040054e5955aab67992c9bbd764c910124ab9d09125f69dd25699501a2fc514c274619d1bedf08e0363e21e19241b7f2
-rw-r--r-- | doc/man/bitcoin-cli.1 | 29 | ||||
-rw-r--r-- | doc/man/bitcoin-qt.1 | 157 | ||||
-rw-r--r-- | doc/man/bitcoin-tx.1 | 19 | ||||
-rw-r--r-- | doc/man/bitcoin-wallet.1 | 23 | ||||
-rw-r--r-- | doc/man/bitcoind.1 | 154 |
5 files changed, 284 insertions, 98 deletions
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index 129651d8e9..3ae18f2c01 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" "April 2020" "bitcoin-cli v0.20.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.20.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.20.0.0 .SH OPTIONS .HP \-? @@ -92,22 +92,37 @@ is used for the RPC password. .IP Read RPC password from standard input as a single line. When combined with \fB\-stdin\fR, the first line from standard input is used for the -RPC password. +RPC password. When combined with \fB\-stdinwalletpassphrase\fR, +\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR +consumes the second. +.HP +\fB\-stdinwalletpassphrase\fR +.IP +Read wallet passphrase from standard input as a single line. When +combined with \fB\-stdin\fR, the first line from standard input is used +for the wallet passphrase. .HP \fB\-version\fR .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 +Copyright (C) 2009-2020 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit -<https://bitcoincore.org> for further information about the software. +<https://bitcoincore.org/> for further information about the software. The source code is available from <https://github.com/bitcoin/bitcoin>. This is experimental software. diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 index f68be21e8d..1a67558e9e 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" "April 2020" "bitcoin-qt v0.20.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.20.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.20.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, +0000000000000000000f2adce67e49b0b6bdeb9de8b7c3d7e93b21e7fc1e819d, testnet: -0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75) +000000000000056c49030c174179b52a928c870e6e8a822c75973b7970cfbd01) +.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,16 @@ 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. Automatic broadcast +and rebroadcast of any transactions from inbound peers is +disabled, unless '\-whitelistforcerelay' is '1', in which case +whitelisted peers' transactions will be relayed. RPC transactions +are not affected. (default: 0) .HP \fB\-conf=\fR<file> .IP @@ -56,7 +71,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 @@ -71,7 +88,7 @@ Specify additional configuration file, relative to the \fB\-datadir\fR path .HP \fB\-loadblock=\fR<file> .IP -Imports blocks from external blk000??.dat file on startup +Imports blocks from external file on startup .HP \fB\-maxmempool=\fR<n> .IP @@ -88,7 +105,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 15, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-persistmempool\fR @@ -144,6 +161,12 @@ Add a node to connect to and attempt to keep the connection open (see the `addnode` RPC command help for more info). This option can be specified multiple times to add multiple nodes. .HP +\fB\-asmap=\fR<file> +.IP +Specify asn mapping used for bucketing of the peers (default: +ip_asn.map). Relative paths will be prefixed by the net\-specific +datadir location. +.HP \fB\-banscore=\fR<n> .IP Threshold for disconnecting misbehaving peers (default: 100) @@ -233,7 +256,7 @@ networks. \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: -1) +0) .HP \fB\-permitbaremultisig\fR .IP @@ -277,25 +300,30 @@ 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 transactions that are already in the mempool; implies +relay), 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 \fB\-addresstype\fR .IP What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", -default: "p2sh\-segwit") +default: "bech32") .HP \fB\-avoidpartialspends\fR .IP @@ -303,7 +331,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 @@ -327,11 +356,15 @@ limited by the fee estimate for the longest target \fB\-fallbackfee=\fR<amt> .IP A fee rate (in BTC/kB) that will be used when fee estimation has -insufficient data (default: 0.0002) +insufficient data. 0 to entirely disable the fallbackfee feature. +(default: 0.00) .HP \fB\-keypool=\fR<n> .IP -Set key pool size to <n> (default: 1000) +Set key pool size to <n> (default: 1000). Warning: Smaller sizes may +increase the risk of losing funds when restoring from an old +backup, if none of the addresses in the original keypool have +been used. .HP \fB\-mintxfee=\fR<amt> .IP @@ -383,8 +416,11 @@ exists, otherwise <datadir>) .HP \fB\-walletnotify=\fR<cmd> .IP -Execute command when a wallet transaction changes (%s in cmd is replaced -by TxID) +Execute command when a wallet transaction changes. %s in cmd is replaced +by TxID and %w is replaced by wallet name. %w is not currently +implemented on windows. On systems where %w is supported, it +should NOT be quoted because this would break shell escaping used +to invoke the command. .HP \fB\-walletrbf\fR .IP @@ -402,17 +438,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 @@ -421,9 +475,9 @@ Debugging/Testing options: Output debugging information (default: \fB\-nodebug\fR, supplying <category> is optional). If <category> is not supplied or if <category> = 1, output all debugging information. <category> can be: net, tor, -mempool, http, bench, zmq, db, rpc, estimatefee, addrman, +mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, -libevent, coindb, qt, leveldb. +libevent, coindb, qt, leveldb, validation. .HP \fB\-debugexclude=\fR<category> .IP @@ -439,15 +493,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 @@ -464,9 +522,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 @@ -484,7 +547,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, @@ -492,13 +554,15 @@ 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. (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. This will accept relayed transactions even when not +relaying transactions (default: 1) .PP Block creation options: .HP @@ -569,6 +633,23 @@ Set the number of threads to service RPC calls (default: 4) .IP Username for JSON\-RPC connections .HP +\fB\-rpcwhitelist=\fR<whitelist> +.IP +Set a whitelist to filter incoming RPC calls for a specific user. The +field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc +2>,...,<rpc n>. If multiple whitelists are set for a given user, +they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation +for information on default whitelist behavior. +.HP +\fB\-rpcwhitelistdefault\fR +.IP +Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault +is set to 0, if any \fB\-rpcwhitelist\fR is set, the rpc server acts as +if all rpc users are subject to empty\-unless\-otherwise\-specified +whitelists. If rpcwhitelistdefault is set to 1 and no +\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are +subject to empty whitelists. +.HP \fB\-server\fR .IP Accept command line and JSON\-RPC commands @@ -591,18 +672,14 @@ Start minimized .IP Reset all settings changed in the GUI .HP -\fB\-rootcertificates=\fR<file> -.IP -Set SSL root certificates for payment request (default: \fB\-system\-\fR) -.HP \fB\-splash\fR .IP Show splash screen on startup (default: 1) .SH COPYRIGHT -Copyright (C) 2009-2019 The Bitcoin Core developers +Copyright (C) 2009-2020 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit -<https://bitcoincore.org> for further information about the software. +<https://bitcoincore.org/> for further information about the software. The source code is available from <https://github.com/bitcoin/bitcoin>. This is experimental software. diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 index b4c7698896..3e78dfa7f4 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" "April 2020" "bitcoin-tx v0.20.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.20.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.20.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 @@ -105,10 +112,10 @@ set=NAME:JSON\-STRING .IP Set register NAME to given JSON\-STRING .SH COPYRIGHT -Copyright (C) 2009-2019 The Bitcoin Core developers +Copyright (C) 2009-2020 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit -<https://bitcoincore.org> for further information about the software. +<https://bitcoincore.org/> for further information about the software. The source code is available from <https://github.com/bitcoin/bitcoin>. This is experimental software. diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1 index aadea09a2b..fa0acd287e 100644 --- a/doc/man/bitcoin-wallet.1 +++ b/doc/man/bitcoin-wallet.1 @@ -1,12 +1,12 @@ .\" 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" "April 2020" "bitcoin-wallet v0.20.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.20.0.0 .SH DESCRIPTION -Bitcoin Core bitcoin\-wallet version v0.17.99.0 +Bitcoin Core bitcoin\-wallet version v0.20.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. +bitcoin\-wallet is an offline tool for creating and interacting with Bitcoin Core wallet files. +By default bitcoin\-wallet will act on wallets in the default mainnet wallet directory in the datadir. To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-testnet\fR/\-regtest arguments. .SS "Usage:" .IP @@ -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 @@ -52,10 +57,10 @@ info .IP Get wallet info .SH COPYRIGHT -Copyright (C) 2009-2019 The Bitcoin Core developers +Copyright (C) 2009-2020 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit -<https://bitcoincore.org> for further information about the software. +<https://bitcoincore.org/> for further information about the software. The source code is available from <https://github.com/bitcoin/bitcoin>. This is experimental software. diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index 211ba10285..dbe0c602fc 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" "April 2020" "bitcoind v0.20.0.0" "User Commands" .SH NAME -bitcoind \- manual page for bitcoind v0.17.99.0 +bitcoind \- manual page for bitcoind v0.20.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.20.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, +0000000000000000000f2adce67e49b0b6bdeb9de8b7c3d7e93b21e7fc1e819d, testnet: -0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75) +000000000000056c49030c174179b52a928c870e6e8a822c75973b7970cfbd01) +.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,16 @@ 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. Automatic broadcast +and rebroadcast of any transactions from inbound peers is +disabled, unless '\-whitelistforcerelay' is '1', in which case +whitelisted peers' transactions will be relayed. RPC transactions +are not affected. (default: 0) .HP \fB\-conf=\fR<file> .IP @@ -56,7 +71,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 @@ -71,7 +88,7 @@ Specify additional configuration file, relative to the \fB\-datadir\fR path .HP \fB\-loadblock=\fR<file> .IP -Imports blocks from external blk000??.dat file on startup +Imports blocks from external file on startup .HP \fB\-maxmempool=\fR<n> .IP @@ -88,7 +105,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 15, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-persistmempool\fR @@ -144,6 +161,12 @@ Add a node to connect to and attempt to keep the connection open (see the `addnode` RPC command help for more info). This option can be specified multiple times to add multiple nodes. .HP +\fB\-asmap=\fR<file> +.IP +Specify asn mapping used for bucketing of the peers (default: +ip_asn.map). Relative paths will be prefixed by the net\-specific +datadir location. +.HP \fB\-banscore=\fR<n> .IP Threshold for disconnecting misbehaving peers (default: 100) @@ -233,7 +256,7 @@ networks. \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: -1) +0) .HP \fB\-permitbaremultisig\fR .IP @@ -277,25 +300,30 @@ 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 transactions that are already in the mempool; implies +relay), 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 \fB\-addresstype\fR .IP What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", -default: "p2sh\-segwit") +default: "bech32") .HP \fB\-avoidpartialspends\fR .IP @@ -303,7 +331,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 @@ -327,11 +356,15 @@ limited by the fee estimate for the longest target \fB\-fallbackfee=\fR<amt> .IP A fee rate (in BTC/kB) that will be used when fee estimation has -insufficient data (default: 0.0002) +insufficient data. 0 to entirely disable the fallbackfee feature. +(default: 0.00) .HP \fB\-keypool=\fR<n> .IP -Set key pool size to <n> (default: 1000) +Set key pool size to <n> (default: 1000). Warning: Smaller sizes may +increase the risk of losing funds when restoring from an old +backup, if none of the addresses in the original keypool have +been used. .HP \fB\-mintxfee=\fR<amt> .IP @@ -383,8 +416,11 @@ exists, otherwise <datadir>) .HP \fB\-walletnotify=\fR<cmd> .IP -Execute command when a wallet transaction changes (%s in cmd is replaced -by TxID) +Execute command when a wallet transaction changes. %s in cmd is replaced +by TxID and %w is replaced by wallet name. %w is not currently +implemented on windows. On systems where %w is supported, it +should NOT be quoted because this would break shell escaping used +to invoke the command. .HP \fB\-walletrbf\fR .IP @@ -402,17 +438,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 @@ -421,9 +475,9 @@ Debugging/Testing options: Output debugging information (default: \fB\-nodebug\fR, supplying <category> is optional). If <category> is not supplied or if <category> = 1, output all debugging information. <category> can be: net, tor, -mempool, http, bench, zmq, db, rpc, estimatefee, addrman, +mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, -libevent, coindb, qt, leveldb. +libevent, coindb, qt, leveldb, validation. .HP \fB\-debugexclude=\fR<category> .IP @@ -439,15 +493,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 @@ -464,9 +522,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 @@ -491,13 +554,15 @@ 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. (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. This will accept relayed transactions even when not +relaying transactions (default: 1) .PP Block creation options: .HP @@ -568,14 +633,31 @@ Set the number of threads to service RPC calls (default: 4) .IP Username for JSON\-RPC connections .HP +\fB\-rpcwhitelist=\fR<whitelist> +.IP +Set a whitelist to filter incoming RPC calls for a specific user. The +field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc +2>,...,<rpc n>. If multiple whitelists are set for a given user, +they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation +for information on default whitelist behavior. +.HP +\fB\-rpcwhitelistdefault\fR +.IP +Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault +is set to 0, if any \fB\-rpcwhitelist\fR is set, the rpc server acts as +if all rpc users are subject to empty\-unless\-otherwise\-specified +whitelists. If rpcwhitelistdefault is set to 1 and no +\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are +subject to empty whitelists. +.HP \fB\-server\fR .IP Accept command line and JSON\-RPC commands .SH COPYRIGHT -Copyright (C) 2009-2019 The Bitcoin Core developers +Copyright (C) 2009-2020 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit -<https://bitcoincore.org> for further information about the software. +<https://bitcoincore.org/> for further information about the software. The source code is available from <https://github.com/bitcoin/bitcoin>. This is experimental software. |