diff options
author | W. J. van der Laan <laanwj@protonmail.com> | 2021-08-11 13:42:53 +0200 |
---|---|---|
committer | W. J. van der Laan <laanwj@protonmail.com> | 2021-08-11 13:43:13 +0200 |
commit | d3bd5410f64e96d106486643e3d4300a9fb0ee71 (patch) | |
tree | ce2f171272754319f12a33650b12742b0f4eff35 /doc | |
parent | 873fbc745d037ad43570f81e58334c397bc95477 (diff) |
doc: Manual pages update for 22.0rc2
Tree-SHA512: 361c6efdd21396ebf4358195e91bde81e7f7414e7022efc4d4a10da7cf3df7ce8cdadd277237921fdde9bae4b811d69d95fec56c010b823324ca69b40b966d41
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/bitcoin-cli.1 | 166 | ||||
-rw-r--r-- | doc/man/bitcoin-qt.1 | 783 | ||||
-rw-r--r-- | doc/man/bitcoin-tx.1 | 138 | ||||
-rw-r--r-- | doc/man/bitcoin-util.1 | 58 | ||||
-rw-r--r-- | doc/man/bitcoin-wallet.1 | 110 | ||||
-rw-r--r-- | doc/man/bitcoind.1 | 770 |
6 files changed, 2001 insertions, 24 deletions
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index 6bcad7006b..8bcbe08a9b 100644 --- a/doc/man/bitcoin-cli.1 +++ b/doc/man/bitcoin-cli.1 @@ -1,5 +1,163 @@ -.TH BITCOIN-CLI "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. +.TH BITCOIN-CLI "1" "August 2021" "bitcoin-cli v22.0rc2" "User Commands" .SH NAME -bitcoin-cli \- manual page for bitcoin-cli - -This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. +bitcoin-cli manual page for bitcoin-cli v22.0rc2 +.SH SYNOPSIS +.B bitcoin-cli +[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR +.br +.B bitcoin-cli +[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (with named arguments)\/\fR +.br +.B bitcoin-cli +[\fI\,options\/\fR] \fI\,help List commands\/\fR +.br +.B bitcoin-cli +[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR +.SH DESCRIPTION +Bitcoin Core RPC client version v22.0rc2 +.SH OPTIONS +.HP +? +.IP +Print this help message and exit +.HP +\fBaddrinfo\fR +.IP +Get the number of addresses known to the node, per network and total. +.HP +\fBconf=\fR<file> +.IP +Specify configuration file. Relative paths will be prefixed by datadir +location. (default: bitcoin.conf) +.HP +\fBdatadir=\fR<dir> +.IP +Specify data directory +.HP +\fBgenerate\fR +.IP +Generate blocks immediately, equivalent to RPC getnewaddress followed by +RPC generatetoaddress. Optional positional integer arguments are +number of blocks to generate (default: 1) and maximum iterations +to try (default: 1000000), equivalent to RPC generatetoaddress +nblocks and maxtries arguments. Example: bitcoincli \fBgenerate\fR 4 +1000 +.HP +\fBgetinfo\fR +.IP +Get general information from the remote server. Note that unlike +serverside RPC calls, the results of \fBgetinfo\fR is the result of +multiple nonatomic requests. Some entries in the result may +represent results from different states (e.g. wallet balance may +be as of a different block from the chain state reported) +.HP +\fBnamed\fR +.IP +Pass named instead of positional arguments (default: false) +.HP +\fBnetinfo\fR +.IP +Get network peer connection information from the remote server. An +optional integer argument from 0 to 4 can be passed for different +peers listings (default: 0). Pass "help" for detailed help +documentation. +.HP +\fBrpcclienttimeout=\fR<n> +.IP +Timeout in seconds during HTTP requests, or 0 for no timeout. (default: +900) +.HP +\fBrpcconnect=\fR<ip> +.IP +Send commands to node running on <ip> (default: 127.0.0.1) +.HP +\fBrpccookiefile=\fR<loc> +.IP +Location of the auth cookie. Relative paths will be prefixed by a +netspecific datadir location. (default: data dir) +.HP +\fBrpcpassword=\fR<pw> +.IP +Password for JSONRPC connections +.HP +\fBrpcport=\fR<port> +.IP +Connect to JSONRPC on <port> (default: 8332, testnet: 18332, signet: +38332, regtest: 18443) +.HP +\fBrpcuser=\fR<user> +.IP +Username for JSONRPC connections +.HP +\fBrpcwait\fR +.IP +Wait for RPC server to start +.HP +\fBrpcwaittimeout=\fR<n> +.IP +Timeout in seconds to wait for the RPC server to start, or 0 for no +timeout. (default: 0) +.HP +\fBrpcwallet=\fR<walletname> +.IP +Send RPC for nondefault wallet on RPC server (needs to exactly match +corresponding \fBwallet\fR option passed to bitcoind). This changes +the RPC endpoint used, e.g. +http://127.0.0.1:8332/wallet/<walletname> +.HP +\fBstdin\fR +.IP +Read extra arguments from standard input, one per line until EOF/CtrlD +(recommended for sensitive information such as passphrases). When +combined with \fBstdinrpcpass\fR, the first line from standard input +is used for the RPC password. +.HP +\fBstdinrpcpass\fR +.IP +Read RPC password from standard input as a single line. When combined +with \fBstdin\fR, the first line from standard input is used for the +RPC password. When combined with \fBstdinwalletpassphrase\fR, +\fBstdinrpcpass\fR consumes the first line, and \fBstdinwalletpassphrase\fR +consumes the second. +.HP +\fBstdinwalletpassphrase\fR +.IP +Read wallet passphrase from standard input as a single line. When +combined with \fBstdin\fR, the first line from standard input is used +for the wallet passphrase. +.HP +\fBversion\fR +.IP +Print version and exit +.PP +Debugging/Testing options: +.PP +Chain selection options: +.HP +\fBchain=\fR<chain> +.IP +Use the chain <chain> (default: main). Allowed values: main, test, +signet, regtest +.HP +\fBsignet\fR +.IP +Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fBsignetchallenge\fR parameter +.HP +\fBsignetchallenge\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 +\fBsignetseednode\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 +\fBtestnet\fR +.IP +Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 index ff4d1d2c7a..68fa6709f4 100644 --- a/doc/man/bitcoin-qt.1 +++ b/doc/man/bitcoin-qt.1 @@ -1,5 +1,780 @@ -.TH BITCOIN-QT "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. +.TH BITCOIN-QT "1" "August 2021" "bitcoin-qt v22.0rc2" "User Commands" .SH NAME -bitcoin-qt \- manual page for bitcoin-qt - -This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. +bitcoin-qt manual page for bitcoin-qt v22.0rc2 +.SH SYNOPSIS +.B bitcoin-qt +[\fI\,command-line options\/\fR] +.SH DESCRIPTION +Bitcoin Core version v22.0rc2 +.SH OPTIONS +.HP +? +.IP +Print this help message and exit +.HP +\fBalertnotify=\fR<cmd> +.IP +Execute command when a relevant alert is received or we see a really +long fork (%s in cmd is replaced by message) +.HP +\fBassumevalid=\fR<hex> +.IP +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: +00000000000000000008a89e854d57e5667df88f1cdef6fde2fbca1de5b639ad, +testnet: +0000000000004ae2f3896ca8ecd41c460a35bf6184e145d91558cece1c688a76, +signet: +000000187d4440e5bff91488b700a140441e089a8aaea707414982460edbfe54) +.HP +\fBblockfilterindex=\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 +\fBblocknotify=\fR<cmd> +.IP +Execute command when the best block changes (%s in cmd is replaced by +block hash) +.HP +\fBblockreconstructionextratxn=\fR<n> +.IP +Extra transactions to keep in memory for compact block reconstructions +(default: 100) +.HP +\fBblocksdir=\fR<dir> +.IP +Specify directory to hold blocks subdirectory for *.dat files (default: +<datadir>) +.HP +\fBblocksonly\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 +\fBcoinstatsindex\fR +.IP +Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) +.HP +\fBconf=\fR<file> +.IP +Specify path to readonly configuration file. Relative paths will be +prefixed by datadir location. (default: bitcoin.conf) +.HP +\fBdaemon\fR +.IP +Run in the background as a daemon and accept commands (default: 0) +.HP +\fBdaemonwait\fR +.IP +Wait for initialization to be finished before exiting. This implies +\fBdaemon\fR (default: 0) +.HP +\fBdatadir=\fR<dir> +.IP +Specify data directory +.HP +\fBdbcache=\fR<n> +.IP +Maximum database cache size <n> MiB (4 to 16384, default: 450). In +addition, unused mempool memory is shared for this cache (see +\fBmaxmempool\fR). +.HP +\fBdebuglogfile=\fR<file> +.IP +Specify location of debug log file. Relative paths will be prefixed by a +netspecific datadir location. (\fBnodebuglogfile\fR to disable; +default: debug.log) +.HP +\fBincludeconf=\fR<file> +.IP +Specify additional configuration file, relative to the \fBdatadir\fR path +(only useable from configuration file, not command line) +.HP +\fBloadblock=\fR<file> +.IP +Imports blocks from external file on startup +.HP +\fBmaxmempool=\fR<n> +.IP +Keep the transaction memory pool below <n> megabytes (default: 300) +.HP +\fBmaxorphantx=\fR<n> +.IP +Keep at most <n> unconnectable transactions in memory (default: 100) +.HP +\fBmempoolexpiry=\fR<n> +.IP +Do not keep transactions in the mempool longer than <n> hours (default: +336) +.HP +\fBpar=\fR<n> +.IP +Set the number of script verification threads (\fB6\fR to 15, 0 = auto, <0 = +leave that many cores free, default: 0) +.HP +\fBpersistmempool\fR +.IP +Whether to save the mempool on shutdown and load on restart (default: 1) +.HP +\fBpid=\fR<file> +.IP +Specify pid file. Relative paths will be prefixed by a netspecific +datadir location. (default: bitcoind.pid) +.HP +\fBprune=\fR<n> +.IP +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 \fBtxindex\fR, \fBcoinstatsindex\fR and \fBrescan\fR. Warning: +Reverting this setting requires redownloading 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 +\fBreindex\fR +.IP +Rebuild chain state and block index from the blk*.dat files on disk +.HP +\fBreindexchainstate\fR +.IP +Rebuild chain state from the currently indexed blocks. When in pruning +mode or if blocks on disk might be corrupted, use full \fBreindex\fR +instead. +.HP +\fBsettings=\fR<file> +.IP +Specify path to dynamic settings data file. Can be disabled with +\fBnosettings\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 +\fBstartupnotify=\fR<cmd> +.IP +Execute command on startup. +.HP +\fBsysperms\fR +.IP +Create new files with system default permissions, instead of umask 077 +(only effective with disabled wallet functionality) +.HP +\fBtxindex\fR +.IP +Maintain a full transaction index, used by the getrawtransaction rpc +call (default: 0) +.HP +\fBversion\fR +.IP +Print version and exit +.PP +Connection options: +.HP +\fBaddnode=\fR<ip> +.IP +Add a node to connect to and attempt to keep the connection open (see +the addnode RPC help for more info). This option can be specified +multiple times to add multiple nodes; connections are limited to +8 at a time and are counted separately from the \fBmaxconnections\fR +limit. +.HP +\fBasmap=\fR<file> +.IP +Specify asn mapping used for bucketing of the peers (default: +ip_asn.map). Relative paths will be prefixed by the netspecific +datadir location. +.HP +\fBbantime=\fR<n> +.IP +Default duration (in seconds) of manually configured bans (default: +86400) +.HP +\fBbind=\fR<addr>[:<port>][=onion] +.IP +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 +\fBconnect=\fR<ip> +.IP +Connect only to the specified node; \fBnoconnect\fR disables automatic +connections (the rules for this peer are the same as for +\fBaddnode\fR). This option can be specified multiple times to connect +to multiple nodes. +.HP +\fBdiscover\fR +.IP +Discover own IP addresses (default: 1 when listening and no \fBexternalip\fR +or \fBproxy\fR) +.HP +\fBdns\fR +.IP +Allow DNS lookups for \fBaddnode\fR, \fBseednode\fR and \fBconnect\fR (default: 1) +.HP +\fBdnsseed\fR +.IP +Query for peer addresses via DNS lookup, if low on addresses (default: 1 +unless \fBconnect\fR used) +.HP +\fBexternalip=\fR<ip> +.IP +Specify your own public address +.HP +\fBfixedseeds\fR +.IP +Allow fixed seeds if DNS seeds don't provide peers (default: 1) +.HP +\fBforcednsseed\fR +.IP +Always query for peer addresses via DNS lookup (default: 0) +.HP +\fBi2pacceptincoming\fR +.IP +If set and \fBi2psam\fR is also set then incoming I2P connections are +accepted via the SAM proxy. If this is not set but \fBi2psam\fR is set +then only outgoing connections will be made to the I2P network. +Ignored if \fBi2psam\fR is not set. Listening for incoming I2P +connections is done through the SAM proxy, not by binding to a +local address and port (default: 1) +.HP +\fBi2psam=\fR<ip:port> +.IP +I2P SAM proxy to reach I2P peers and accept I2P connections (default: +none) +.HP +\fBlisten\fR +.IP +Accept connections from outside (default: 1 if no \fBproxy\fR or \fBconnect\fR) +.HP +\fBlistenonion\fR +.IP +Automatically create Tor onion service (default: 1) +.HP +\fBmaxconnections=\fR<n> +.IP +Maintain at most <n> connections to peers (default: 125). This limit +does not apply to connections manually added via \fBaddnode\fR or the +addnode RPC, which have a separate limit of 8. +.HP +\fBmaxreceivebuffer=\fR<n> +.IP +Maximum perconnection receive buffer, <n>*1000 bytes (default: 5000) +.HP +\fBmaxsendbuffer=\fR<n> +.IP +Maximum perconnection send buffer, <n>*1000 bytes (default: 1000) +.HP +\fBmaxtimeadjustment\fR +.IP +Maximum allowed median peer time offset adjustment. Local perspective of +time may be influenced by peers forward or backward by this +amount. (default: 4200 seconds) +.HP +\fBmaxuploadtarget=\fR<n> +.IP +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 +\fBnatpmp\fR +.IP +Use NATPMP to map the listening port (default: 0) +.HP +\fBnetworkactive\fR +.IP +Enable all P2P network activity (default: 1). Can be changed by the +setnetworkactive RPC command +.HP +\fBonion=\fR<ip:port> +.IP +Use separate SOCKS5 proxy to reach peers via Tor onion services, set +\fBnoonion\fR to disable (default: \fBproxy\fR) +.HP +\fBonlynet=\fR<net> +.IP +Make outgoing connections only through network <net> (ipv4, ipv6, onion, +i2p). Incoming connections are not affected by this option. This +option can be specified multiple times to allow multiple +networks. Warning: if it is used with nononion networks and the +\fBonion\fR or \fBproxy\fR option is set, then outbound onion connections +will still be made; use \fBnoonion\fR or \fBonion\fR=\fI\,0\/\fR to disable outbound +onion connections in this case. +.HP +\fBpeerblockfilters\fR +.IP +Serve compact block filters to peers per BIP 157 (default: 0) +.HP +\fBpeerbloomfilters\fR +.IP +Support filtering of blocks and transaction with bloom filters (default: +0) +.HP +\fBpermitbaremultisig\fR +.IP +Relay nonP2SH multisig (default: 1) +.HP +\fBport=\fR<port> +.IP +Listen for connections on <port>. Nodes not using the default ports +(default: 8333, testnet: 18333, signet: 38333, regtest: 18444) +are unlikely to get incoming connections. Not relevant for I2P +(see doc/i2p.md). +.HP +\fBproxy=\fR<ip:port> +.IP +Connect through SOCKS5 proxy, set \fBnoproxy\fR to disable (default: +disabled) +.HP +\fBproxyrandomize\fR +.IP +Randomize credentials for every proxy connection. This enables Tor +stream isolation (default: 1) +.HP +\fBseednode=\fR<ip> +.IP +Connect to a node to retrieve peer addresses, and disconnect. This +option can be specified multiple times to connect to multiple +nodes. +.HP +\fBtimeout=\fR<n> +.IP +Specify socket connection timeout in milliseconds. If an initial attempt +to connect is unsuccessful after this amount of time, drop it +(minimum: 1, default: 5000) +.HP +\fBtorcontrol=\fR<ip>:<port> +.IP +Tor control port to use if onion listening enabled (default: +127.0.0.1:9051) +.HP +\fBtorpassword=\fR<pass> +.IP +Tor control port password (default: empty) +.HP +\fBupnp\fR +.IP +Use UPnP to map the listening port (default: 0) +.HP +\fBwhitebind=\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 \fBblocksonly\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 uptodate info). Specify multiple +permissions separated by commas (default: +download,noban,mempool,relay). Can be specified multiple times. +.HP +\fBwhitelist=\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 CIDRnotated network (e.g. 1.2.3.0/24). Uses +the same permissions as \fBwhitebind\fR. Can be specified multiple +times. +.PP +Wallet options: +.HP +\fBaddresstype\fR +.IP +What type of addresses to use ("legacy", "p2shsegwit", or "bech32", +default: "bech32") +.HP +\fBavoidpartialspends\fR +.IP +Group outputs by address, selecting many (possibly all) or none, instead +of selecting on a peroutput basis. Privacy is improved as +addresses are mostly swept with fewer transactions and outputs +are aggregated in clean change addresses. It may result in higher +fees due to less optimal coin selection caused by this added +limitation and possibly a largerthannecessary number of inputs +being used. Always enabled for wallets with "avoid_reuse" +enabled, otherwise default: 0. +.HP +\fBchangetype\fR +.IP +What type of change to use ("legacy", "p2shsegwit", or "bech32"). +Default is same as \fBaddresstype\fR, except when +\fBaddresstype\fR=\fI\,p2shsegwit\/\fR a native segwit output is used when +sending to a native segwit address) +.HP +\fBdisablewallet\fR +.IP +Do not load the wallet and disable wallet RPC calls +.HP +\fBdiscardfee=\fR<amt> +.IP +The fee rate (in BTC/kvB) 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 +\fBfallbackfee=\fR<amt> +.IP +A fee rate (in BTC/kvB) that will be used when fee estimation has +insufficient data. 0 to entirely disable the fallbackfee feature. +(default: 0.00) +.HP +\fBkeypool=\fR<n> +.IP +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 +\fBmaxapsfee=\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 +\fBmintxfee=\fR<amt> +.IP +Fee rates (in BTC/kvB) smaller than this are considered zero fee for +transaction creation (default: 0.00001) +.HP +\fBpaytxfee=\fR<amt> +.IP +Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00) +.HP +\fBrescan\fR +.IP +Rescan the block chain for missing wallet transactions on startup +.HP +\fBsigner=\fR<cmd> +.IP +External signing tool, see doc/externalsigner.md +.HP +\fBspendzeroconfchange\fR +.IP +Spend unconfirmed change when sending transactions (default: 1) +.HP +\fBtxconfirmtarget=\fR<n> +.IP +If paytxfee is not set, include enough fee so transactions begin +confirmation on average within n blocks (default: 6) +.HP +\fBwallet=\fR<path> +.IP +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 toplevel data files in +<walletdir>. +.HP +\fBwalletbroadcast\fR +.IP +Make the wallet broadcast transactions (default: 1) +.HP +\fBwalletdir=\fR<dir> +.IP +Specify directory to hold wallets (default: <datadir>/wallets if it +exists, otherwise <datadir>) +.HP +\fBwalletnotify=\fR<cmd> +.IP +Execute command when a wallet transaction changes. %s in cmd is replaced +by TxID, %w is replaced by wallet name, %b is replaced by the +hash of the block including the transaction (set to 'unconfirmed' +if the transaction is not included) and %h is replaced by the +block height (\fB1\fR if not included). %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 +\fBwalletrbf\fR +.IP +Send transactions with fullRBF optin enabled (RPC only, default: 0) +.PP +ZeroMQ notification options: +.HP +\fBzmqpubhashblock=\fR<address> +.IP +Enable publish hash block in <address> +.HP +\fBzmqpubhashblockhwm=\fR<n> +.IP +Set publish hash block outbound message high water mark (default: 1000) +.HP +\fBzmqpubhashtx=\fR<address> +.IP +Enable publish hash transaction in <address> +.HP +\fBzmqpubhashtxhwm=\fR<n> +.IP +Set publish hash transaction outbound message high water mark (default: +1000) +.HP +\fBzmqpubrawblock=\fR<address> +.IP +Enable publish raw block in <address> +.HP +\fBzmqpubrawblockhwm=\fR<n> +.IP +Set publish raw block outbound message high water mark (default: 1000) +.HP +\fBzmqpubrawtx=\fR<address> +.IP +Enable publish raw transaction in <address> +.HP +\fBzmqpubrawtxhwm=\fR<n> +.IP +Set publish raw transaction outbound message high water mark (default: +1000) +.HP +\fBzmqpubsequence=\fR<address> +.IP +Enable publish hash block and tx sequence in <address> +.HP +\fBzmqpubsequencehwm=\fR<n> +.IP +Set publish hash sequence message high water mark (default: 1000) +.PP +Debugging/Testing options: +.HP +\fBdebug=\fR<category> +.IP +Output debugging information (default: \fBnodebug\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, walletdb, rpc, estimatefee, addrman, +selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, +libevent, coindb, qt, leveldb, validation, i2p, ipc. This option +can be specified multiple times to output multiple categories. +.HP +\fBdebugexclude=\fR<category> +.IP +Exclude debugging information for a category. Can be used in conjunction +with \fBdebug\fR=\fI\,1\/\fR to output debug logs for all categories except the +specified category. This option can be specified multiple times +to exclude multiple categories. +.HP +\fBhelpdebug\fR +.IP +Print help message with debugging options and exit +.HP +\fBlogips\fR +.IP +Include IP addresses in debug output (default: 0) +.HP +\fBlogsourcelocations\fR +.IP +Prepend debug output with name of the originating source location +(source file, line number and function name) (default: 0) +.HP +\fBlogthreadnames\fR +.IP +Prepend debug output with name of the originating thread (only available +on platforms supporting thread_local) (default: 0) +.HP +\fBlogtimestamps\fR +.IP +Prepend debug output with timestamp (default: 1) +.HP +\fBmaxtxfee=\fR<amt> +.IP +Maximum total fees (in BTC) to use in a single wallet transaction; +setting this too low may abort large transactions (default: 0.10) +.HP +\fBprinttoconsole\fR +.IP +Send trace/debug info to console (default: 1 when no \fBdaemon\fR. To disable +logging to file, set \fBnodebuglogfile\fR) +.HP +\fBshrinkdebugfile\fR +.IP +Shrink debug.log file on client startup (default: 1 when no \fBdebug\fR) +.HP +\fBuacomment=\fR<cmt> +.IP +Append comment to the user agent string +.PP +Chain selection options: +.HP +\fBchain=\fR<chain> +.IP +Use the chain <chain> (default: main). Allowed values: main, test, +signet, regtest +.HP +\fBsignet\fR +.IP +Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fBsignetchallenge\fR parameter +.HP +\fBsignetchallenge\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 +\fBsignetseednode\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 +\fBtestnet\fR +.IP +Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +.PP +Node relay options: +.HP +\fBbytespersigop\fR +.IP +Equivalent bytes per sigop in transactions for relay and mining +(default: 20) +.HP +\fBdatacarrier\fR +.IP +Relay and mine data carrier transactions (default: 1) +.HP +\fBdatacarriersize\fR +.IP +Maximum size of data in data carrier transactions we relay and mine +(default: 83) +.HP +\fBminrelaytxfee=\fR<amt> +.IP +Fees (in BTC/kvB) smaller than this are considered zero fee for +relaying, mining and transaction creation (default: 0.00001) +.HP +\fBwhitelistforcerelay\fR +.IP +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 +\fBwhitelistrelay\fR +.IP +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 +\fBblockmaxweight=\fR<n> +.IP +Set maximum BIP141 block weight (default: 3996000) +.HP +\fBblockmintxfee=\fR<amt> +.IP +Set lowest fee rate (in BTC/kvB) for transactions to be included in +block creation. (default: 0.00001) +.PP +RPC server options: +.HP +\fBrest\fR +.IP +Accept public REST requests (default: 0) +.HP +\fBrpcallowip=\fR<ip> +.IP +Allow JSONRPC connections from specified source. Valid for <ip> are a +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 +\fBrpcauth=\fR<userpw> +.IP +Username and HMACSHA256 hashed password for JSONRPC connections. The +field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A +canonical python script is included in share/rpcauth. The client +then connects normally using the +rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This +option can be specified multiple times +.HP +\fBrpcbind=\fR<addr>[:port] +.IP +Bind to given address to listen for JSONRPC connections. Do not expose +the RPC server to untrusted networks such as the public internet! +This option is ignored unless \fBrpcallowip\fR is also passed. Port is +optional and overrides \fBrpcport\fR. Use [host]:port notation for +IPv6. This option can be specified multiple times (default: +127.0.0.1 and ::1 i.e., localhost) +.HP +\fBrpccookiefile=\fR<loc> +.IP +Location of the auth cookie. Relative paths will be prefixed by a +netspecific datadir location. (default: data dir) +.HP +\fBrpcpassword=\fR<pw> +.IP +Password for JSONRPC connections +.HP +\fBrpcport=\fR<port> +.IP +Listen for JSONRPC connections on <port> (default: 8332, testnet: +18332, signet: 38332, regtest: 18443) +.HP +\fBrpcserialversion\fR +.IP +Sets the serialization of raw transaction or block hex returned in +nonverbose mode, nonsegwit(0) or segwit(1) (default: 1) +.HP +\fBrpcthreads=\fR<n> +.IP +Set the number of threads to service RPC calls (default: 4) +.HP +\fBrpcuser=\fR<user> +.IP +Username for JSONRPC connections +.HP +\fBrpcwhitelist=\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 setintersected. See \fBrpcwhitelistdefault\fR documentation +for information on default whitelist behavior. +.HP +\fBrpcwhitelistdefault\fR +.IP +Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault +is set to 0, if any \fBrpcwhitelist\fR is set, the rpc server acts as +if all rpc users are subject to emptyunlessotherwisespecified +whitelists. If rpcwhitelistdefault is set to 1 and no +\fBrpcwhitelist\fR is set, rpc server acts as if all rpc users are +subject to empty whitelists. +.HP +\fBserver\fR +.IP +Accept command line and JSONRPC commands +.PP +UI Options: +.HP +\fBchoosedatadir\fR +.IP +Choose data directory on startup (default: 0) +.HP +\fBlang=\fR<lang> +.IP +Set language, for example "de_DE" (default: system locale) +.HP +\fBmin\fR +.IP +Start minimized +.HP +\fBresetguisettings\fR +.IP +Reset all settings changed in the GUI +.HP +\fBsplash\fR +.IP +Show splash screen on startup (default: 1) diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 index 776bb46234..b088f98893 100644 --- a/doc/man/bitcoin-tx.1 +++ b/doc/man/bitcoin-tx.1 @@ -1,5 +1,135 @@ -.TH BITCOIN-TX "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. +.TH BITCOIN-TX "1" "August 2021" "bitcoin-tx v22.0rc2" "User Commands" .SH NAME -bitcoin-tx \- manual page for bitcoin-tx - -This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. +bitcoin-tx manual page for bitcoin-tx v22.0rc2 +.SH SYNOPSIS +.B bitcoin-tx +[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR +.br +.B bitcoin-tx +[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR +.SH DESCRIPTION +Bitcoin Core bitcointx utility version v22.0rc2 +.SH OPTIONS +.HP +? +.IP +Print this help message and exit +.HP +\fBcreate\fR +.IP +Create new, empty TX. +.HP +\fBjson\fR +.IP +Select JSON output +.HP +\fBtxid\fR +.IP +Output only the hexencoded transaction id of the resultant transaction. +.HP +\fBversion\fR +.IP +Print version and exit +.PP +Debugging/Testing options: +.PP +Chain selection options: +.HP +\fBchain=\fR<chain> +.IP +Use the chain <chain> (default: main). Allowed values: main, test, +signet, regtest +.HP +\fBsignet\fR +.IP +Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fBsignetchallenge\fR parameter +.HP +\fBsignetchallenge\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 +\fBsignetseednode\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 +\fBtestnet\fR +.IP +Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +.PP +Commands: +.IP +delin=N +.IP +Delete input N from TX +.IP +delout=N +.IP +Delete output N from TX +.IP +in=TXID:VOUT(:SEQUENCE_NUMBER) +.IP +Add input to TX +.IP +locktime=N +.IP +Set TX lock time to N +.IP +nversion=N +.IP +Set TX version to N +.IP +outaddr=VALUE:ADDRESS +.IP +Add addressbased output to TX +.IP +outdata=[VALUE:]DATA +.IP +Add databased output to TX +.IP +outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS] +.IP +Add Pay To nofm Multisig output to TX. n = REQUIRED, m = PUBKEYS. +Optionally add the "W" flag to produce a +paytowitnessscripthash output. Optionally add the "S" flag to +wrap the output in a paytoscripthash. +.IP +outpubkey=VALUE:PUBKEY[:FLAGS] +.IP +Add paytopubkey output to TX. Optionally add the "W" flag to produce a +paytowitnesspubkeyhash output. Optionally add the "S" flag to +wrap the output in a paytoscripthash. +.IP +outscript=VALUE:SCRIPT[:FLAGS] +.IP +Add raw script output to TX. Optionally add the "W" flag to produce a +paytowitnessscripthash output. Optionally add the "S" flag to +wrap the output in a paytoscripthash. +.IP +replaceable(=N) +.IP +Set RBF optin sequence number for input N (if not provided, optin all +available inputs) +.IP +sign=SIGHASHFLAGS +.IP +Add zero or more signatures to transaction. This command requires JSON +registers:prevtxs=JSON object, privatekeys=JSON object. See +signrawtransactionwithkey docs for format of sighash flags, JSON +objects. +.PP +Register Commands: +.IP +load=NAME:FILENAME +.IP +Load JSON file FILENAME into register NAME +.IP +set=NAME:JSONSTRING +.IP +Set register NAME to given JSONSTRING diff --git a/doc/man/bitcoin-util.1 b/doc/man/bitcoin-util.1 index 5c733c6e21..35a3ff05b8 100644 --- a/doc/man/bitcoin-util.1 +++ b/doc/man/bitcoin-util.1 @@ -1,5 +1,55 @@ -.TH BITCOIN-UTIL "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. +.TH BITCOIN-UTIL "1" "August 2021" "bitcoin-util v22.0rc2" "User Commands" .SH NAME -bitcoin-util \- manual page for bitcoin-util - -This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. +bitcoin-util manual page for bitcoin-util v22.0rc2 +.SH SYNOPSIS +.B bitcoin-util +[\fI\,options\/\fR] [\fI\,commands\/\fR] \fI\,Do stuff\/\fR +.SH DESCRIPTION +Bitcoin Core bitcoinutil utility version v22.0rc2 +.SH OPTIONS +.HP +? +.IP +Print this help message and exit +.HP +\fBversion\fR +.IP +Print version and exit +.PP +Debugging/Testing options: +.PP +Chain selection options: +.HP +\fBchain=\fR<chain> +.IP +Use the chain <chain> (default: main). Allowed values: main, test, +signet, regtest +.HP +\fBsignet\fR +.IP +Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fBsignetchallenge\fR parameter +.HP +\fBsignetchallenge\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 +\fBsignetseednode\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 +\fBtestnet\fR +.IP +Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +.PP +Commands: +.IP +grind +.IP +Perform proof of work on hex header string diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1 index 2da43dec66..1a01718c20 100644 --- a/doc/man/bitcoin-wallet.1 +++ b/doc/man/bitcoin-wallet.1 @@ -1,5 +1,107 @@ -.TH BITCOIN-WALLET "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. +.TH BITCOIN-WALLET "1" "August 2021" "bitcoin-wallet v22.0rc2" "User Commands" .SH NAME -bitcoin-wallet \- manual page for bitcoin-wallet - -This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. +bitcoin-wallet manual page for bitcoin-wallet v22.0rc2 +.SH DESCRIPTION +Bitcoin Core bitcoinwallet version v22.0rc2 +.PP +bitcoinwallet is an offline tool for creating and interacting with Bitcoin Core wallet files. +By default bitcoinwallet will act on wallets in the default mainnet wallet directory in the datadir. +To change the target wallet, use the \fBdatadir\fR, \fBwallet\fR and \fBtestnet\fR/regtest arguments. +.SS "Usage:" +.IP +bitcoinwallet [options] <command> +.SH OPTIONS +.HP +? +.IP +Print this help message and exit +.HP +\fBdatadir=\fR<dir> +.IP +Specify data directory +.HP +\fBdescriptors\fR +.IP +Create descriptors wallet. Only for 'create' +.HP +\fBdumpfile=\fR<file name> +.IP +When used with 'dump', writes out the records to this file. When used +with 'createfromdump', loads the records into a new wallet. +.HP +\fBformat=\fR<format> +.IP +The format of the wallet file to create. Either "bdb" or "sqlite". Only +used with 'createfromdump' +.HP +\fBversion\fR +.IP +Print version and exit +.HP +\fBwallet=\fR<walletname> +.IP +Specify wallet name +.PP +Debugging/Testing options: +.HP +\fBdebug=\fR<category> +.IP +Output debugging information (default: 0). +.HP +\fBprinttoconsole\fR +.IP +Send trace/debug info to console (default: 1 when no \fBdebug\fR is true, 0 +otherwise). +.PP +Chain selection options: +.HP +\fBchain=\fR<chain> +.IP +Use the chain <chain> (default: main). Allowed values: main, test, +signet, regtest +.HP +\fBsignet\fR +.IP +Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fBsignetchallenge\fR parameter +.HP +\fBsignetchallenge\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 +\fBsignetseednode\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 +\fBtestnet\fR +.IP +Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +.PP +Commands: +.IP +create +.IP +Create new wallet file +.IP +createfromdump +.IP +Create new wallet file from dumped records +.IP +dump +.IP +Print out all of the wallet keyvalue records +.IP +info +.IP +Get wallet info +.IP +salvage +.IP +Attempt to recover private keys from a corrupt wallet. Warning: +\&'salvage' is experimental. diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index 2c88f74520..2ab6c2a339 100644 --- a/doc/man/bitcoind.1 +++ b/doc/man/bitcoind.1 @@ -1,5 +1,767 @@ -.TH BITCOIND "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. +.TH BITCOIND "1" "August 2021" "bitcoind v22.0rc2" "User Commands" .SH NAME -bitcoind \- manual page for bitcoind - -This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. +bitcoind manual page for bitcoind v22.0rc2 +.SH SYNOPSIS +.B bitcoind +[\fI\,options\/\fR] \fI\,Start Bitcoin Core\/\fR +.SH DESCRIPTION +Bitcoin Core version v22.0rc2 +Copyright \(co 20092021 The Bitcoin Core developers +.PP +Please contribute if you find Bitcoin Core useful. Visit +<https://bitcoincore.org/> for further information about the software. +The source code is available from <https://github.com/bitcoin/bitcoin>. +.PP +This is experimental software. +Distributed under the MIT software license, see the accompanying file COPYING +or <https://opensource.org/licenses/MIT> +.SH OPTIONS +.HP +? +.IP +Print this help message and exit +.HP +\fBalertnotify=\fR<cmd> +.IP +Execute command when a relevant alert is received or we see a really +long fork (%s in cmd is replaced by message) +.HP +\fBassumevalid=\fR<hex> +.IP +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: +00000000000000000008a89e854d57e5667df88f1cdef6fde2fbca1de5b639ad, +testnet: +0000000000004ae2f3896ca8ecd41c460a35bf6184e145d91558cece1c688a76, +signet: +000000187d4440e5bff91488b700a140441e089a8aaea707414982460edbfe54) +.HP +\fBblockfilterindex=\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 +\fBblocknotify=\fR<cmd> +.IP +Execute command when the best block changes (%s in cmd is replaced by +block hash) +.HP +\fBblockreconstructionextratxn=\fR<n> +.IP +Extra transactions to keep in memory for compact block reconstructions +(default: 100) +.HP +\fBblocksdir=\fR<dir> +.IP +Specify directory to hold blocks subdirectory for *.dat files (default: +<datadir>) +.HP +\fBblocksonly\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 +\fBcoinstatsindex\fR +.IP +Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) +.HP +\fBconf=\fR<file> +.IP +Specify path to readonly configuration file. Relative paths will be +prefixed by datadir location. (default: bitcoin.conf) +.HP +\fBdaemon\fR +.IP +Run in the background as a daemon and accept commands (default: 0) +.HP +\fBdaemonwait\fR +.IP +Wait for initialization to be finished before exiting. This implies +\fBdaemon\fR (default: 0) +.HP +\fBdatadir=\fR<dir> +.IP +Specify data directory +.HP +\fBdbcache=\fR<n> +.IP +Maximum database cache size <n> MiB (4 to 16384, default: 450). In +addition, unused mempool memory is shared for this cache (see +\fBmaxmempool\fR). +.HP +\fBdebuglogfile=\fR<file> +.IP +Specify location of debug log file. Relative paths will be prefixed by a +netspecific datadir location. (\fBnodebuglogfile\fR to disable; +default: debug.log) +.HP +\fBincludeconf=\fR<file> +.IP +Specify additional configuration file, relative to the \fBdatadir\fR path +(only useable from configuration file, not command line) +.HP +\fBloadblock=\fR<file> +.IP +Imports blocks from external file on startup +.HP +\fBmaxmempool=\fR<n> +.IP +Keep the transaction memory pool below <n> megabytes (default: 300) +.HP +\fBmaxorphantx=\fR<n> +.IP +Keep at most <n> unconnectable transactions in memory (default: 100) +.HP +\fBmempoolexpiry=\fR<n> +.IP +Do not keep transactions in the mempool longer than <n> hours (default: +336) +.HP +\fBpar=\fR<n> +.IP +Set the number of script verification threads (\fB6\fR to 15, 0 = auto, <0 = +leave that many cores free, default: 0) +.HP +\fBpersistmempool\fR +.IP +Whether to save the mempool on shutdown and load on restart (default: 1) +.HP +\fBpid=\fR<file> +.IP +Specify pid file. Relative paths will be prefixed by a netspecific +datadir location. (default: bitcoind.pid) +.HP +\fBprune=\fR<n> +.IP +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 \fBtxindex\fR, \fBcoinstatsindex\fR and \fBrescan\fR. Warning: +Reverting this setting requires redownloading 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 +\fBreindex\fR +.IP +Rebuild chain state and block index from the blk*.dat files on disk +.HP +\fBreindexchainstate\fR +.IP +Rebuild chain state from the currently indexed blocks. When in pruning +mode or if blocks on disk might be corrupted, use full \fBreindex\fR +instead. +.HP +\fBsettings=\fR<file> +.IP +Specify path to dynamic settings data file. Can be disabled with +\fBnosettings\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 +\fBstartupnotify=\fR<cmd> +.IP +Execute command on startup. +.HP +\fBsysperms\fR +.IP +Create new files with system default permissions, instead of umask 077 +(only effective with disabled wallet functionality) +.HP +\fBtxindex\fR +.IP +Maintain a full transaction index, used by the getrawtransaction rpc +call (default: 0) +.HP +\fBversion\fR +.IP +Print version and exit +.PP +Connection options: +.HP +\fBaddnode=\fR<ip> +.IP +Add a node to connect to and attempt to keep the connection open (see +the addnode RPC help for more info). This option can be specified +multiple times to add multiple nodes; connections are limited to +8 at a time and are counted separately from the \fBmaxconnections\fR +limit. +.HP +\fBasmap=\fR<file> +.IP +Specify asn mapping used for bucketing of the peers (default: +ip_asn.map). Relative paths will be prefixed by the netspecific +datadir location. +.HP +\fBbantime=\fR<n> +.IP +Default duration (in seconds) of manually configured bans (default: +86400) +.HP +\fBbind=\fR<addr>[:<port>][=onion] +.IP +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 +\fBconnect=\fR<ip> +.IP +Connect only to the specified node; \fBnoconnect\fR disables automatic +connections (the rules for this peer are the same as for +\fBaddnode\fR). This option can be specified multiple times to connect +to multiple nodes. +.HP +\fBdiscover\fR +.IP +Discover own IP addresses (default: 1 when listening and no \fBexternalip\fR +or \fBproxy\fR) +.HP +\fBdns\fR +.IP +Allow DNS lookups for \fBaddnode\fR, \fBseednode\fR and \fBconnect\fR (default: 1) +.HP +\fBdnsseed\fR +.IP +Query for peer addresses via DNS lookup, if low on addresses (default: 1 +unless \fBconnect\fR used) +.HP +\fBexternalip=\fR<ip> +.IP +Specify your own public address +.HP +\fBfixedseeds\fR +.IP +Allow fixed seeds if DNS seeds don't provide peers (default: 1) +.HP +\fBforcednsseed\fR +.IP +Always query for peer addresses via DNS lookup (default: 0) +.HP +\fBi2pacceptincoming\fR +.IP +If set and \fBi2psam\fR is also set then incoming I2P connections are +accepted via the SAM proxy. If this is not set but \fBi2psam\fR is set +then only outgoing connections will be made to the I2P network. +Ignored if \fBi2psam\fR is not set. Listening for incoming I2P +connections is done through the SAM proxy, not by binding to a +local address and port (default: 1) +.HP +\fBi2psam=\fR<ip:port> +.IP +I2P SAM proxy to reach I2P peers and accept I2P connections (default: +none) +.HP +\fBlisten\fR +.IP +Accept connections from outside (default: 1 if no \fBproxy\fR or \fBconnect\fR) +.HP +\fBlistenonion\fR +.IP +Automatically create Tor onion service (default: 1) +.HP +\fBmaxconnections=\fR<n> +.IP +Maintain at most <n> connections to peers (default: 125). This limit +does not apply to connections manually added via \fBaddnode\fR or the +addnode RPC, which have a separate limit of 8. +.HP +\fBmaxreceivebuffer=\fR<n> +.IP +Maximum perconnection receive buffer, <n>*1000 bytes (default: 5000) +.HP +\fBmaxsendbuffer=\fR<n> +.IP +Maximum perconnection send buffer, <n>*1000 bytes (default: 1000) +.HP +\fBmaxtimeadjustment\fR +.IP +Maximum allowed median peer time offset adjustment. Local perspective of +time may be influenced by peers forward or backward by this +amount. (default: 4200 seconds) +.HP +\fBmaxuploadtarget=\fR<n> +.IP +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 +\fBnatpmp\fR +.IP +Use NATPMP to map the listening port (default: 0) +.HP +\fBnetworkactive\fR +.IP +Enable all P2P network activity (default: 1). Can be changed by the +setnetworkactive RPC command +.HP +\fBonion=\fR<ip:port> +.IP +Use separate SOCKS5 proxy to reach peers via Tor onion services, set +\fBnoonion\fR to disable (default: \fBproxy\fR) +.HP +\fBonlynet=\fR<net> +.IP +Make outgoing connections only through network <net> (ipv4, ipv6, onion, +i2p). Incoming connections are not affected by this option. This +option can be specified multiple times to allow multiple +networks. Warning: if it is used with nononion networks and the +\fBonion\fR or \fBproxy\fR option is set, then outbound onion connections +will still be made; use \fBnoonion\fR or \fBonion\fR=\fI\,0\/\fR to disable outbound +onion connections in this case. +.HP +\fBpeerblockfilters\fR +.IP +Serve compact block filters to peers per BIP 157 (default: 0) +.HP +\fBpeerbloomfilters\fR +.IP +Support filtering of blocks and transaction with bloom filters (default: +0) +.HP +\fBpermitbaremultisig\fR +.IP +Relay nonP2SH multisig (default: 1) +.HP +\fBport=\fR<port> +.IP +Listen for connections on <port>. Nodes not using the default ports +(default: 8333, testnet: 18333, signet: 38333, regtest: 18444) +are unlikely to get incoming connections. Not relevant for I2P +(see doc/i2p.md). +.HP +\fBproxy=\fR<ip:port> +.IP +Connect through SOCKS5 proxy, set \fBnoproxy\fR to disable (default: +disabled) +.HP +\fBproxyrandomize\fR +.IP +Randomize credentials for every proxy connection. This enables Tor +stream isolation (default: 1) +.HP +\fBseednode=\fR<ip> +.IP +Connect to a node to retrieve peer addresses, and disconnect. This +option can be specified multiple times to connect to multiple +nodes. +.HP +\fBtimeout=\fR<n> +.IP +Specify socket connection timeout in milliseconds. If an initial attempt +to connect is unsuccessful after this amount of time, drop it +(minimum: 1, default: 5000) +.HP +\fBtorcontrol=\fR<ip>:<port> +.IP +Tor control port to use if onion listening enabled (default: +127.0.0.1:9051) +.HP +\fBtorpassword=\fR<pass> +.IP +Tor control port password (default: empty) +.HP +\fBupnp\fR +.IP +Use UPnP to map the listening port (default: 0) +.HP +\fBwhitebind=\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 \fBblocksonly\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 uptodate info). Specify multiple +permissions separated by commas (default: +download,noban,mempool,relay). Can be specified multiple times. +.HP +\fBwhitelist=\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 CIDRnotated network (e.g. 1.2.3.0/24). Uses +the same permissions as \fBwhitebind\fR. Can be specified multiple +times. +.PP +Wallet options: +.HP +\fBaddresstype\fR +.IP +What type of addresses to use ("legacy", "p2shsegwit", or "bech32", +default: "bech32") +.HP +\fBavoidpartialspends\fR +.IP +Group outputs by address, selecting many (possibly all) or none, instead +of selecting on a peroutput basis. Privacy is improved as +addresses are mostly swept with fewer transactions and outputs +are aggregated in clean change addresses. It may result in higher +fees due to less optimal coin selection caused by this added +limitation and possibly a largerthannecessary number of inputs +being used. Always enabled for wallets with "avoid_reuse" +enabled, otherwise default: 0. +.HP +\fBchangetype\fR +.IP +What type of change to use ("legacy", "p2shsegwit", or "bech32"). +Default is same as \fBaddresstype\fR, except when +\fBaddresstype\fR=\fI\,p2shsegwit\/\fR a native segwit output is used when +sending to a native segwit address) +.HP +\fBdisablewallet\fR +.IP +Do not load the wallet and disable wallet RPC calls +.HP +\fBdiscardfee=\fR<amt> +.IP +The fee rate (in BTC/kvB) 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 +\fBfallbackfee=\fR<amt> +.IP +A fee rate (in BTC/kvB) that will be used when fee estimation has +insufficient data. 0 to entirely disable the fallbackfee feature. +(default: 0.00) +.HP +\fBkeypool=\fR<n> +.IP +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 +\fBmaxapsfee=\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 +\fBmintxfee=\fR<amt> +.IP +Fee rates (in BTC/kvB) smaller than this are considered zero fee for +transaction creation (default: 0.00001) +.HP +\fBpaytxfee=\fR<amt> +.IP +Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00) +.HP +\fBrescan\fR +.IP +Rescan the block chain for missing wallet transactions on startup +.HP +\fBsigner=\fR<cmd> +.IP +External signing tool, see doc/externalsigner.md +.HP +\fBspendzeroconfchange\fR +.IP +Spend unconfirmed change when sending transactions (default: 1) +.HP +\fBtxconfirmtarget=\fR<n> +.IP +If paytxfee is not set, include enough fee so transactions begin +confirmation on average within n blocks (default: 6) +.HP +\fBwallet=\fR<path> +.IP +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 toplevel data files in +<walletdir>. +.HP +\fBwalletbroadcast\fR +.IP +Make the wallet broadcast transactions (default: 1) +.HP +\fBwalletdir=\fR<dir> +.IP +Specify directory to hold wallets (default: <datadir>/wallets if it +exists, otherwise <datadir>) +.HP +\fBwalletnotify=\fR<cmd> +.IP +Execute command when a wallet transaction changes. %s in cmd is replaced +by TxID, %w is replaced by wallet name, %b is replaced by the +hash of the block including the transaction (set to 'unconfirmed' +if the transaction is not included) and %h is replaced by the +block height (\fB1\fR if not included). %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 +\fBwalletrbf\fR +.IP +Send transactions with fullRBF optin enabled (RPC only, default: 0) +.PP +ZeroMQ notification options: +.HP +\fBzmqpubhashblock=\fR<address> +.IP +Enable publish hash block in <address> +.HP +\fBzmqpubhashblockhwm=\fR<n> +.IP +Set publish hash block outbound message high water mark (default: 1000) +.HP +\fBzmqpubhashtx=\fR<address> +.IP +Enable publish hash transaction in <address> +.HP +\fBzmqpubhashtxhwm=\fR<n> +.IP +Set publish hash transaction outbound message high water mark (default: +1000) +.HP +\fBzmqpubrawblock=\fR<address> +.IP +Enable publish raw block in <address> +.HP +\fBzmqpubrawblockhwm=\fR<n> +.IP +Set publish raw block outbound message high water mark (default: 1000) +.HP +\fBzmqpubrawtx=\fR<address> +.IP +Enable publish raw transaction in <address> +.HP +\fBzmqpubrawtxhwm=\fR<n> +.IP +Set publish raw transaction outbound message high water mark (default: +1000) +.HP +\fBzmqpubsequence=\fR<address> +.IP +Enable publish hash block and tx sequence in <address> +.HP +\fBzmqpubsequencehwm=\fR<n> +.IP +Set publish hash sequence message high water mark (default: 1000) +.PP +Debugging/Testing options: +.HP +\fBdebug=\fR<category> +.IP +Output debugging information (default: \fBnodebug\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, walletdb, rpc, estimatefee, addrman, +selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, +libevent, coindb, qt, leveldb, validation, i2p, ipc. This option +can be specified multiple times to output multiple categories. +.HP +\fBdebugexclude=\fR<category> +.IP +Exclude debugging information for a category. Can be used in conjunction +with \fBdebug\fR=\fI\,1\/\fR to output debug logs for all categories except the +specified category. This option can be specified multiple times +to exclude multiple categories. +.HP +\fBhelpdebug\fR +.IP +Print help message with debugging options and exit +.HP +\fBlogips\fR +.IP +Include IP addresses in debug output (default: 0) +.HP +\fBlogsourcelocations\fR +.IP +Prepend debug output with name of the originating source location +(source file, line number and function name) (default: 0) +.HP +\fBlogthreadnames\fR +.IP +Prepend debug output with name of the originating thread (only available +on platforms supporting thread_local) (default: 0) +.HP +\fBlogtimestamps\fR +.IP +Prepend debug output with timestamp (default: 1) +.HP +\fBmaxtxfee=\fR<amt> +.IP +Maximum total fees (in BTC) to use in a single wallet transaction; +setting this too low may abort large transactions (default: 0.10) +.HP +\fBprinttoconsole\fR +.IP +Send trace/debug info to console (default: 1 when no \fBdaemon\fR. To disable +logging to file, set \fBnodebuglogfile\fR) +.HP +\fBshrinkdebugfile\fR +.IP +Shrink debug.log file on client startup (default: 1 when no \fBdebug\fR) +.HP +\fBuacomment=\fR<cmt> +.IP +Append comment to the user agent string +.PP +Chain selection options: +.HP +\fBchain=\fR<chain> +.IP +Use the chain <chain> (default: main). Allowed values: main, test, +signet, regtest +.HP +\fBsignet\fR +.IP +Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fBsignetchallenge\fR parameter +.HP +\fBsignetchallenge\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 +\fBsignetseednode\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 +\fBtestnet\fR +.IP +Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +.PP +Node relay options: +.HP +\fBbytespersigop\fR +.IP +Equivalent bytes per sigop in transactions for relay and mining +(default: 20) +.HP +\fBdatacarrier\fR +.IP +Relay and mine data carrier transactions (default: 1) +.HP +\fBdatacarriersize\fR +.IP +Maximum size of data in data carrier transactions we relay and mine +(default: 83) +.HP +\fBminrelaytxfee=\fR<amt> +.IP +Fees (in BTC/kvB) smaller than this are considered zero fee for +relaying, mining and transaction creation (default: 0.00001) +.HP +\fBwhitelistforcerelay\fR +.IP +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 +\fBwhitelistrelay\fR +.IP +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 +\fBblockmaxweight=\fR<n> +.IP +Set maximum BIP141 block weight (default: 3996000) +.HP +\fBblockmintxfee=\fR<amt> +.IP +Set lowest fee rate (in BTC/kvB) for transactions to be included in +block creation. (default: 0.00001) +.PP +RPC server options: +.HP +\fBrest\fR +.IP +Accept public REST requests (default: 0) +.HP +\fBrpcallowip=\fR<ip> +.IP +Allow JSONRPC connections from specified source. Valid for <ip> are a +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 +\fBrpcauth=\fR<userpw> +.IP +Username and HMACSHA256 hashed password for JSONRPC connections. The +field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A +canonical python script is included in share/rpcauth. The client +then connects normally using the +rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This +option can be specified multiple times +.HP +\fBrpcbind=\fR<addr>[:port] +.IP +Bind to given address to listen for JSONRPC connections. Do not expose +the RPC server to untrusted networks such as the public internet! +This option is ignored unless \fBrpcallowip\fR is also passed. Port is +optional and overrides \fBrpcport\fR. Use [host]:port notation for +IPv6. This option can be specified multiple times (default: +127.0.0.1 and ::1 i.e., localhost) +.HP +\fBrpccookiefile=\fR<loc> +.IP +Location of the auth cookie. Relative paths will be prefixed by a +netspecific datadir location. (default: data dir) +.HP +\fBrpcpassword=\fR<pw> +.IP +Password for JSONRPC connections +.HP +\fBrpcport=\fR<port> +.IP +Listen for JSONRPC connections on <port> (default: 8332, testnet: +18332, signet: 38332, regtest: 18443) +.HP +\fBrpcserialversion\fR +.IP +Sets the serialization of raw transaction or block hex returned in +nonverbose mode, nonsegwit(0) or segwit(1) (default: 1) +.HP +\fBrpcthreads=\fR<n> +.IP +Set the number of threads to service RPC calls (default: 4) +.HP +\fBrpcuser=\fR<user> +.IP +Username for JSONRPC connections +.HP +\fBrpcwhitelist=\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 setintersected. See \fBrpcwhitelistdefault\fR documentation +for information on default whitelist behavior. +.HP +\fBrpcwhitelistdefault\fR +.IP +Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault +is set to 0, if any \fBrpcwhitelist\fR is set, the rpc server acts as +if all rpc users are subject to emptyunlessotherwisespecified +whitelists. If rpcwhitelistdefault is set to 1 and no +\fBrpcwhitelist\fR is set, rpc server acts as if all rpc users are +subject to empty whitelists. +.HP +\fBserver\fR +.IP +Accept command line and JSONRPC commands |