diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/bitcoin-cli.1 | 94 | ||||
| -rw-r--r-- | doc/man/bitcoin-qt.1 | 424 | ||||
| -rw-r--r-- | doc/man/bitcoin-tx.1 | 62 | ||||
| -rw-r--r-- | doc/man/bitcoin-util.1 | 26 | ||||
| -rw-r--r-- | doc/man/bitcoin-wallet.1 | 52 | ||||
| -rw-r--r-- | doc/man/bitcoind.1 | 416 |
6 files changed, 537 insertions, 537 deletions
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index 8bcbe08a9b..aee651cac0 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.13. -.TH BITCOIN-CLI "1" "August 2021" "bitcoin-cli v22.0rc2" "User Commands" +.TH BITCOIN-CLI "1" "August 2021" "bitcoin-cli v22.0.0rc3" "User Commands" .SH NAME -bitcoin-cli manual page for bitcoin-cli v22.0rc2 +bitcoin-cli \- manual page for bitcoin-cli v22.0.0rc3 .SH SYNOPSIS .B bitcoin-cli [\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR @@ -15,119 +15,119 @@ bitcoin-cli manual page for bitcoin-cli v22.0rc2 .B bitcoin-cli [\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR .SH DESCRIPTION -Bitcoin Core RPC client version v22.0rc2 +Bitcoin Core RPC client version v22.0.0rc3 .SH OPTIONS .HP -? +\-? .IP Print this help message and exit .HP -\fBaddrinfo\fR +\fB\-addrinfo\fR .IP Get the number of addresses known to the node, per network and total. .HP -\fBconf=\fR<file> +\fB\-conf=\fR<file> .IP Specify configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf) .HP -\fBdatadir=\fR<dir> +\fB\-datadir=\fR<dir> .IP Specify data directory .HP -\fBgenerate\fR +\fB\-generate\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 +nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4 1000 .HP -\fBgetinfo\fR +\fB\-getinfo\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 +server\-side RPC calls, the results of \fB\-getinfo\fR is the result of +multiple non\-atomic 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 +\fB\-named\fR .IP Pass named instead of positional arguments (default: false) .HP -\fBnetinfo\fR +\fB\-netinfo\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> +\fB\-rpcclienttimeout=\fR<n> .IP Timeout in seconds during HTTP requests, or 0 for no timeout. (default: 900) .HP -\fBrpcconnect=\fR<ip> +\fB\-rpcconnect=\fR<ip> .IP Send commands to node running on <ip> (default: 127.0.0.1) .HP -\fBrpccookiefile=\fR<loc> +\fB\-rpccookiefile=\fR<loc> .IP Location of the auth cookie. Relative paths will be prefixed by a -netspecific datadir location. (default: data dir) +net\-specific datadir location. (default: data dir) .HP -\fBrpcpassword=\fR<pw> +\fB\-rpcpassword=\fR<pw> .IP -Password for JSONRPC connections +Password for JSON\-RPC connections .HP -\fBrpcport=\fR<port> +\fB\-rpcport=\fR<port> .IP -Connect to JSONRPC on <port> (default: 8332, testnet: 18332, signet: +Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, signet: 38332, regtest: 18443) .HP -\fBrpcuser=\fR<user> +\fB\-rpcuser=\fR<user> .IP -Username for JSONRPC connections +Username for JSON\-RPC connections .HP -\fBrpcwait\fR +\fB\-rpcwait\fR .IP Wait for RPC server to start .HP -\fBrpcwaittimeout=\fR<n> +\fB\-rpcwaittimeout=\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> +\fB\-rpcwallet=\fR<walletname> .IP -Send RPC for nondefault wallet on RPC server (needs to exactly match -corresponding \fBwallet\fR option passed to bitcoind). This changes +Send RPC for non\-default wallet on RPC server (needs to exactly match +corresponding \fB\-wallet\fR option passed to bitcoind). This changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wallet/<walletname> .HP -\fBstdin\fR +\fB\-stdin\fR .IP -Read extra arguments from standard input, one per line until EOF/CtrlD +Read extra arguments from standard input, one per line until EOF/Ctrl\-D (recommended for sensitive information such as passphrases). When -combined with \fBstdinrpcpass\fR, the first line from standard input +combined with \fB\-stdinrpcpass\fR, the first line from standard input is used for the RPC password. .HP -\fBstdinrpcpass\fR +\fB\-stdinrpcpass\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 +with \fB\-stdin\fR, the first line from standard input is used for the +RPC password. When combined with \fB\-stdinwalletpassphrase\fR, +\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR consumes the second. .HP -\fBstdinwalletpassphrase\fR +\fB\-stdinwalletpassphrase\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 +combined with \fB\-stdin\fR, the first line from standard input is used for the wallet passphrase. .HP -\fBversion\fR +\fB\-version\fR .IP Print version and exit .PP @@ -135,29 +135,29 @@ Debugging/Testing options: .PP Chain selection options: .HP -\fBchain=\fR<chain> +\fB\-chain=\fR<chain> .IP Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest .HP -\fBsignet\fR +\fB\-signet\fR .IP -Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fBsignetchallenge\fR parameter +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 -\fBsignetchallenge\fR +\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 -\fBsignetseednode\fR +\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 -\fBtestnet\fR +\fB\-testnet\fR .IP -Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 index 68fa6709f4..a5e5a05e1e 100644 --- a/doc/man/bitcoin-qt.1 +++ b/doc/man/bitcoin-qt.1 @@ -1,24 +1,24 @@ .\" 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" +.TH BITCOIN-QT "1" "August 2021" "bitcoin-qt v22.0.0rc3" "User Commands" .SH NAME -bitcoin-qt manual page for bitcoin-qt v22.0rc2 +bitcoin-qt \- manual page for bitcoin-qt v22.0.0rc3 .SH SYNOPSIS .B bitcoin-qt [\fI\,command-line options\/\fR] .SH DESCRIPTION -Bitcoin Core version v22.0rc2 +Bitcoin Core version v22.0.0rc3 .SH OPTIONS .HP -? +\-? .IP Print this help message and exit .HP -\fBalertnotify=\fR<cmd> +\fB\-alertnotify=\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> +\fB\-assumevalid=\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, @@ -29,174 +29,174 @@ testnet: signet: 000000187d4440e5bff91488b700a140441e089a8aaea707414982460edbfe54) .HP -\fBblockfilterindex=\fR<type> +\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 -\fBblocknotify=\fR<cmd> +\fB\-blocknotify=\fR<cmd> .IP Execute command when the best block changes (%s in cmd is replaced by block hash) .HP -\fBblockreconstructionextratxn=\fR<n> +\fB\-blockreconstructionextratxn=\fR<n> .IP Extra transactions to keep in memory for compact block reconstructions (default: 100) .HP -\fBblocksdir=\fR<dir> +\fB\-blocksdir=\fR<dir> .IP Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>) .HP -\fBblocksonly\fR +\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 -\fBcoinstatsindex\fR +\fB\-coinstatsindex\fR .IP Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) .HP -\fBconf=\fR<file> +\fB\-conf=\fR<file> .IP -Specify path to readonly configuration file. Relative paths will be +Specify path to read\-only configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf) .HP -\fBdaemon\fR +\fB\-daemon\fR .IP Run in the background as a daemon and accept commands (default: 0) .HP -\fBdaemonwait\fR +\fB\-daemonwait\fR .IP Wait for initialization to be finished before exiting. This implies -\fBdaemon\fR (default: 0) +\fB\-daemon\fR (default: 0) .HP -\fBdatadir=\fR<dir> +\fB\-datadir=\fR<dir> .IP Specify data directory .HP -\fBdbcache=\fR<n> +\fB\-dbcache=\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). +\fB\-maxmempool\fR). .HP -\fBdebuglogfile=\fR<file> +\fB\-debuglogfile=\fR<file> .IP Specify location of debug log file. Relative paths will be prefixed by a -netspecific datadir location. (\fBnodebuglogfile\fR to disable; +net\-specific datadir location. (\fB\-nodebuglogfile\fR to disable; default: debug.log) .HP -\fBincludeconf=\fR<file> +\fB\-includeconf=\fR<file> .IP -Specify additional configuration file, relative to the \fBdatadir\fR path +Specify additional configuration file, relative to the \fB\-datadir\fR path (only useable from configuration file, not command line) .HP -\fBloadblock=\fR<file> +\fB\-loadblock=\fR<file> .IP Imports blocks from external file on startup .HP -\fBmaxmempool=\fR<n> +\fB\-maxmempool=\fR<n> .IP Keep the transaction memory pool below <n> megabytes (default: 300) .HP -\fBmaxorphantx=\fR<n> +\fB\-maxorphantx=\fR<n> .IP Keep at most <n> unconnectable transactions in memory (default: 100) .HP -\fBmempoolexpiry=\fR<n> +\fB\-mempoolexpiry=\fR<n> .IP Do not keep transactions in the mempool longer than <n> hours (default: 336) .HP -\fBpar=\fR<n> +\fB\-par=\fR<n> .IP -Set the number of script verification threads (\fB6\fR to 15, 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 -\fBpersistmempool\fR +\fB\-persistmempool\fR .IP Whether to save the mempool on shutdown and load on restart (default: 1) .HP -\fBpid=\fR<file> +\fB\-pid=\fR<file> .IP -Specify pid file. Relative paths will be prefixed by a netspecific +Specify pid file. Relative paths will be prefixed by a net\-specific datadir location. (default: bitcoind.pid) .HP -\fBprune=\fR<n> +\fB\-prune=\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 +incompatible with \fB\-txindex\fR, \fB\-coinstatsindex\fR and \fB\-rescan\fR. Warning: +Reverting this setting requires re\-downloading 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 +\fB\-reindex\fR .IP Rebuild chain state and block index from the blk*.dat files on disk .HP -\fBreindexchainstate\fR +\fB\-reindex\-chainstate\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 +mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR instead. .HP -\fBsettings=\fR<file> +\fB\-settings=\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 +\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 -\fBstartupnotify=\fR<cmd> +\fB\-startupnotify=\fR<cmd> .IP Execute command on startup. .HP -\fBsysperms\fR +\fB\-sysperms\fR .IP Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality) .HP -\fBtxindex\fR +\fB\-txindex\fR .IP Maintain a full transaction index, used by the getrawtransaction rpc call (default: 0) .HP -\fBversion\fR +\fB\-version\fR .IP Print version and exit .PP Connection options: .HP -\fBaddnode=\fR<ip> +\fB\-addnode=\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 +8 at a time and are counted separately from the \fB\-maxconnections\fR limit. .HP -\fBasmap=\fR<file> +\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 netspecific +ip_asn.map). Relative paths will be prefixed by the net\-specific datadir location. .HP -\fBbantime=\fR<n> +\fB\-bantime=\fR<n> .IP Default duration (in seconds) of manually configured bans (default: 86400) .HP -\fBbind=\fR<addr>[:<port>][=onion] +\fB\-bind=\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 @@ -204,219 +204,219 @@ 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> +\fB\-connect=\fR<ip> .IP -Connect only to the specified node; \fBnoconnect\fR disables automatic +Connect only to the specified node; \fB\-noconnect\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 +\fB\-addnode\fR). This option can be specified multiple times to connect to multiple nodes. .HP -\fBdiscover\fR +\fB\-discover\fR .IP -Discover own IP addresses (default: 1 when listening and no \fBexternalip\fR -or \fBproxy\fR) +Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR +or \fB\-proxy\fR) .HP -\fBdns\fR +\fB\-dns\fR .IP -Allow DNS lookups for \fBaddnode\fR, \fBseednode\fR and \fBconnect\fR (default: 1) +Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1) .HP -\fBdnsseed\fR +\fB\-dnsseed\fR .IP Query for peer addresses via DNS lookup, if low on addresses (default: 1 -unless \fBconnect\fR used) +unless \fB\-connect\fR used) .HP -\fBexternalip=\fR<ip> +\fB\-externalip=\fR<ip> .IP Specify your own public address .HP -\fBfixedseeds\fR +\fB\-fixedseeds\fR .IP Allow fixed seeds if DNS seeds don't provide peers (default: 1) .HP -\fBforcednsseed\fR +\fB\-forcednsseed\fR .IP Always query for peer addresses via DNS lookup (default: 0) .HP -\fBi2pacceptincoming\fR +\fB\-i2pacceptincoming\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 +If set and \fB\-i2psam\fR is also set then incoming I2P connections are +accepted via the SAM proxy. If this is not set but \fB\-i2psam\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 +Ignored if \fB\-i2psam\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> +\fB\-i2psam=\fR<ip:port> .IP I2P SAM proxy to reach I2P peers and accept I2P connections (default: none) .HP -\fBlisten\fR +\fB\-listen\fR .IP -Accept connections from outside (default: 1 if no \fBproxy\fR or \fBconnect\fR) +Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR) .HP -\fBlistenonion\fR +\fB\-listenonion\fR .IP Automatically create Tor onion service (default: 1) .HP -\fBmaxconnections=\fR<n> +\fB\-maxconnections=\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 +does not apply to connections manually added via \fB\-addnode\fR or the addnode RPC, which have a separate limit of 8. .HP -\fBmaxreceivebuffer=\fR<n> +\fB\-maxreceivebuffer=\fR<n> .IP -Maximum perconnection receive buffer, <n>*1000 bytes (default: 5000) +Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000) .HP -\fBmaxsendbuffer=\fR<n> +\fB\-maxsendbuffer=\fR<n> .IP -Maximum perconnection send buffer, <n>*1000 bytes (default: 1000) +Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000) .HP -\fBmaxtimeadjustment\fR +\fB\-maxtimeadjustment\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> +\fB\-maxuploadtarget=\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 +\fB\-natpmp\fR .IP -Use NATPMP to map the listening port (default: 0) +Use NAT\-PMP to map the listening port (default: 0) .HP -\fBnetworkactive\fR +\fB\-networkactive\fR .IP Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command .HP -\fBonion=\fR<ip:port> +\fB\-onion=\fR<ip:port> .IP Use separate SOCKS5 proxy to reach peers via Tor onion services, set -\fBnoonion\fR to disable (default: \fBproxy\fR) +\fB\-noonion\fR to disable (default: \fB\-proxy\fR) .HP -\fBonlynet=\fR<net> +\fB\-onlynet=\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 +networks. Warning: if it is used with non\-onion networks and the +\fB\-onion\fR or \fB\-proxy\fR option is set, then outbound onion connections +will still be made; use \fB\-noonion\fR or \fB\-onion\fR=\fI\,0\/\fR to disable outbound onion connections in this case. .HP -\fBpeerblockfilters\fR +\fB\-peerblockfilters\fR .IP Serve compact block filters to peers per BIP 157 (default: 0) .HP -\fBpeerbloomfilters\fR +\fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: 0) .HP -\fBpermitbaremultisig\fR +\fB\-permitbaremultisig\fR .IP -Relay nonP2SH multisig (default: 1) +Relay non\-P2SH multisig (default: 1) .HP -\fBport=\fR<port> +\fB\-port=\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> +\fB\-proxy=\fR<ip:port> .IP -Connect through SOCKS5 proxy, set \fBnoproxy\fR to disable (default: +Connect through SOCKS5 proxy, set \fB\-noproxy\fR to disable (default: disabled) .HP -\fBproxyrandomize\fR +\fB\-proxyrandomize\fR .IP Randomize credentials for every proxy connection. This enables Tor stream isolation (default: 1) .HP -\fBseednode=\fR<ip> +\fB\-seednode=\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> +\fB\-timeout=\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> +\fB\-torcontrol=\fR<ip>:<port> .IP Tor control port to use if onion listening enabled (default: 127.0.0.1:9051) .HP -\fBtorpassword=\fR<pass> +\fB\-torpassword=\fR<pass> .IP Tor control port password (default: empty) .HP -\fBupnp\fR +\fB\-upnp\fR .IP Use UPnP to map the listening port (default: 0) .HP -\fBwhitebind=\fR<[permissions@]addr> +\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 \fBblocksonly\fR mode, +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 uptodate info). Specify multiple +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 -\fBwhitelist=\fR<[permissions@]IP address or network> +\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 CIDRnotated network (e.g. 1.2.3.0/24). Uses -the same permissions as \fBwhitebind\fR. Can be specified multiple +(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 -\fBaddresstype\fR +\fB\-addresstype\fR .IP -What type of addresses to use ("legacy", "p2shsegwit", or "bech32", +What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", default: "bech32") .HP -\fBavoidpartialspends\fR +\fB\-avoidpartialspends\fR .IP Group outputs by address, selecting many (possibly all) or none, instead -of selecting on a peroutput basis. Privacy is improved as +of selecting on a per\-output 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 +limitation and possibly a larger\-than\-necessary number of inputs being used. Always enabled for wallets with "avoid_reuse" enabled, otherwise default: 0. .HP -\fBchangetype\fR +\fB\-changetype\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 +What type of change to use ("legacy", "p2sh\-segwit", or "bech32"). +Default is same as \fB\-addresstype\fR, except when +\fB\-addresstype\fR=\fI\,p2sh\-segwit\/\fR a native segwit output is used when sending to a native segwit address) .HP -\fBdisablewallet\fR +\fB\-disablewallet\fR .IP Do not load the wallet and disable wallet RPC calls .HP -\fBdiscardfee=\fR<amt> +\fB\-discardfee=\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 @@ -424,133 +424,133 @@ 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> +\fB\-fallbackfee=\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> +\fB\-keypool=\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> +\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 -\fBmintxfee=\fR<amt> +\fB\-mintxfee=\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> +\fB\-paytxfee=\fR<amt> .IP Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00) .HP -\fBrescan\fR +\fB\-rescan\fR .IP Rescan the block chain for missing wallet transactions on startup .HP -\fBsigner=\fR<cmd> +\fB\-signer=\fR<cmd> .IP -External signing tool, see doc/externalsigner.md +External signing tool, see doc/external\-signer.md .HP -\fBspendzeroconfchange\fR +\fB\-spendzeroconfchange\fR .IP Spend unconfirmed change when sending transactions (default: 1) .HP -\fBtxconfirmtarget=\fR<n> +\fB\-txconfirmtarget=\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> +\fB\-wallet=\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 +this also accepts names of existing top\-level data files in <walletdir>. .HP -\fBwalletbroadcast\fR +\fB\-walletbroadcast\fR .IP Make the wallet broadcast transactions (default: 1) .HP -\fBwalletdir=\fR<dir> +\fB\-walletdir=\fR<dir> .IP Specify directory to hold wallets (default: <datadir>/wallets if it exists, otherwise <datadir>) .HP -\fBwalletnotify=\fR<cmd> +\fB\-walletnotify=\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 +block height (\fB\-1\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 +\fB\-walletrbf\fR .IP -Send transactions with fullRBF optin enabled (RPC only, default: 0) +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) .PP ZeroMQ notification options: .HP -\fBzmqpubhashblock=\fR<address> +\fB\-zmqpubhashblock=\fR<address> .IP Enable publish hash block in <address> .HP -\fBzmqpubhashblockhwm=\fR<n> +\fB\-zmqpubhashblockhwm=\fR<n> .IP Set publish hash block outbound message high water mark (default: 1000) .HP -\fBzmqpubhashtx=\fR<address> +\fB\-zmqpubhashtx=\fR<address> .IP Enable publish hash transaction in <address> .HP -\fBzmqpubhashtxhwm=\fR<n> +\fB\-zmqpubhashtxhwm=\fR<n> .IP Set publish hash transaction outbound message high water mark (default: 1000) .HP -\fBzmqpubrawblock=\fR<address> +\fB\-zmqpubrawblock=\fR<address> .IP Enable publish raw block in <address> .HP -\fBzmqpubrawblockhwm=\fR<n> +\fB\-zmqpubrawblockhwm=\fR<n> .IP Set publish raw block outbound message high water mark (default: 1000) .HP -\fBzmqpubrawtx=\fR<address> +\fB\-zmqpubrawtx=\fR<address> .IP Enable publish raw transaction in <address> .HP -\fBzmqpubrawtxhwm=\fR<n> +\fB\-zmqpubrawtxhwm=\fR<n> .IP Set publish raw transaction outbound message high water mark (default: 1000) .HP -\fBzmqpubsequence=\fR<address> +\fB\-zmqpubsequence=\fR<address> .IP Enable publish hash block and tx sequence in <address> .HP -\fBzmqpubsequencehwm=\fR<n> +\fB\-zmqpubsequencehwm=\fR<n> .IP Set publish hash sequence message high water mark (default: 1000) .PP Debugging/Testing options: .HP -\fBdebug=\fR<category> +\fB\-debug=\fR<category> .IP -Output debugging information (default: \fBnodebug\fR, supplying <category> is +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, walletdb, rpc, estimatefee, addrman, @@ -558,110 +558,110 @@ 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> +\fB\-debugexclude=\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 +with \fB\-debug\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 +\fB\-help\-debug\fR .IP Print help message with debugging options and exit .HP -\fBlogips\fR +\fB\-logips\fR .IP Include IP addresses in debug output (default: 0) .HP -\fBlogsourcelocations\fR +\fB\-logsourcelocations\fR .IP Prepend debug output with name of the originating source location (source file, line number and function name) (default: 0) .HP -\fBlogthreadnames\fR +\fB\-logthreadnames\fR .IP Prepend debug output with name of the originating thread (only available on platforms supporting thread_local) (default: 0) .HP -\fBlogtimestamps\fR +\fB\-logtimestamps\fR .IP Prepend debug output with timestamp (default: 1) .HP -\fBmaxtxfee=\fR<amt> +\fB\-maxtxfee=\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 +\fB\-printtoconsole\fR .IP -Send trace/debug info to console (default: 1 when no \fBdaemon\fR. To disable -logging to file, set \fBnodebuglogfile\fR) +Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable +logging to file, set \fB\-nodebuglogfile\fR) .HP -\fBshrinkdebugfile\fR +\fB\-shrinkdebugfile\fR .IP -Shrink debug.log file on client startup (default: 1 when no \fBdebug\fR) +Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) .HP -\fBuacomment=\fR<cmt> +\fB\-uacomment=\fR<cmt> .IP Append comment to the user agent string .PP Chain selection options: .HP -\fBchain=\fR<chain> +\fB\-chain=\fR<chain> .IP Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest .HP -\fBsignet\fR +\fB\-signet\fR .IP -Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fBsignetchallenge\fR parameter +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 -\fBsignetchallenge\fR +\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 -\fBsignetseednode\fR +\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 -\fBtestnet\fR +\fB\-testnet\fR .IP -Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Node relay options: .HP -\fBbytespersigop\fR +\fB\-bytespersigop\fR .IP Equivalent bytes per sigop in transactions for relay and mining (default: 20) .HP -\fBdatacarrier\fR +\fB\-datacarrier\fR .IP Relay and mine data carrier transactions (default: 1) .HP -\fBdatacarriersize\fR +\fB\-datacarriersize\fR .IP Maximum size of data in data carrier transactions we relay and mine (default: 83) .HP -\fBminrelaytxfee=\fR<amt> +\fB\-minrelaytxfee=\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 +\fB\-whitelistforcerelay\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 +\fB\-whitelistrelay\fR .IP Add 'relay' permission to whitelisted inbound peers with default permissions. This will accept relayed transactions even when not @@ -669,112 +669,112 @@ relaying transactions (default: 1) .PP Block creation options: .HP -\fBblockmaxweight=\fR<n> +\fB\-blockmaxweight=\fR<n> .IP Set maximum BIP141 block weight (default: 3996000) .HP -\fBblockmintxfee=\fR<amt> +\fB\-blockmintxfee=\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 +\fB\-rest\fR .IP Accept public REST requests (default: 0) .HP -\fBrpcallowip=\fR<ip> +\fB\-rpcallowip=\fR<ip> .IP -Allow JSONRPC connections from specified source. Valid for <ip> are a +Allow JSON\-RPC 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> +\fB\-rpcauth=\fR<userpw> .IP -Username and HMACSHA256 hashed password for JSONRPC connections. The +Username and HMAC\-SHA\-256 hashed password for JSON\-RPC 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] +\fB\-rpcbind=\fR<addr>[:port] .IP -Bind to given address to listen for JSONRPC connections. Do not expose +Bind to given address to listen for JSON\-RPC 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 +This option is ignored unless \fB\-rpcallowip\fR is also passed. Port is +optional and overrides \fB\-rpcport\fR. Use [host]:port notation for IPv6. This option can be specified multiple times (default: 127.0.0.1 and ::1 i.e., localhost) .HP -\fBrpccookiefile=\fR<loc> +\fB\-rpccookiefile=\fR<loc> .IP Location of the auth cookie. Relative paths will be prefixed by a -netspecific datadir location. (default: data dir) +net\-specific datadir location. (default: data dir) .HP -\fBrpcpassword=\fR<pw> +\fB\-rpcpassword=\fR<pw> .IP -Password for JSONRPC connections +Password for JSON\-RPC connections .HP -\fBrpcport=\fR<port> +\fB\-rpcport=\fR<port> .IP -Listen for JSONRPC connections on <port> (default: 8332, testnet: +Listen for JSON\-RPC connections on <port> (default: 8332, testnet: 18332, signet: 38332, regtest: 18443) .HP -\fBrpcserialversion\fR +\fB\-rpcserialversion\fR .IP Sets the serialization of raw transaction or block hex returned in -nonverbose mode, nonsegwit(0) or segwit(1) (default: 1) +non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1) .HP -\fBrpcthreads=\fR<n> +\fB\-rpcthreads=\fR<n> .IP Set the number of threads to service RPC calls (default: 4) .HP -\fBrpcuser=\fR<user> +\fB\-rpcuser=\fR<user> .IP -Username for JSONRPC connections +Username for JSON\-RPC connections .HP -\fBrpcwhitelist=\fR<whitelist> +\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 setintersected. See \fBrpcwhitelistdefault\fR documentation +they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation for information on default whitelist behavior. .HP -\fBrpcwhitelistdefault\fR +\fB\-rpcwhitelistdefault\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 +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 -\fBrpcwhitelist\fR is set, rpc server acts as if all rpc users are +\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are subject to empty whitelists. .HP -\fBserver\fR +\fB\-server\fR .IP -Accept command line and JSONRPC commands +Accept command line and JSON\-RPC commands .PP UI Options: .HP -\fBchoosedatadir\fR +\fB\-choosedatadir\fR .IP Choose data directory on startup (default: 0) .HP -\fBlang=\fR<lang> +\fB\-lang=\fR<lang> .IP Set language, for example "de_DE" (default: system locale) .HP -\fBmin\fR +\fB\-min\fR .IP Start minimized .HP -\fBresetguisettings\fR +\fB\-resetguisettings\fR .IP Reset all settings changed in the GUI .HP -\fBsplash\fR +\fB\-splash\fR .IP Show splash screen on startup (default: 1) diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 index b088f98893..3ce95963e5 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.13. -.TH BITCOIN-TX "1" "August 2021" "bitcoin-tx v22.0rc2" "User Commands" +.TH BITCOIN-TX "1" "August 2021" "bitcoin-tx v22.0.0rc3" "User Commands" .SH NAME -bitcoin-tx manual page for bitcoin-tx v22.0rc2 +bitcoin-tx \- manual page for bitcoin-tx v22.0.0rc3 .SH SYNOPSIS .B bitcoin-tx [\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR @@ -9,26 +9,26 @@ bitcoin-tx manual page for bitcoin-tx v22.0rc2 .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 +Bitcoin Core bitcoin\-tx utility version v22.0.0rc3 .SH OPTIONS .HP -? +\-? .IP Print this help message and exit .HP -\fBcreate\fR +\fB\-create\fR .IP Create new, empty TX. .HP -\fBjson\fR +\fB\-json\fR .IP Select JSON output .HP -\fBtxid\fR +\fB\-txid\fR .IP -Output only the hexencoded transaction id of the resultant transaction. +Output only the hex\-encoded transaction id of the resultant transaction. .HP -\fBversion\fR +\fB\-version\fR .IP Print version and exit .PP @@ -36,32 +36,32 @@ Debugging/Testing options: .PP Chain selection options: .HP -\fBchain=\fR<chain> +\fB\-chain=\fR<chain> .IP Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest .HP -\fBsignet\fR +\fB\-signet\fR .IP -Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fBsignetchallenge\fR parameter +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 -\fBsignetchallenge\fR +\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 -\fBsignetseednode\fR +\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 -\fBtestnet\fR +\fB\-testnet\fR .IP -Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Commands: .IP @@ -87,37 +87,37 @@ Set TX version to N .IP outaddr=VALUE:ADDRESS .IP -Add addressbased output to TX +Add address\-based output to TX .IP outdata=[VALUE:]DATA .IP -Add databased output to TX +Add data\-based output to TX .IP outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS] .IP -Add Pay To nofm Multisig output to TX. n = REQUIRED, m = PUBKEYS. +Add Pay To n\-of\-m Multi\-sig 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. +pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to +wrap the output in a pay\-to\-script\-hash. .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. +Add pay\-to\-pubkey output to TX. Optionally add the "W" flag to produce a +pay\-to\-witness\-pubkey\-hash output. Optionally add the "S" flag to +wrap the output in a pay\-to\-script\-hash. .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. +pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to +wrap the output in a pay\-to\-script\-hash. .IP replaceable(=N) .IP -Set RBF optin sequence number for input N (if not provided, optin all +Set RBF opt\-in sequence number for input N (if not provided, opt\-in all available inputs) .IP -sign=SIGHASHFLAGS +sign=SIGHASH\-FLAGS .IP Add zero or more signatures to transaction. This command requires JSON registers:prevtxs=JSON object, privatekeys=JSON object. See @@ -130,6 +130,6 @@ load=NAME:FILENAME .IP Load JSON file FILENAME into register NAME .IP -set=NAME:JSONSTRING +set=NAME:JSON\-STRING .IP -Set register NAME to given JSONSTRING +Set register NAME to given JSON\-STRING diff --git a/doc/man/bitcoin-util.1 b/doc/man/bitcoin-util.1 index 35a3ff05b8..6daf85e8e8 100644 --- a/doc/man/bitcoin-util.1 +++ b/doc/man/bitcoin-util.1 @@ -1,19 +1,19 @@ .\" 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" +.TH BITCOIN-UTIL "1" "August 2021" "bitcoin-util v22.0.0rc3" "User Commands" .SH NAME -bitcoin-util manual page for bitcoin-util v22.0rc2 +bitcoin-util \- manual page for bitcoin-util v22.0.0rc3 .SH SYNOPSIS .B bitcoin-util [\fI\,options\/\fR] [\fI\,commands\/\fR] \fI\,Do stuff\/\fR .SH DESCRIPTION -Bitcoin Core bitcoinutil utility version v22.0rc2 +Bitcoin Core bitcoin\-util utility version v22.0.0rc3 .SH OPTIONS .HP -? +\-? .IP Print this help message and exit .HP -\fBversion\fR +\fB\-version\fR .IP Print version and exit .PP @@ -21,32 +21,32 @@ Debugging/Testing options: .PP Chain selection options: .HP -\fBchain=\fR<chain> +\fB\-chain=\fR<chain> .IP Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest .HP -\fBsignet\fR +\fB\-signet\fR .IP -Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fBsignetchallenge\fR parameter +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 -\fBsignetchallenge\fR +\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 -\fBsignetseednode\fR +\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 -\fBtestnet\fR +\fB\-testnet\fR .IP -Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Commands: .IP diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1 index 1a01718c20..73dd985f5e 100644 --- a/doc/man/bitcoin-wallet.1 +++ b/doc/man/bitcoin-wallet.1 @@ -1,87 +1,87 @@ .\" 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" +.TH BITCOIN-WALLET "1" "August 2021" "bitcoin-wallet v22.0.0rc3" "User Commands" .SH NAME -bitcoin-wallet manual page for bitcoin-wallet v22.0rc2 +bitcoin-wallet \- manual page for bitcoin-wallet v22.0.0rc3 .SH DESCRIPTION -Bitcoin Core bitcoinwallet version v22.0rc2 +Bitcoin Core bitcoin\-wallet version v22.0.0rc3 .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. +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 -bitcoinwallet [options] <command> +bitcoin\-wallet [options] <command> .SH OPTIONS .HP -? +\-? .IP Print this help message and exit .HP -\fBdatadir=\fR<dir> +\fB\-datadir=\fR<dir> .IP Specify data directory .HP -\fBdescriptors\fR +\fB\-descriptors\fR .IP Create descriptors wallet. Only for 'create' .HP -\fBdumpfile=\fR<file name> +\fB\-dumpfile=\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> +\fB\-format=\fR<format> .IP The format of the wallet file to create. Either "bdb" or "sqlite". Only used with 'createfromdump' .HP -\fBversion\fR +\fB\-version\fR .IP Print version and exit .HP -\fBwallet=\fR<walletname> +\fB\-wallet=\fR<wallet\-name> .IP Specify wallet name .PP Debugging/Testing options: .HP -\fBdebug=\fR<category> +\fB\-debug=\fR<category> .IP Output debugging information (default: 0). .HP -\fBprinttoconsole\fR +\fB\-printtoconsole\fR .IP -Send trace/debug info to console (default: 1 when no \fBdebug\fR is true, 0 +Send trace/debug info to console (default: 1 when no \fB\-debug\fR is true, 0 otherwise). .PP Chain selection options: .HP -\fBchain=\fR<chain> +\fB\-chain=\fR<chain> .IP Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest .HP -\fBsignet\fR +\fB\-signet\fR .IP -Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fBsignetchallenge\fR parameter +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 -\fBsignetchallenge\fR +\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 -\fBsignetseednode\fR +\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 -\fBtestnet\fR +\fB\-testnet\fR .IP -Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Commands: .IP @@ -95,7 +95,7 @@ Create new wallet file from dumped records .IP dump .IP -Print out all of the wallet keyvalue records +Print out all of the wallet key\-value records .IP info .IP diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index 2ab6c2a339..ab466437e3 100644 --- a/doc/man/bitcoind.1 +++ b/doc/man/bitcoind.1 @@ -1,13 +1,13 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. -.TH BITCOIND "1" "August 2021" "bitcoind v22.0rc2" "User Commands" +.TH BITCOIND "1" "August 2021" "bitcoind v22.0.0rc3" "User Commands" .SH NAME -bitcoind manual page for bitcoind v22.0rc2 +bitcoind \- manual page for bitcoind v22.0.0rc3 .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 +Bitcoin Core version v22.0.0rc3 +Copyright \(co 2009\-2021 The Bitcoin Core developers .PP Please contribute if you find Bitcoin Core useful. Visit <https://bitcoincore.org/> for further information about the software. @@ -18,16 +18,16 @@ 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> +\fB\-alertnotify=\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> +\fB\-assumevalid=\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, @@ -38,174 +38,174 @@ testnet: signet: 000000187d4440e5bff91488b700a140441e089a8aaea707414982460edbfe54) .HP -\fBblockfilterindex=\fR<type> +\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 -\fBblocknotify=\fR<cmd> +\fB\-blocknotify=\fR<cmd> .IP Execute command when the best block changes (%s in cmd is replaced by block hash) .HP -\fBblockreconstructionextratxn=\fR<n> +\fB\-blockreconstructionextratxn=\fR<n> .IP Extra transactions to keep in memory for compact block reconstructions (default: 100) .HP -\fBblocksdir=\fR<dir> +\fB\-blocksdir=\fR<dir> .IP Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>) .HP -\fBblocksonly\fR +\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 -\fBcoinstatsindex\fR +\fB\-coinstatsindex\fR .IP Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) .HP -\fBconf=\fR<file> +\fB\-conf=\fR<file> .IP -Specify path to readonly configuration file. Relative paths will be +Specify path to read\-only configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf) .HP -\fBdaemon\fR +\fB\-daemon\fR .IP Run in the background as a daemon and accept commands (default: 0) .HP -\fBdaemonwait\fR +\fB\-daemonwait\fR .IP Wait for initialization to be finished before exiting. This implies -\fBdaemon\fR (default: 0) +\fB\-daemon\fR (default: 0) .HP -\fBdatadir=\fR<dir> +\fB\-datadir=\fR<dir> .IP Specify data directory .HP -\fBdbcache=\fR<n> +\fB\-dbcache=\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). +\fB\-maxmempool\fR). .HP -\fBdebuglogfile=\fR<file> +\fB\-debuglogfile=\fR<file> .IP Specify location of debug log file. Relative paths will be prefixed by a -netspecific datadir location. (\fBnodebuglogfile\fR to disable; +net\-specific datadir location. (\fB\-nodebuglogfile\fR to disable; default: debug.log) .HP -\fBincludeconf=\fR<file> +\fB\-includeconf=\fR<file> .IP -Specify additional configuration file, relative to the \fBdatadir\fR path +Specify additional configuration file, relative to the \fB\-datadir\fR path (only useable from configuration file, not command line) .HP -\fBloadblock=\fR<file> +\fB\-loadblock=\fR<file> .IP Imports blocks from external file on startup .HP -\fBmaxmempool=\fR<n> +\fB\-maxmempool=\fR<n> .IP Keep the transaction memory pool below <n> megabytes (default: 300) .HP -\fBmaxorphantx=\fR<n> +\fB\-maxorphantx=\fR<n> .IP Keep at most <n> unconnectable transactions in memory (default: 100) .HP -\fBmempoolexpiry=\fR<n> +\fB\-mempoolexpiry=\fR<n> .IP Do not keep transactions in the mempool longer than <n> hours (default: 336) .HP -\fBpar=\fR<n> +\fB\-par=\fR<n> .IP -Set the number of script verification threads (\fB6\fR to 15, 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 -\fBpersistmempool\fR +\fB\-persistmempool\fR .IP Whether to save the mempool on shutdown and load on restart (default: 1) .HP -\fBpid=\fR<file> +\fB\-pid=\fR<file> .IP -Specify pid file. Relative paths will be prefixed by a netspecific +Specify pid file. Relative paths will be prefixed by a net\-specific datadir location. (default: bitcoind.pid) .HP -\fBprune=\fR<n> +\fB\-prune=\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 +incompatible with \fB\-txindex\fR, \fB\-coinstatsindex\fR and \fB\-rescan\fR. Warning: +Reverting this setting requires re\-downloading 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 +\fB\-reindex\fR .IP Rebuild chain state and block index from the blk*.dat files on disk .HP -\fBreindexchainstate\fR +\fB\-reindex\-chainstate\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 +mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR instead. .HP -\fBsettings=\fR<file> +\fB\-settings=\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 +\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 -\fBstartupnotify=\fR<cmd> +\fB\-startupnotify=\fR<cmd> .IP Execute command on startup. .HP -\fBsysperms\fR +\fB\-sysperms\fR .IP Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality) .HP -\fBtxindex\fR +\fB\-txindex\fR .IP Maintain a full transaction index, used by the getrawtransaction rpc call (default: 0) .HP -\fBversion\fR +\fB\-version\fR .IP Print version and exit .PP Connection options: .HP -\fBaddnode=\fR<ip> +\fB\-addnode=\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 +8 at a time and are counted separately from the \fB\-maxconnections\fR limit. .HP -\fBasmap=\fR<file> +\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 netspecific +ip_asn.map). Relative paths will be prefixed by the net\-specific datadir location. .HP -\fBbantime=\fR<n> +\fB\-bantime=\fR<n> .IP Default duration (in seconds) of manually configured bans (default: 86400) .HP -\fBbind=\fR<addr>[:<port>][=onion] +\fB\-bind=\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 @@ -213,219 +213,219 @@ 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> +\fB\-connect=\fR<ip> .IP -Connect only to the specified node; \fBnoconnect\fR disables automatic +Connect only to the specified node; \fB\-noconnect\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 +\fB\-addnode\fR). This option can be specified multiple times to connect to multiple nodes. .HP -\fBdiscover\fR +\fB\-discover\fR .IP -Discover own IP addresses (default: 1 when listening and no \fBexternalip\fR -or \fBproxy\fR) +Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR +or \fB\-proxy\fR) .HP -\fBdns\fR +\fB\-dns\fR .IP -Allow DNS lookups for \fBaddnode\fR, \fBseednode\fR and \fBconnect\fR (default: 1) +Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1) .HP -\fBdnsseed\fR +\fB\-dnsseed\fR .IP Query for peer addresses via DNS lookup, if low on addresses (default: 1 -unless \fBconnect\fR used) +unless \fB\-connect\fR used) .HP -\fBexternalip=\fR<ip> +\fB\-externalip=\fR<ip> .IP Specify your own public address .HP -\fBfixedseeds\fR +\fB\-fixedseeds\fR .IP Allow fixed seeds if DNS seeds don't provide peers (default: 1) .HP -\fBforcednsseed\fR +\fB\-forcednsseed\fR .IP Always query for peer addresses via DNS lookup (default: 0) .HP -\fBi2pacceptincoming\fR +\fB\-i2pacceptincoming\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 +If set and \fB\-i2psam\fR is also set then incoming I2P connections are +accepted via the SAM proxy. If this is not set but \fB\-i2psam\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 +Ignored if \fB\-i2psam\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> +\fB\-i2psam=\fR<ip:port> .IP I2P SAM proxy to reach I2P peers and accept I2P connections (default: none) .HP -\fBlisten\fR +\fB\-listen\fR .IP -Accept connections from outside (default: 1 if no \fBproxy\fR or \fBconnect\fR) +Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR) .HP -\fBlistenonion\fR +\fB\-listenonion\fR .IP Automatically create Tor onion service (default: 1) .HP -\fBmaxconnections=\fR<n> +\fB\-maxconnections=\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 +does not apply to connections manually added via \fB\-addnode\fR or the addnode RPC, which have a separate limit of 8. .HP -\fBmaxreceivebuffer=\fR<n> +\fB\-maxreceivebuffer=\fR<n> .IP -Maximum perconnection receive buffer, <n>*1000 bytes (default: 5000) +Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000) .HP -\fBmaxsendbuffer=\fR<n> +\fB\-maxsendbuffer=\fR<n> .IP -Maximum perconnection send buffer, <n>*1000 bytes (default: 1000) +Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000) .HP -\fBmaxtimeadjustment\fR +\fB\-maxtimeadjustment\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> +\fB\-maxuploadtarget=\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 +\fB\-natpmp\fR .IP -Use NATPMP to map the listening port (default: 0) +Use NAT\-PMP to map the listening port (default: 0) .HP -\fBnetworkactive\fR +\fB\-networkactive\fR .IP Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command .HP -\fBonion=\fR<ip:port> +\fB\-onion=\fR<ip:port> .IP Use separate SOCKS5 proxy to reach peers via Tor onion services, set -\fBnoonion\fR to disable (default: \fBproxy\fR) +\fB\-noonion\fR to disable (default: \fB\-proxy\fR) .HP -\fBonlynet=\fR<net> +\fB\-onlynet=\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 +networks. Warning: if it is used with non\-onion networks and the +\fB\-onion\fR or \fB\-proxy\fR option is set, then outbound onion connections +will still be made; use \fB\-noonion\fR or \fB\-onion\fR=\fI\,0\/\fR to disable outbound onion connections in this case. .HP -\fBpeerblockfilters\fR +\fB\-peerblockfilters\fR .IP Serve compact block filters to peers per BIP 157 (default: 0) .HP -\fBpeerbloomfilters\fR +\fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: 0) .HP -\fBpermitbaremultisig\fR +\fB\-permitbaremultisig\fR .IP -Relay nonP2SH multisig (default: 1) +Relay non\-P2SH multisig (default: 1) .HP -\fBport=\fR<port> +\fB\-port=\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> +\fB\-proxy=\fR<ip:port> .IP -Connect through SOCKS5 proxy, set \fBnoproxy\fR to disable (default: +Connect through SOCKS5 proxy, set \fB\-noproxy\fR to disable (default: disabled) .HP -\fBproxyrandomize\fR +\fB\-proxyrandomize\fR .IP Randomize credentials for every proxy connection. This enables Tor stream isolation (default: 1) .HP -\fBseednode=\fR<ip> +\fB\-seednode=\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> +\fB\-timeout=\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> +\fB\-torcontrol=\fR<ip>:<port> .IP Tor control port to use if onion listening enabled (default: 127.0.0.1:9051) .HP -\fBtorpassword=\fR<pass> +\fB\-torpassword=\fR<pass> .IP Tor control port password (default: empty) .HP -\fBupnp\fR +\fB\-upnp\fR .IP Use UPnP to map the listening port (default: 0) .HP -\fBwhitebind=\fR<[permissions@]addr> +\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 \fBblocksonly\fR mode, +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 uptodate info). Specify multiple +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 -\fBwhitelist=\fR<[permissions@]IP address or network> +\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 CIDRnotated network (e.g. 1.2.3.0/24). Uses -the same permissions as \fBwhitebind\fR. Can be specified multiple +(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 -\fBaddresstype\fR +\fB\-addresstype\fR .IP -What type of addresses to use ("legacy", "p2shsegwit", or "bech32", +What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", default: "bech32") .HP -\fBavoidpartialspends\fR +\fB\-avoidpartialspends\fR .IP Group outputs by address, selecting many (possibly all) or none, instead -of selecting on a peroutput basis. Privacy is improved as +of selecting on a per\-output 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 +limitation and possibly a larger\-than\-necessary number of inputs being used. Always enabled for wallets with "avoid_reuse" enabled, otherwise default: 0. .HP -\fBchangetype\fR +\fB\-changetype\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 +What type of change to use ("legacy", "p2sh\-segwit", or "bech32"). +Default is same as \fB\-addresstype\fR, except when +\fB\-addresstype\fR=\fI\,p2sh\-segwit\/\fR a native segwit output is used when sending to a native segwit address) .HP -\fBdisablewallet\fR +\fB\-disablewallet\fR .IP Do not load the wallet and disable wallet RPC calls .HP -\fBdiscardfee=\fR<amt> +\fB\-discardfee=\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 @@ -433,133 +433,133 @@ 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> +\fB\-fallbackfee=\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> +\fB\-keypool=\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> +\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 -\fBmintxfee=\fR<amt> +\fB\-mintxfee=\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> +\fB\-paytxfee=\fR<amt> .IP Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00) .HP -\fBrescan\fR +\fB\-rescan\fR .IP Rescan the block chain for missing wallet transactions on startup .HP -\fBsigner=\fR<cmd> +\fB\-signer=\fR<cmd> .IP -External signing tool, see doc/externalsigner.md +External signing tool, see doc/external\-signer.md .HP -\fBspendzeroconfchange\fR +\fB\-spendzeroconfchange\fR .IP Spend unconfirmed change when sending transactions (default: 1) .HP -\fBtxconfirmtarget=\fR<n> +\fB\-txconfirmtarget=\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> +\fB\-wallet=\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 +this also accepts names of existing top\-level data files in <walletdir>. .HP -\fBwalletbroadcast\fR +\fB\-walletbroadcast\fR .IP Make the wallet broadcast transactions (default: 1) .HP -\fBwalletdir=\fR<dir> +\fB\-walletdir=\fR<dir> .IP Specify directory to hold wallets (default: <datadir>/wallets if it exists, otherwise <datadir>) .HP -\fBwalletnotify=\fR<cmd> +\fB\-walletnotify=\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 +block height (\fB\-1\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 +\fB\-walletrbf\fR .IP -Send transactions with fullRBF optin enabled (RPC only, default: 0) +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) .PP ZeroMQ notification options: .HP -\fBzmqpubhashblock=\fR<address> +\fB\-zmqpubhashblock=\fR<address> .IP Enable publish hash block in <address> .HP -\fBzmqpubhashblockhwm=\fR<n> +\fB\-zmqpubhashblockhwm=\fR<n> .IP Set publish hash block outbound message high water mark (default: 1000) .HP -\fBzmqpubhashtx=\fR<address> +\fB\-zmqpubhashtx=\fR<address> .IP Enable publish hash transaction in <address> .HP -\fBzmqpubhashtxhwm=\fR<n> +\fB\-zmqpubhashtxhwm=\fR<n> .IP Set publish hash transaction outbound message high water mark (default: 1000) .HP -\fBzmqpubrawblock=\fR<address> +\fB\-zmqpubrawblock=\fR<address> .IP Enable publish raw block in <address> .HP -\fBzmqpubrawblockhwm=\fR<n> +\fB\-zmqpubrawblockhwm=\fR<n> .IP Set publish raw block outbound message high water mark (default: 1000) .HP -\fBzmqpubrawtx=\fR<address> +\fB\-zmqpubrawtx=\fR<address> .IP Enable publish raw transaction in <address> .HP -\fBzmqpubrawtxhwm=\fR<n> +\fB\-zmqpubrawtxhwm=\fR<n> .IP Set publish raw transaction outbound message high water mark (default: 1000) .HP -\fBzmqpubsequence=\fR<address> +\fB\-zmqpubsequence=\fR<address> .IP Enable publish hash block and tx sequence in <address> .HP -\fBzmqpubsequencehwm=\fR<n> +\fB\-zmqpubsequencehwm=\fR<n> .IP Set publish hash sequence message high water mark (default: 1000) .PP Debugging/Testing options: .HP -\fBdebug=\fR<category> +\fB\-debug=\fR<category> .IP -Output debugging information (default: \fBnodebug\fR, supplying <category> is +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, walletdb, rpc, estimatefee, addrman, @@ -567,110 +567,110 @@ 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> +\fB\-debugexclude=\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 +with \fB\-debug\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 +\fB\-help\-debug\fR .IP Print help message with debugging options and exit .HP -\fBlogips\fR +\fB\-logips\fR .IP Include IP addresses in debug output (default: 0) .HP -\fBlogsourcelocations\fR +\fB\-logsourcelocations\fR .IP Prepend debug output with name of the originating source location (source file, line number and function name) (default: 0) .HP -\fBlogthreadnames\fR +\fB\-logthreadnames\fR .IP Prepend debug output with name of the originating thread (only available on platforms supporting thread_local) (default: 0) .HP -\fBlogtimestamps\fR +\fB\-logtimestamps\fR .IP Prepend debug output with timestamp (default: 1) .HP -\fBmaxtxfee=\fR<amt> +\fB\-maxtxfee=\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 +\fB\-printtoconsole\fR .IP -Send trace/debug info to console (default: 1 when no \fBdaemon\fR. To disable -logging to file, set \fBnodebuglogfile\fR) +Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable +logging to file, set \fB\-nodebuglogfile\fR) .HP -\fBshrinkdebugfile\fR +\fB\-shrinkdebugfile\fR .IP -Shrink debug.log file on client startup (default: 1 when no \fBdebug\fR) +Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) .HP -\fBuacomment=\fR<cmt> +\fB\-uacomment=\fR<cmt> .IP Append comment to the user agent string .PP Chain selection options: .HP -\fBchain=\fR<chain> +\fB\-chain=\fR<chain> .IP Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest .HP -\fBsignet\fR +\fB\-signet\fR .IP -Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fBsignetchallenge\fR parameter +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 -\fBsignetchallenge\fR +\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 -\fBsignetseednode\fR +\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 -\fBtestnet\fR +\fB\-testnet\fR .IP -Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR. +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Node relay options: .HP -\fBbytespersigop\fR +\fB\-bytespersigop\fR .IP Equivalent bytes per sigop in transactions for relay and mining (default: 20) .HP -\fBdatacarrier\fR +\fB\-datacarrier\fR .IP Relay and mine data carrier transactions (default: 1) .HP -\fBdatacarriersize\fR +\fB\-datacarriersize\fR .IP Maximum size of data in data carrier transactions we relay and mine (default: 83) .HP -\fBminrelaytxfee=\fR<amt> +\fB\-minrelaytxfee=\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 +\fB\-whitelistforcerelay\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 +\fB\-whitelistrelay\fR .IP Add 'relay' permission to whitelisted inbound peers with default permissions. This will accept relayed transactions even when not @@ -678,90 +678,90 @@ relaying transactions (default: 1) .PP Block creation options: .HP -\fBblockmaxweight=\fR<n> +\fB\-blockmaxweight=\fR<n> .IP Set maximum BIP141 block weight (default: 3996000) .HP -\fBblockmintxfee=\fR<amt> +\fB\-blockmintxfee=\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 +\fB\-rest\fR .IP Accept public REST requests (default: 0) .HP -\fBrpcallowip=\fR<ip> +\fB\-rpcallowip=\fR<ip> .IP -Allow JSONRPC connections from specified source. Valid for <ip> are a +Allow JSON\-RPC 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> +\fB\-rpcauth=\fR<userpw> .IP -Username and HMACSHA256 hashed password for JSONRPC connections. The +Username and HMAC\-SHA\-256 hashed password for JSON\-RPC 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] +\fB\-rpcbind=\fR<addr>[:port] .IP -Bind to given address to listen for JSONRPC connections. Do not expose +Bind to given address to listen for JSON\-RPC 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 +This option is ignored unless \fB\-rpcallowip\fR is also passed. Port is +optional and overrides \fB\-rpcport\fR. Use [host]:port notation for IPv6. This option can be specified multiple times (default: 127.0.0.1 and ::1 i.e., localhost) .HP -\fBrpccookiefile=\fR<loc> +\fB\-rpccookiefile=\fR<loc> .IP Location of the auth cookie. Relative paths will be prefixed by a -netspecific datadir location. (default: data dir) +net\-specific datadir location. (default: data dir) .HP -\fBrpcpassword=\fR<pw> +\fB\-rpcpassword=\fR<pw> .IP -Password for JSONRPC connections +Password for JSON\-RPC connections .HP -\fBrpcport=\fR<port> +\fB\-rpcport=\fR<port> .IP -Listen for JSONRPC connections on <port> (default: 8332, testnet: +Listen for JSON\-RPC connections on <port> (default: 8332, testnet: 18332, signet: 38332, regtest: 18443) .HP -\fBrpcserialversion\fR +\fB\-rpcserialversion\fR .IP Sets the serialization of raw transaction or block hex returned in -nonverbose mode, nonsegwit(0) or segwit(1) (default: 1) +non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1) .HP -\fBrpcthreads=\fR<n> +\fB\-rpcthreads=\fR<n> .IP Set the number of threads to service RPC calls (default: 4) .HP -\fBrpcuser=\fR<user> +\fB\-rpcuser=\fR<user> .IP -Username for JSONRPC connections +Username for JSON\-RPC connections .HP -\fBrpcwhitelist=\fR<whitelist> +\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 setintersected. See \fBrpcwhitelistdefault\fR documentation +they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation for information on default whitelist behavior. .HP -\fBrpcwhitelistdefault\fR +\fB\-rpcwhitelistdefault\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 +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 -\fBrpcwhitelist\fR is set, rpc server acts as if all rpc users are +\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are subject to empty whitelists. .HP -\fBserver\fR +\fB\-server\fR .IP -Accept command line and JSONRPC commands +Accept command line and JSON\-RPC commands |