diff options
Diffstat (limited to 'doc/man/bitcoind.1')
| -rw-r--r-- | doc/man/bitcoind.1 | 281 |
1 files changed, 204 insertions, 77 deletions
diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index 211ba10285..8dbd0bdde3 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" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. +.TH BITCOIND "1" "November 2020" "bitcoind v0.21.0.0" "User Commands" .SH NAME -bitcoind \- manual page for bitcoind v0.17.99.0 +bitcoind \- manual page for bitcoind v0.21.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.21.0.0 .SH OPTIONS .HP \-? @@ -23,9 +23,17 @@ 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, +0000000000000000000b9d2ec5a352ecba0592946514a92f14319dc2b367fc72, testnet: -0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75) +000000000000006433d1efec504c53ca332b64963c425395515b01977bd7b3b0, +signet: +0000002a1de0f46379358c1fd09906f7ac59adf3712323ed90eb59e4c183c020) +.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,12 +47,20 @@ 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 the peer has the 'forcerelay' permission. RPC +transactions are not affected. (default: 0) .HP \fB\-conf=\fR<file> .IP -Specify configuration file. Relative paths will be prefixed by datadir -location. (default: bitcoin.conf) +Specify path to read\-only configuration file. Relative paths will be +prefixed by datadir location. (default: bitcoin.conf) .HP \fB\-daemon\fR .IP @@ -56,7 +72,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 +89,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 +106,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 @@ -122,6 +140,18 @@ Rebuild chain state from the currently indexed blocks. When in pruning mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR instead. .HP +\fB\-settings=\fR<file> +.IP +Specify path to dynamic settings data file. Can be disabled with +\fB\-nosettings\fR. File is written at runtime and not meant to be +edited by users (use bitcoin.conf instead for custom settings). +Relative paths will be prefixed by datadir location. (default: +settings.json) +.HP +\fB\-startupnotify=\fR<cmd> +.IP +Execute command on startup. +.HP \fB\-sysperms\fR .IP Create new files with system default permissions, instead of umask 077 @@ -144,19 +174,24 @@ 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\-banscore=\fR<n> +\fB\-asmap=\fR<file> .IP -Threshold for disconnecting misbehaving peers (default: 100) +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\-bantime=\fR<n> .IP -Number of seconds to keep misbehaving peers from reconnecting (default: +Default duration (in seconds) of manually configured bans (default: 86400) .HP -\fB\-bind=\fR<addr> +\fB\-bind=\fR<addr>[:<port>][=onion] .IP -Bind to given address and always listen on it. Use [host]:port notation -for IPv6 +Bind to given address and always listen on it (default: 0.0.0.0). Use +[host]:port notation for IPv6. Append =onion to tag any incoming +connections to that address and port as incoming Tor connections +(default: 127.0.0.1:8334=onion, testnet: 127.0.0.1:18334=onion, +signet: 127.0.0.1:38334=onion, regtest: 127.0.0.1:18445=onion) .HP \fB\-connect=\fR<ip> .IP @@ -193,7 +228,7 @@ Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\ .HP \fB\-listenonion\fR .IP -Automatically create Tor hidden service (default: 1) +Automatically create Tor onion service (default: 1) .HP \fB\-maxconnections=\fR<n> .IP @@ -215,12 +250,18 @@ amount. (default: 4200 seconds) .HP \fB\-maxuploadtarget=\fR<n> .IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) +Tries to keep outbound traffic under the given target (in MiB per 24h). +Limit does not apply to peers with 'download' permission. 0 = no +limit (default: 0) +.HP +\fB\-networkactive\fR +.IP +Enable all P2P network activity (default: 1). Can be changed by the +setnetworkactive RPC command .HP \fB\-onion=\fR<ip:port> .IP -Use separate SOCKS5 proxy to reach peers via Tor hidden services, set +Use separate SOCKS5 proxy to reach peers via Tor onion services, set \fB\-noonion\fR to disable (default: \fB\-proxy\fR) .HP \fB\-onlynet=\fR<net> @@ -230,10 +271,14 @@ onion). Incoming connections are not affected by this option. This option can be specified multiple times to allow multiple networks. .HP +\fB\-peerblockfilters\fR +.IP +Serve compact block filters to peers per BIP 157 (default: 0) +.HP \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: -1) +0) .HP \fB\-permitbaremultisig\fR .IP @@ -241,8 +286,8 @@ Relay non\-P2SH multisig (default: 1) .HP \fB\-port=\fR<port> .IP -Listen for connections on <port> (default: 8333, testnet: 18333, -regtest: 18444) +Listen for connections on <port> (default: 8333, testnet: 18333 signet: +38333, regtest: 18444) .HP \fB\-proxy=\fR<ip:port> .IP @@ -277,25 +322,35 @@ Tor control port password (default: empty) .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<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 +\fB\-whitebind=\fR<[permissions@]addr> +.IP +Bind to the given address and add permission flags to the peers +connecting to it. Use [host]:port notation for IPv6. Allowed +permissions: bloomfilter (allow requesting BIP37 filtered blocks +and transactions), noban (do not ban for misbehavior; implies +download), forcerelay (relay transactions that are already in the +mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode, +and unlimited transaction announcements), mempool (allow +requesting BIP35 mempool contents), download (allow getheaders +during IBD, no disconnect after maxuploadtarget limit), addr +(responses to GETADDR avoid hitting the cache and contain random +records with the most up\-to\-date info). Specify multiple +permissions separated by commas (default: +download,noban,mempool,relay). Can be specified multiple times. +.HP +\fB\-whitelist=\fR<[permissions@]IP address or network> +.IP +Add permission flags to the peers connecting from the given IP address +(e.g. 1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses +the 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 +358,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 +383,20 @@ 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\-maxapsfee=\fR<n> +.IP +Spend up to this amount in additional (absolute) fees (in BTC) if it +allows the use of partial spend avoidance (default: 0.00) .HP \fB\-mintxfee=\fR<amt> .IP @@ -346,10 +411,6 @@ Fee (in BTC/kB) to add to transactions you send (default: 0.00) .IP Rescan the block chain for missing wallet transactions on startup .HP -\fB\-salvagewallet\fR -.IP -Attempt to recover private keys from a corrupt wallet on startup -.HP \fB\-spendzeroconfchange\fR .IP Spend unconfirmed change when sending transactions (default: 1) @@ -359,18 +420,15 @@ 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\-upgradewallet\fR -.IP -Upgrade wallet to latest format on startup -.HP \fB\-wallet=\fR<path> .IP -Specify wallet database path. Can be specified multiple times to load -multiple wallets. Path is interpreted relative to <walletdir> if -it is not absolute, and will be created if it does not exist (as -a directory containing a wallet.dat file and log files). For -backwards compatibility this will also accept names of existing -data files in <walletdir>.) +Specify wallet path to load at startup. Can be used multiple times to +load multiple wallets. Path is to a directory containing wallet +data and log files. If the path is not absolute, it is +interpreted relative to <walletdir>. This only loads existing +wallets and does not create new ones. For backwards compatibility +this also accepts names of existing top\-level data files in +<walletdir>. .HP \fB\-walletbroadcast\fR .IP @@ -383,18 +441,15 @@ 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 Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) -.HP -\fB\-zapwallettxes=\fR<mode> -.IP -Delete all wallet transactions and only recover those parts of the -blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g. -payment request information, 2 = drop tx meta data) .PP ZeroMQ notification options: .HP @@ -402,17 +457,43 @@ 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) +.HP +\fB\-zmqpubsequence=\fR<address> +.IP +Enable publish hash block and tx sequence in <address> +.HP +\fB\-zmqpubsequencehwm=\fR<n> +.IP +Set publish hash sequence message high water mark (default: 1000) .PP Debugging/Testing options: .HP @@ -421,9 +502,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 +520,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 +549,32 @@ 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, +signet, regtest +.HP +\fB\-signet\fR +.IP +Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fB\-signetchallenge\fR parameter +.HP +\fB\-signetchallenge\fR +.IP +Blocks must satisfy the given script to be considered valid (only for +signet networks; defaults to the global default signet test +network challenge) +.HP +\fB\-signetseednode\fR +.IP +Specify a seed node for the signet network, in the hostname[:port] +format, e.g. sig.net:1234 (may be used multiple times to specify +multiple seed nodes; defaults to the global default signet test +network seed node(s)) +.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 +599,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 @@ -553,7 +663,7 @@ Password for JSON\-RPC connections \fB\-rpcport=\fR<port> .IP Listen for JSON\-RPC connections on <port> (default: 8332, testnet: -18332, regtest: 18443) +18332, signet: 38332, regtest: 18443) .HP \fB\-rpcserialversion\fR .IP @@ -568,14 +678,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. |