diff --git a/CMakeLists.txt b/CMakeLists.txt index a1a9be3f5d..398cba7f97 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -29,10 +29,10 @@ get_directory_property(precious_variables CACHE_VARIABLES) set(CLIENT_NAME "Elements Core") set(CLIENT_VERSION_MAJOR 29) set(CLIENT_VERSION_MINOR 4) -set(CLIENT_VERSION_BUILD 0) +set(CLIENT_VERSION_BUILD 1) set(CLIENT_VERSION_RC 1) set(CLIENT_VERSION_IS_RELEASE "true") -set(COPYRIGHT_YEAR "2025") +set(COPYRIGHT_YEAR "2026") # During the enabling of the CXX and CXXOBJ languages, we modify # CMake's compiler/linker invocation strings by appending the content @@ -63,7 +63,8 @@ if(CLIENT_VERSION_RC GREATER 0) endif() set(COPYRIGHT_HOLDERS "The %s developers") -set(COPYRIGHT_HOLDERS_FINAL "The Elements Project developers") +set(COPYRIGHT_HOLDERS_SUBSTITUTION "Elements Project") +string(REPLACE "%s" "${COPYRIGHT_HOLDERS_SUBSTITUTION}" COPYRIGHT_HOLDERS_FINAL "${COPYRIGHT_HOLDERS}") set(CLIENT_BUGREPORT "https://github.com/ElementsProject/elements/issues") #============================= diff --git a/cmake/bitcoin-build-config.h.in b/cmake/bitcoin-build-config.h.in index 78470b0368..3e0f964e17 100644 --- a/cmake/bitcoin-build-config.h.in +++ b/cmake/bitcoin-build-config.h.in @@ -24,7 +24,7 @@ #define COPYRIGHT_HOLDERS_FINAL "@COPYRIGHT_HOLDERS_FINAL@" /* Replacement for %s in copyright holders string */ -#define COPYRIGHT_HOLDERS_SUBSTITUTION "@CLIENT_NAME@" +#define COPYRIGHT_HOLDERS_SUBSTITUTION "@COPYRIGHT_HOLDERS_SUBSTITUTION@" /* Copyright year */ #define COPYRIGHT_YEAR @COPYRIGHT_YEAR@ diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 deleted file mode 100644 index 33f28d1ac0..0000000000 --- a/doc/man/bitcoin-cli.1 +++ /dev/null @@ -1,201 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-CLI "1" "June 2026" "bitcoin-cli v29.4.0rc1" "User Commands" -.SH NAME -bitcoin-cli \- manual page for bitcoin-cli v29.4.0rc1 -.SH SYNOPSIS -.B bitcoin-cli -[\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] -.br -.B bitcoin-cli -[\fI\,options\/\fR] \fI\,-named \/\fR[\fI\,name=value\/\fR]... -.br -.B bitcoin-cli -[\fI\,options\/\fR] \fI\,help\/\fR -.br -.B bitcoin-cli -[\fI\,options\/\fR] \fI\,help \/\fR -.SH DESCRIPTION -Bitcoin Core RPC client version v29.4.0rc1 -.PP -The bitcoin\-cli utility provides a command line interface to interact with a Bitcoin Core RPC server. -.PP -It can be used to query network information, manage wallets, create or broadcast transactions, and control the Bitcoin Core server. -.PP -Use the "help" command to list all commands. Use "help " to show help for that command. -The \fB\-named\fR option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters. -.SH OPTIONS -.HP -\fB\-color=\fR -.IP -Color setting for CLI output (default: auto). Valid values: always, auto -(add color codes when standard output is connected to a terminal -and OS is not WIN32), never. Only applies to the output of -\fB\-getinfo\fR. -.HP -\fB\-conf=\fR -.IP -Specify configuration file. Relative paths will be prefixed by datadir -location. (default: bitcoin.conf) -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-help\fR -.IP -Print this help message and exit (also \fB\-h\fR or \-?) -.HP -\fB\-named\fR -.IP -Pass named instead of positional arguments (default: false) -.HP -\fB\-rpcclienttimeout=\fR -.IP -Timeout in seconds during HTTP requests, or 0 for no timeout. (default: -900) -.HP -\fB\-rpcconnect=\fR -.IP -Send commands to node running on (default: 127.0.0.1) -.HP -\fB\-rpccookiefile=\fR -.IP -Location of the auth cookie. Relative paths will be prefixed by a -net\-specific datadir location. (default: data dir) -.HP -\fB\-rpcpassword=\fR -.IP -Password for JSON\-RPC connections -.HP -\fB\-rpcport=\fR -.IP -Connect to JSON\-RPC on (default: 8332, testnet: 18332, testnet4: -48332, signet: 38332, regtest: 18443) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections -.HP -\fB\-rpcwait\fR -.IP -Wait for RPC server to start -.HP -\fB\-rpcwaittimeout=\fR -.IP -Timeout in seconds to wait for the RPC server to start, or 0 for no -timeout. (default: 0) -.HP -\fB\-rpcwallet=\fR -.IP -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/ -.HP -\fB\-stdin\fR -.IP -Read extra arguments from standard input, one per line until EOF/Ctrl\-D -(recommended for sensitive information such as passphrases). When -combined with \fB\-stdinrpcpass\fR, the first line from standard input -is used for the RPC password. -.HP -\fB\-stdinrpcpass\fR -.IP -Read RPC password from standard input as a single line. When combined -with \fB\-stdin\fR, the first line from standard input is used for the -RPC password. When combined with \fB\-stdinwalletpassphrase\fR, -\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR -consumes the second. -.HP -\fB\-stdinwalletpassphrase\fR -.IP -Read wallet passphrase from standard input as a single line. When -combined with \fB\-stdin\fR, the first line from standard input is used -for the wallet passphrase. -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Debugging/Testing options: -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -testnet4, signet, regtest -.HP -\fB\-signet\fR -.IP -Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fB\-signetchallenge\fR parameter -.HP -\fB\-signetchallenge\fR -.IP -Blocks must satisfy the given script to be considered valid (only for -signet networks; defaults to the global default signet test -network challenge) -.HP -\fB\-signetseednode\fR -.IP -Specify a seed node for the signet network, in the hostname[:port] -format, e.g. sig.net:1234 (may be used multiple times to specify -multiple seed nodes; defaults to the global default signet test -network seed node(s)) -.HP -\fB\-testnet\fR -.IP -Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 -is deprecated and will be removed in an upcoming release. -Consider moving to testnet4 now by using \fB\-testnet4\fR. -.HP -\fB\-testnet4\fR -.IP -Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR. -.PP -CLI Commands: -.HP -\fB\-addrinfo\fR -.IP -Get the number of addresses known to the node, per network and total, -after filtering for quality and recency. The total number of -addresses known to the node may be higher. -.HP -\fB\-generate\fR -.IP -Generate blocks, 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: bitcoin\-cli \fB\-generate\fR 4 -1000 -.HP -\fB\-getinfo\fR -.IP -Get general information from the remote server. Note that unlike -server\-side RPC calls, the output of \fB\-getinfo\fR is the result of -multiple non\-atomic requests. Some entries in the output may -represent results from different states (e.g. wallet balance may -be as of a different block from the chain state reported) -.HP -\fB\-netinfo\fR -.IP -Get network peer connection information from the remote server. An -optional argument from 0 to 4 can be passed for different peers -listings (default: 0). If a non\-zero value is passed, an -additional "outonly" (or "o") argument can be passed to see -outbound peers only. Pass "help" (or "h") for detailed help -documentation. -.SH COPYRIGHT -Copyright (C) 2009-2025 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or -.SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 deleted file mode 100644 index ab57dd61d7..0000000000 --- a/doc/man/bitcoin-qt.1 +++ /dev/null @@ -1,852 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-QT "1" "June 2026" "bitcoin-qt v29.4.0rc1" "User Commands" -.SH NAME -bitcoin-qt \- manual page for bitcoin-qt v29.4.0rc1 -.SH SYNOPSIS -.B bitcoin-qt -[\fI\,options\/\fR] [\fI\,URI\/\fR] -.SH DESCRIPTION -Bitcoin Core version v29.4.0rc1 -.PP -The bitcoin\-qt application provides a graphical interface for interacting with Bitcoin Core. -.PP -It combines the core functionalities of bitcoind with a user\-friendly interface for wallet management, transaction history, and network statistics. -.PP -It is suitable for users who prefer a graphical over a command\-line interface. -.PP -You can optionally specify a payment [URI], in e.g. the BIP21 URI format. -.SH OPTIONS -.HP -\fB\-alertnotify=\fR -.IP -Execute command when an alert is raised (%s in cmd is replaced by -message) -.HP -\fB\-allowignoredconf\fR -.IP -For backwards compatibility, treat an unused bitcoin.conf file in the -datadir as a warning, not an error. -.HP -\fB\-assumevalid=\fR -.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: -00000000000000000001b658dd1120e82e66d2790811f89ede9742ada3ed6d77, -testnet3: -00000000000003fc7967410ba2d0a8a8d50daedc318d43e8baf1a9782c236a57, -testnet4: -0000000000003ed4f08dbdf6f7d6b271a6bcffce25675cb40aa9fa43179a89f3, -signet: -000000895a110f46e59eb82bbc5bfb67fa314656009c295509c21b4999f5180a) -.HP -\fB\-blockfilterindex=\fR -.IP -Maintain an index of compact filters by block (default: 0, values: -basic). If is not supplied or if = 1, indexes for -all known types are enabled. -.HP -\fB\-blocknotify=\fR -.IP -Execute command when the best block changes (%s in cmd is replaced by -block hash) -.HP -\fB\-blockreconstructionextratxn=\fR -.IP -Extra transactions to keep in memory for compact block reconstructions -(default: 100) -.HP -\fB\-blocksdir=\fR -.IP -Specify directory to hold blocks subdirectory for *.dat files (default: -) -.HP -\fB\-blocksonly\fR -.IP -Whether to reject transactions from network peers. Disables automatic -broadcast and rebroadcast of transactions, unless the source peer -has the 'forcerelay' permission. RPC transactions are not -affected. (default: 0) -.HP -\fB\-blocksxor\fR -.IP -Whether an XOR\-key applies to blocksdir *.dat files. The created XOR\-key -will be zeros for an existing blocksdir or when `\-blocksxor=0` is -set, and random for a freshly initialized blocksdir. (default: 1) -.HP -\fB\-coinstatsindex\fR -.IP -Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) -.HP -\fB\-conf=\fR -.IP -Specify path to read\-only configuration file. Relative paths will be -prefixed by datadir location (only useable from command line, not -configuration file) (default: bitcoin.conf) -.HP -\fB\-daemon\fR -.IP -Run in the background as a daemon and accept commands (default: 0) -.HP -\fB\-daemonwait\fR -.IP -Wait for initialization to be finished before exiting. This implies -\fB\-daemon\fR (default: 0) -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-dbcache=\fR -.IP -Maximum database cache size MiB (minimum 4, default: 450). Make sure -you have enough RAM. In addition, unused memory allocated to the -mempool is shared with this cache (see \fB\-maxmempool\fR). -.HP -\fB\-debuglogfile=\fR -.IP -Specify location of debug log file (default: debug.log). Relative paths -will be prefixed by a net\-specific datadir location. Pass -\fB\-nodebuglogfile\fR to disable writing the log to a file. -.HP -\fB\-help\fR -.IP -Print this help message and exit (also \fB\-h\fR or \-?) -.HP -\fB\-includeconf=\fR -.IP -Specify additional configuration file, relative to the \fB\-datadir\fR path -(only useable from configuration file, not command line) -.HP -\fB\-loadblock=\fR -.IP -Imports blocks from external file on startup -.HP -\fB\-maxmempool=\fR -.IP -Keep the transaction memory pool below megabytes (default: 300) -.HP -\fB\-maxorphantx=\fR -.IP -Keep at most unconnectable transactions in memory (default: 100) -.HP -\fB\-mempoolexpiry=\fR -.IP -Do not keep transactions in the mempool longer than hours (default: -336) -.HP -\fB\-par=\fR -.IP -Set the number of script verification threads (0 = auto, up to 15, <0 = -leave that many cores free, default: 0) -.HP -\fB\-persistmempool\fR -.IP -Whether to save the mempool on shutdown and load on restart (default: 1) -.HP -\fB\-persistmempoolv1\fR -.IP -Whether a mempool.dat file created by \fB\-persistmempool\fR or the savemempool -RPC will be written in the legacy format (version 1) or the -current format (version 2). This temporary option will be removed -in the future. (default: 0) -.HP -\fB\-pid=\fR -.IP -Specify pid file. Relative paths will be prefixed by a net\-specific -datadir location. (default: bitcoind.pid) -.HP -\fB\-prune=\fR -.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 \fB\-txindex\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 -\fB\-reindex\fR -.IP -If enabled, wipe chain state and block index, and rebuild them from -blk*.dat files on disk. Also wipe and rebuild other optional -indexes that are active. If an assumeutxo snapshot was loaded, -its chainstate will be wiped as well. The snapshot can then be -reloaded via RPC. -.HP -\fB\-reindex\-chainstate\fR -.IP -If enabled, wipe chain state, and rebuild it from blk*.dat files on -disk. If an assumeutxo snapshot was loaded, its chainstate will -be wiped as well. The snapshot can then be reloaded via RPC. -.HP -\fB\-settings=\fR -.IP -Specify path to dynamic settings data file. Can be disabled with -\fB\-nosettings\fR. File is written at runtime and not meant to be -edited by users (use bitcoin.conf instead for custom settings). -Relative paths will be prefixed by datadir location. (default: -settings.json) -.HP -\fB\-shutdownnotify=\fR -.IP -Execute command immediately before beginning shutdown. The need for -shutdown may be urgent, so be careful not to delay it long (if -the command doesn't require interaction with the server, consider -having it fork into the background). -.HP -\fB\-startupnotify=\fR -.IP -Execute command on startup. -.HP -\fB\-txindex\fR -.IP -Maintain a full transaction index, used by the getrawtransaction rpc -call (default: 0) -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Connection options: -.HP -\fB\-addnode=\fR -.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 \fB\-maxconnections\fR -limit. -.HP -\fB\-asmap=\fR -.IP -Specify asn mapping used for bucketing of the peers (default: -ip_asn.map). Relative paths will be prefixed by the net\-specific -datadir location. -.HP -\fB\-bantime=\fR -.IP -Default duration (in seconds) of manually configured bans (default: -86400) -.HP -\fB\-bind=\fR[:][=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, testnet3: 127.0.0.1:18334=onion, -testnet4: 127.0.0.1:48334=onion, signet: 127.0.0.1:38334=onion, -regtest: 127.0.0.1:18445=onion) -.HP -\fB\-cjdnsreachable\fR -.IP -If set, then this host is configured for CJDNS (connecting to fc00::/8 -addresses would lead us to the CJDNS network, see doc/cjdns.md) -(default: 0) -.HP -\fB\-connect=\fR -.IP -Connect only to the specified node; \fB\-noconnect\fR disables automatic -connections (the rules for this peer are the same as for -\fB\-addnode\fR). This option can be specified multiple times to connect -to multiple nodes. -.HP -\fB\-discover\fR -.IP -Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR -or \fB\-proxy\fR) -.HP -\fB\-dns\fR -.IP -Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1) -.HP -\fB\-dnsseed\fR -.IP -Query for peer addresses via DNS lookup, if low on addresses (default: 1 -unless \fB\-connect\fR used or \fB\-maxconnections\fR=\fI\,0\/\fR) -.HP -\fB\-externalip=\fR -.IP -Specify your own public address -.HP -\fB\-fixedseeds\fR -.IP -Allow fixed seeds if DNS seeds don't provide peers (default: 1) -.HP -\fB\-forcednsseed\fR -.IP -Always query for peer addresses via DNS lookup (default: 0) -.HP -\fB\-i2pacceptincoming\fR -.IP -Whether to accept inbound I2P connections (default: 1). Ignored if -\fB\-i2psam\fR is not set. Listening for inbound I2P connections is done -through the SAM proxy, not by binding to a local address and -port. -.HP -\fB\-i2psam=\fR -.IP -I2P SAM proxy to reach I2P peers and accept I2P connections (default: -none) -.HP -\fB\-listen\fR -.IP -Accept connections from outside (default: 1 if no \fB\-proxy\fR, \fB\-connect\fR or -\fB\-maxconnections\fR=\fI\,0\/\fR) -.HP -\fB\-listenonion\fR -.IP -Automatically create Tor onion service (default: 1) -.HP -\fB\-maxconnections=\fR -.IP -Maintain at most automatic connections to peers (default: 125). This -limit does not apply to connections manually added via \fB\-addnode\fR -or the addnode RPC, which have a separate limit of 8. -.HP -\fB\-maxreceivebuffer=\fR -.IP -Maximum per\-connection receive buffer, *1000 bytes (default: 5000) -.HP -\fB\-maxsendbuffer=\fR -.IP -Maximum per\-connection memory usage for the send buffer, *1000 bytes -(default: 1000) -.HP -\fB\-maxuploadtarget=\fR -.IP -Tries to keep outbound traffic under the given target per 24h. Limit -does not apply to peers with 'download' permission or blocks -created within past week. 0 = no limit (default: 0M). Optional -suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000 -base while uppercase is 1024 base -.HP -\fB\-natpmp\fR -.IP -Use PCP or NAT\-PMP to map the listening port (default: 0) -.HP -\fB\-networkactive\fR -.IP -Enable all P2P network activity (default: 1). Can be changed by the -setnetworkactive RPC command -.HP -\fB\-onion=\fR -.IP -Use separate SOCKS5 proxy to reach peers via Tor onion services, set -\fB\-noonion\fR to disable (default: \fB\-proxy\fR). May be a local file path -prefixed with 'unix:'. -.HP -\fB\-onlynet=\fR -.IP -Make automatic outbound connections only to network (ipv4, ipv6, -onion, i2p, cjdns). Inbound and manual connections are not -affected by this option. It can be specified multiple times to -allow multiple networks. -.HP -\fB\-peerblockfilters\fR -.IP -Serve compact block filters to peers per BIP 157 (default: 0) -.HP -\fB\-peerbloomfilters\fR -.IP -Support filtering of blocks and transaction with bloom filters (default: -0) -.HP -\fB\-port=\fR -.IP -Listen for connections on (default: 8333, testnet3: 18333, -testnet4: 48333, signet: 38333, regtest: 18444). Not relevant for -I2P (see doc/i2p.md). If set to a value x, the default onion -listening port will be set to x+1. -.HP -\fB\-proxy=\fR -.IP -Connect through SOCKS5 proxy, set \fB\-noproxy\fR to disable (default: -disabled). May be a local file path prefixed with 'unix:' if the -proxy supports it. -.HP -\fB\-proxyrandomize\fR -.IP -Randomize credentials for every proxy connection. This enables Tor -stream isolation (default: 1) -.HP -\fB\-seednode=\fR -.IP -Connect to a node to retrieve peer addresses, and disconnect. This -option can be specified multiple times to connect to multiple -nodes. During startup, seednodes will be tried before dnsseeds. -.HP -\fB\-timeout=\fR -.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 -\fB\-torcontrol=\fR: -.IP -Tor control host and port to use if onion listening enabled (default: -127.0.0.1:9051). If no port is specified, the default port of -9051 will be used. -.HP -\fB\-torpassword=\fR -.IP -Tor control port password (default: empty) -.HP -\fB\-v2transport\fR -.IP -Support v2 transport (default: 1) -.HP -\fB\-whitebind=\fR<[permissions@]addr> -.IP -Bind to the given address and add permission flags to the peers -connecting to it. Use [host]:port notation for IPv6. Allowed -permissions: bloomfilter (allow requesting BIP37 filtered blocks -and transactions), noban (do not ban for misbehavior; implies -download), forcerelay (relay transactions that are already in the -mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode, -and unlimited transaction announcements), mempool (allow -requesting BIP35 mempool contents), download (allow getheaders -during IBD, no disconnect after maxuploadtarget limit), addr -(responses to GETADDR avoid hitting the cache and contain random -records with the most up\-to\-date info). Specify multiple -permissions separated by commas (default: -download,noban,mempool,relay). Can be specified multiple times. -.HP -\fB\-whitelist=\fR<[permissions@]IP address or network> -.IP -Add permission flags to the peers using the given IP address (e.g. -1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses the same -permissions as \fB\-whitebind\fR. Additional flags "in" and "out" -control whether permissions apply to incoming connections and/or -manual (default: incoming only). Can be specified multiple times. -.PP -Wallet options: -.HP -\fB\-addresstype\fR -.IP -What type of addresses to use ("legacy", "p2sh\-segwit", "bech32", or -"bech32m", default: "bech32") -.HP -\fB\-avoidpartialspends\fR -.IP -Group outputs by address, selecting many (possibly all) or none, instead -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 larger\-than\-necessary number of inputs -being used. Always enabled for wallets with "avoid_reuse" -enabled, otherwise default: 0. -.HP -\fB\-changetype\fR -.IP -What type of change to use ("legacy", "p2sh\-segwit", "bech32", or -"bech32m"). Default is "legacy" when \fB\-addresstype\fR=\fI\,legacy\/\fR, else it -is an implementation detail. -.HP -\fB\-consolidatefeerate=\fR -.IP -The maximum feerate (in BTC/kvB) at which transaction building may use -more inputs than strictly necessary so that the wallet's UTXO -pool can be reduced (default: 0.0001). -.HP -\fB\-disablewallet\fR -.IP -Do not load the wallet and disable wallet RPC calls -.HP -\fB\-discardfee=\fR -.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 -\fB\-fallbackfee=\fR -.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 -\fB\-keypool=\fR -.IP -Set key pool size to (default: 1000). Warning: Smaller sizes may -increase the risk of losing funds when restoring from an old -backup, if none of the addresses in the original keypool have -been used. -.HP -\fB\-maxapsfee=\fR -.IP -Spend up to this amount in additional (absolute) fees (in BTC) if it -allows the use of partial spend avoidance (default: 0.00) -.HP -\fB\-mintxfee=\fR -.IP -Fee rates (in BTC/kvB) smaller than this are considered zero fee for -transaction creation (default: 0.00001) -.HP -\fB\-paytxfee=\fR -.IP -Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00) -.HP -\fB\-signer=\fR -.IP -External signing tool, see doc/external\-signer.md -.HP -\fB\-spendzeroconfchange\fR -.IP -Spend unconfirmed change when sending transactions (default: 1) -.HP -\fB\-txconfirmtarget=\fR -.IP -If paytxfee is not set, include enough fee so transactions begin -confirmation on average within n blocks (default: 6) -.HP -\fB\-wallet=\fR -.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 . This only loads existing -wallets and does not create new ones. For backwards compatibility -this also accepts names of existing top\-level data files in -. -.HP -\fB\-walletbroadcast\fR -.IP -Make the wallet broadcast transactions (default: 1) -.HP -\fB\-walletdir=\fR -.IP -Specify directory to hold wallets (default: /wallets if it -exists, otherwise ) -.HP -\fB\-walletnotify=\fR -.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 (\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 -\fB\-walletrbf\fR -.IP -Send transactions with full\-RBF opt\-in enabled (RPC only, default: 1) -.PP -ZeroMQ notification options: -.HP -\fB\-zmqpubhashblock=\fR
-.IP -Enable publish hash block in
-.HP -\fB\-zmqpubhashblockhwm=\fR -.IP -Set publish hash block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubhashtx=\fR
-.IP -Enable publish hash transaction in
-.HP -\fB\-zmqpubhashtxhwm=\fR -.IP -Set publish hash transaction outbound message high water mark (default: -1000) -.HP -\fB\-zmqpubrawblock=\fR
-.IP -Enable publish raw block in
-.HP -\fB\-zmqpubrawblockhwm=\fR -.IP -Set publish raw block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubrawtx=\fR
-.IP -Enable publish raw transaction in
-.HP -\fB\-zmqpubrawtxhwm=\fR -.IP -Set publish raw transaction outbound message high water mark (default: -1000) -.HP -\fB\-zmqpubsequence=\fR
-.IP -Enable publish hash block and tx sequence in
-.HP -\fB\-zmqpubsequencehwm=\fR -.IP -Set publish hash sequence message high water mark (default: 1000) -.PP -Debugging/Testing options: -.HP -\fB\-debug=\fR -.IP -Output debug and trace logging (default: \fB\-nodebug\fR, supplying -is optional). If is not supplied or if is 1 -or "all", output all debug logging. If is 0 or "none", -any other categories are ignored. Other valid values for - are: addrman, bench, blockstorage, cmpctblock, coindb, -estimatefee, http, i2p, ipc, leveldb, libevent, mempool, -mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, scan, -selectcoins, tor, txpackages, txreconciliation, validation, -walletdb, zmq. This option can be specified multiple times to -output multiple categories. -.HP -\fB\-debugexclude=\fR -.IP -Exclude debug and trace logging for a category. Can be used in -conjunction with \fB\-debug\fR=\fI\,1\/\fR to output debug and trace logging for -all categories except the specified category. This option can be -specified multiple times to exclude multiple categories. This -takes priority over "\-debug" -.HP -\fB\-help\-debug\fR -.IP -Print help message with debugging options and exit -.HP -\fB\-logips\fR -.IP -Include IP addresses in debug output (default: 0) -.HP -\fB\-loglevelalways\fR -.IP -Always prepend a category and level (default: 0) -.HP -\fB\-logsourcelocations\fR -.IP -Prepend debug output with name of the originating source location -(source file, line number and function name) (default: 0) -.HP -\fB\-logthreadnames\fR -.IP -Prepend debug output with name of the originating thread (default: 0) -.HP -\fB\-logtimestamps\fR -.IP -Prepend debug output with timestamp (default: 1) -.HP -\fB\-maxtxfee=\fR -.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 -\fB\-printtoconsole\fR -.IP -Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable -logging to file, set \fB\-nodebuglogfile\fR) -.HP -\fB\-shrinkdebugfile\fR -.IP -Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) -.HP -\fB\-uacomment=\fR -.IP -Append comment to the user agent string -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -testnet4, signet, regtest -.HP -\fB\-signet\fR -.IP -Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fB\-signetchallenge\fR parameter -.HP -\fB\-signetchallenge\fR -.IP -Blocks must satisfy the given script to be considered valid (only for -signet networks; defaults to the global default signet test -network challenge) -.HP -\fB\-signetseednode\fR -.IP -Specify a seed node for the signet network, in the hostname[:port] -format, e.g. sig.net:1234 (may be used multiple times to specify -multiple seed nodes; defaults to the global default signet test -network seed node(s)) -.HP -\fB\-testnet\fR -.IP -Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 -is deprecated and will be removed in an upcoming release. -Consider moving to testnet4 now by using \fB\-testnet4\fR. -.HP -\fB\-testnet4\fR -.IP -Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR. -.PP -Node relay options: -.HP -\fB\-bytespersigop\fR -.IP -Equivalent bytes per sigop in transactions for relay and mining -(default: 20) -.HP -\fB\-datacarrier\fR -.IP -Relay and mine data carrier transactions (default: 1) -.HP -\fB\-datacarriersize\fR -.IP -Relay and mine transactions whose data\-carrying raw scriptPubKey is of -this size or less (default: 83) -.HP -\fB\-minrelaytxfee=\fR -.IP -Fees (in BTC/kvB) smaller than this are considered zero fee for -relaying, mining and transaction creation (default: 0.000001) -.HP -\fB\-permitbaremultisig\fR -.IP -Relay transactions creating non\-P2SH multisig outputs (default: 1) -.HP -\fB\-whitelistforcerelay\fR -.IP -Add 'forcerelay' permission to whitelisted peers with default -permissions. This will relay transactions even if the -transactions were already in the mempool. (default: 0) -.HP -\fB\-whitelistrelay\fR -.IP -Add 'relay' permission to whitelisted peers with default permissions. -This will accept relayed transactions even when not relaying -transactions (default: 1) -.PP -Block creation options: -.HP -\fB\-blockmaxweight=\fR -.IP -Set maximum BIP141 block weight (default: 4000000) -.HP -\fB\-blockmintxfee=\fR -.IP -Set lowest fee rate (in BTC/kvB) for transactions to be included in -block creation. (default: 0.00000001) -.HP -\fB\-blockreservedweight=\fR -.IP -Reserve space for the fixed\-size block header plus the largest coinbase -transaction the mining software may add to the block. (default: -8000). -.PP -RPC server options: -.HP -\fB\-rest\fR -.IP -Accept public REST requests (default: 0) -.HP -\fB\-rpcallowip=\fR -.IP -Allow JSON\-RPC connections from specified source. Valid values for -are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. -1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all -ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be -specified multiple times -.HP -\fB\-rpcauth=\fR -.IP -Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The -field comes in the format: :$. A -canonical python script is included in share/rpcauth. The client -then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times -.HP -\fB\-rpcbind=\fR[:port] -.IP -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 \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 -\fB\-rpccookiefile=\fR -.IP -Location of the auth cookie. Relative paths will be prefixed by a -net\-specific datadir location. (default: data dir) -.HP -\fB\-rpccookieperms=\fR -.IP -Set permissions on the RPC auth cookie file so that it is readable by -[owner|group|all] (default: owner [via umask 0077]) -.HP -\fB\-rpcpassword=\fR -.IP -Password for JSON\-RPC connections -.HP -\fB\-rpcport=\fR -.IP -Listen for JSON\-RPC connections on (default: 8332, testnet3: -18332, testnet4: 48332, signet: 38332, regtest: 18443) -.HP -\fB\-rpcthreads=\fR -.IP -Set the number of threads to service RPC calls (default: 16) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections -.HP -\fB\-rpcwhitelist=\fR -.IP -Set a whitelist to filter incoming RPC calls for a specific user. The -field comes in the format: :,,...,. If multiple whitelists are set for a given user, -they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation -for information on default whitelist behavior. -.HP -\fB\-rpcwhitelistdefault\fR -.IP -Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault -is set to 0, if any \fB\-rpcwhitelist\fR is set, the rpc server acts as -if all rpc users are subject to empty\-unless\-otherwise\-specified -whitelists. If rpcwhitelistdefault is set to 1 and no -\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are -subject to empty whitelists. -.HP -\fB\-server\fR -.IP -Accept command line and JSON\-RPC commands -.PP -UI Options: -.HP -\fB\-choosedatadir\fR -.IP -Choose data directory on startup (default: 0) -.HP -\fB\-lang=\fR -.IP -Set language, for example "de_DE" (default: system locale) -.HP -\fB\-min\fR -.IP -Start minimized -.HP -\fB\-resetguisettings\fR -.IP -Reset all settings changed in the GUI -.HP -\fB\-splash\fR -.IP -Show splash screen on startup (default: 1) -.SH COPYRIGHT -Copyright (C) 2009-2025 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or -.SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 deleted file mode 100644 index de043b7142..0000000000 --- a/doc/man/bitcoin-tx.1 +++ /dev/null @@ -1,159 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-TX "1" "June 2026" "bitcoin-tx v29.4.0rc1" "User Commands" -.SH NAME -bitcoin-tx \- manual page for bitcoin-tx v29.4.0rc1 -.SH SYNOPSIS -.B bitcoin-tx -[\fI\,options\/\fR] \fI\, \/\fR[\fI\,commands\/\fR] -.br -.B bitcoin-tx -[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] -.SH DESCRIPTION -Bitcoin Core bitcoin\-tx utility version v29.4.0rc1 -.PP -The bitcoin\-tx tool is used for creating and modifying bitcoin transactions. -.PP -bitcoin\-tx can be used with " [commands]" to update a hex\-encoded bitcoin transaction, or with "\-create [commands]" to create a hex\-encoded bitcoin transaction. -.SH OPTIONS -.HP -\fB\-create\fR -.IP -Create new, empty TX. -.HP -\fB\-help\fR -.IP -Print this help message and exit (also \fB\-h\fR or \-?) -.HP -\fB\-json\fR -.IP -Select JSON output -.HP -\fB\-txid\fR -.IP -Output only the hex\-encoded transaction id of the resultant transaction. -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Debugging/Testing options: -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -testnet4, signet, regtest -.HP -\fB\-signet\fR -.IP -Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fB\-signetchallenge\fR parameter -.HP -\fB\-signetchallenge\fR -.IP -Blocks must satisfy the given script to be considered valid (only for -signet networks; defaults to the global default signet test -network challenge) -.HP -\fB\-signetseednode\fR -.IP -Specify a seed node for the signet network, in the hostname[:port] -format, e.g. sig.net:1234 (may be used multiple times to specify -multiple seed nodes; defaults to the global default signet test -network seed node(s)) -.HP -\fB\-testnet\fR -.IP -Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 -is deprecated and will be removed in an upcoming release. -Consider moving to testnet4 now by using \fB\-testnet4\fR. -.HP -\fB\-testnet4\fR -.IP -Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\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 address\-based output to TX -.IP -outdata=[VALUE:]DATA -.IP -Add data\-based output to TX -.IP -outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS] -.IP -Add Pay To n\-of\-m Multi\-sig output to TX. n = REQUIRED, m = PUBKEYS. -Optionally add the "W" flag to produce a -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 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 -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 -Sets Replace\-By\-Fee (RBF) opt\-in sequence number for input N. If N is -not provided, the command attempts to opt\-in all available inputs -for RBF. If the transaction has no inputs, this option is -ignored. -.IP -sign=SIGHASH\-FLAGS -.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:JSON\-STRING -.IP -Set register NAME to given JSON\-STRING -.SH COPYRIGHT -Copyright (C) 2009-2025 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or -.SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoin-util.1 b/doc/man/bitcoin-util.1 deleted file mode 100644 index 063e05883a..0000000000 --- a/doc/man/bitcoin-util.1 +++ /dev/null @@ -1,78 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-UTIL "1" "June 2026" "bitcoin-util v29.4.0rc1" "User Commands" -.SH NAME -bitcoin-util \- manual page for bitcoin-util v29.4.0rc1 -.SH SYNOPSIS -.B bitcoin-util -[\fI\,options\/\fR] [\fI\,command\/\fR] -.br -.B bitcoin-util -[\fI\,options\/\fR] \fI\,grind \/\fR -.SH DESCRIPTION -Bitcoin Core bitcoin\-util utility version v29.4.0rc1 -.PP -The bitcoin\-util tool provides bitcoin related functionality that does not rely on the ability to access a running node. Available [commands] are listed below. -.SH OPTIONS -.HP -\fB\-help\fR -.IP -Print this help message and exit (also \fB\-h\fR or \-?) -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Debugging/Testing options: -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -testnet4, signet, regtest -.HP -\fB\-signet\fR -.IP -Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fB\-signetchallenge\fR parameter -.HP -\fB\-signetchallenge\fR -.IP -Blocks must satisfy the given script to be considered valid (only for -signet networks; defaults to the global default signet test -network challenge) -.HP -\fB\-signetseednode\fR -.IP -Specify a seed node for the signet network, in the hostname[:port] -format, e.g. sig.net:1234 (may be used multiple times to specify -multiple seed nodes; defaults to the global default signet test -network seed node(s)) -.HP -\fB\-testnet\fR -.IP -Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 -is deprecated and will be removed in an upcoming release. -Consider moving to testnet4 now by using \fB\-testnet4\fR. -.HP -\fB\-testnet4\fR -.IP -Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR. -.PP -Commands: -.IP -grind -.IP -Perform proof of work on hex header string -.SH COPYRIGHT -Copyright (C) 2009-2025 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or -.SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1 deleted file mode 100644 index 8f7f721406..0000000000 --- a/doc/man/bitcoin-wallet.1 +++ /dev/null @@ -1,136 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-WALLET "1" "June 2026" "bitcoin-wallet v29.4.0rc1" "User Commands" -.SH NAME -bitcoin-wallet \- manual page for bitcoin-wallet v29.4.0rc1 -.SH SYNOPSIS -.B bitcoin-wallet -[\fI\,options\/\fR] \fI\,\/\fR -.SH DESCRIPTION -Bitcoin Core bitcoin\-wallet utility version v29.4.0rc1 -.PP -bitcoin\-wallet is an offline tool for creating and interacting with Bitcoin Core wallet files. -.PP -By default bitcoin\-wallet will act on wallets in the default mainnet wallet directory in the datadir. -.PP -To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and (test)chain selection arguments. -.SH OPTIONS -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-descriptors\fR -.IP -Create descriptors wallet. Only for 'create' -.HP -\fB\-dumpfile=\fR -.IP -When used with 'dump', writes out the records to this file. When used -with 'createfromdump', loads the records into a new wallet. -.HP -\fB\-format=\fR -.IP -The format of the wallet file to create. Either "bdb" or "sqlite". Only -used with 'createfromdump' -.HP -\fB\-help\fR -.IP -Print this help message and exit (also \fB\-h\fR or \-?) -.HP -\fB\-legacy\fR -.IP -Create legacy wallet. Only for 'create' -.HP -\fB\-version\fR -.IP -Print version and exit -.HP -\fB\-wallet=\fR -.IP -Specify wallet name -.PP -Debugging/Testing options: -.HP -\fB\-debug=\fR -.IP -Output debugging information (default: 0). -.HP -\fB\-printtoconsole\fR -.IP -Send trace/debug info to console (default: 1 when no \fB\-debug\fR is true, 0 -otherwise). -.HP -\fB\-withinternalbdb\fR -.IP -Use the internal Berkeley DB parser when dumping a Berkeley DB wallet -file (default: false) -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -testnet4, signet, regtest -.HP -\fB\-signet\fR -.IP -Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fB\-signetchallenge\fR parameter -.HP -\fB\-signetchallenge\fR -.IP -Blocks must satisfy the given script to be considered valid (only for -signet networks; defaults to the global default signet test -network challenge) -.HP -\fB\-signetseednode\fR -.IP -Specify a seed node for the signet network, in the hostname[:port] -format, e.g. sig.net:1234 (may be used multiple times to specify -multiple seed nodes; defaults to the global default signet test -network seed node(s)) -.HP -\fB\-testnet\fR -.IP -Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 -is deprecated and will be removed in an upcoming release. -Consider moving to testnet4 now by using \fB\-testnet4\fR. -.HP -\fB\-testnet4\fR -.IP -Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\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 key\-value records -.IP -info -.IP -Get wallet info -.IP -salvage -.IP -Attempt to recover private keys from a corrupt wallet. Warning: -\&'salvage' is experimental. -.SH COPYRIGHT -Copyright (C) 2009-2025 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or -.SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 deleted file mode 100644 index 7a8c4c3e1b..0000000000 --- a/doc/man/bitcoind.1 +++ /dev/null @@ -1,830 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIND "1" "June 2026" "bitcoind v29.4.0rc1" "User Commands" -.SH NAME -bitcoind \- manual page for bitcoind v29.4.0rc1 -.SH SYNOPSIS -.B bitcoind -[\fI\,options\/\fR] -.SH DESCRIPTION -Bitcoin Core daemon version v29.4.0rc1 -.PP -The Bitcoin Core daemon (bitcoind) is a headless program that connects to the Bitcoin network to validate and relay transactions and blocks, as well as relaying addresses. -.PP -It provides the backbone of the Bitcoin network and its RPC, REST and ZMQ services can provide various transaction, block and address\-related services. -.PP -There is an optional wallet component which provides transaction services. -.PP -It can be used in a headless environment or as part of a server setup. -.SH OPTIONS -.HP -\fB\-alertnotify=\fR -.IP -Execute command when an alert is raised (%s in cmd is replaced by -message) -.HP -\fB\-allowignoredconf\fR -.IP -For backwards compatibility, treat an unused bitcoin.conf file in the -datadir as a warning, not an error. -.HP -\fB\-assumevalid=\fR -.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: -00000000000000000001b658dd1120e82e66d2790811f89ede9742ada3ed6d77, -testnet3: -00000000000003fc7967410ba2d0a8a8d50daedc318d43e8baf1a9782c236a57, -testnet4: -0000000000003ed4f08dbdf6f7d6b271a6bcffce25675cb40aa9fa43179a89f3, -signet: -000000895a110f46e59eb82bbc5bfb67fa314656009c295509c21b4999f5180a) -.HP -\fB\-blockfilterindex=\fR -.IP -Maintain an index of compact filters by block (default: 0, values: -basic). If is not supplied or if = 1, indexes for -all known types are enabled. -.HP -\fB\-blocknotify=\fR -.IP -Execute command when the best block changes (%s in cmd is replaced by -block hash) -.HP -\fB\-blockreconstructionextratxn=\fR -.IP -Extra transactions to keep in memory for compact block reconstructions -(default: 100) -.HP -\fB\-blocksdir=\fR -.IP -Specify directory to hold blocks subdirectory for *.dat files (default: -) -.HP -\fB\-blocksonly\fR -.IP -Whether to reject transactions from network peers. Disables automatic -broadcast and rebroadcast of transactions, unless the source peer -has the 'forcerelay' permission. RPC transactions are not -affected. (default: 0) -.HP -\fB\-blocksxor\fR -.IP -Whether an XOR\-key applies to blocksdir *.dat files. The created XOR\-key -will be zeros for an existing blocksdir or when `\-blocksxor=0` is -set, and random for a freshly initialized blocksdir. (default: 1) -.HP -\fB\-coinstatsindex\fR -.IP -Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) -.HP -\fB\-conf=\fR -.IP -Specify path to read\-only configuration file. Relative paths will be -prefixed by datadir location (only useable from command line, not -configuration file) (default: bitcoin.conf) -.HP -\fB\-daemon\fR -.IP -Run in the background as a daemon and accept commands (default: 0) -.HP -\fB\-daemonwait\fR -.IP -Wait for initialization to be finished before exiting. This implies -\fB\-daemon\fR (default: 0) -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-dbcache=\fR -.IP -Maximum database cache size MiB (minimum 4, default: 450). Make sure -you have enough RAM. In addition, unused memory allocated to the -mempool is shared with this cache (see \fB\-maxmempool\fR). -.HP -\fB\-debuglogfile=\fR -.IP -Specify location of debug log file (default: debug.log). Relative paths -will be prefixed by a net\-specific datadir location. Pass -\fB\-nodebuglogfile\fR to disable writing the log to a file. -.HP -\fB\-help\fR -.IP -Print this help message and exit (also \fB\-h\fR or \-?) -.HP -\fB\-includeconf=\fR -.IP -Specify additional configuration file, relative to the \fB\-datadir\fR path -(only useable from configuration file, not command line) -.HP -\fB\-loadblock=\fR -.IP -Imports blocks from external file on startup -.HP -\fB\-maxmempool=\fR -.IP -Keep the transaction memory pool below megabytes (default: 300) -.HP -\fB\-maxorphantx=\fR -.IP -Keep at most unconnectable transactions in memory (default: 100) -.HP -\fB\-mempoolexpiry=\fR -.IP -Do not keep transactions in the mempool longer than hours (default: -336) -.HP -\fB\-par=\fR -.IP -Set the number of script verification threads (0 = auto, up to 15, <0 = -leave that many cores free, default: 0) -.HP -\fB\-persistmempool\fR -.IP -Whether to save the mempool on shutdown and load on restart (default: 1) -.HP -\fB\-persistmempoolv1\fR -.IP -Whether a mempool.dat file created by \fB\-persistmempool\fR or the savemempool -RPC will be written in the legacy format (version 1) or the -current format (version 2). This temporary option will be removed -in the future. (default: 0) -.HP -\fB\-pid=\fR -.IP -Specify pid file. Relative paths will be prefixed by a net\-specific -datadir location. (default: bitcoind.pid) -.HP -\fB\-prune=\fR -.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 \fB\-txindex\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 -\fB\-reindex\fR -.IP -If enabled, wipe chain state and block index, and rebuild them from -blk*.dat files on disk. Also wipe and rebuild other optional -indexes that are active. If an assumeutxo snapshot was loaded, -its chainstate will be wiped as well. The snapshot can then be -reloaded via RPC. -.HP -\fB\-reindex\-chainstate\fR -.IP -If enabled, wipe chain state, and rebuild it from blk*.dat files on -disk. If an assumeutxo snapshot was loaded, its chainstate will -be wiped as well. The snapshot can then be reloaded via RPC. -.HP -\fB\-settings=\fR -.IP -Specify path to dynamic settings data file. Can be disabled with -\fB\-nosettings\fR. File is written at runtime and not meant to be -edited by users (use bitcoin.conf instead for custom settings). -Relative paths will be prefixed by datadir location. (default: -settings.json) -.HP -\fB\-shutdownnotify=\fR -.IP -Execute command immediately before beginning shutdown. The need for -shutdown may be urgent, so be careful not to delay it long (if -the command doesn't require interaction with the server, consider -having it fork into the background). -.HP -\fB\-startupnotify=\fR -.IP -Execute command on startup. -.HP -\fB\-txindex\fR -.IP -Maintain a full transaction index, used by the getrawtransaction rpc -call (default: 0) -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Connection options: -.HP -\fB\-addnode=\fR -.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 \fB\-maxconnections\fR -limit. -.HP -\fB\-asmap=\fR -.IP -Specify asn mapping used for bucketing of the peers (default: -ip_asn.map). Relative paths will be prefixed by the net\-specific -datadir location. -.HP -\fB\-bantime=\fR -.IP -Default duration (in seconds) of manually configured bans (default: -86400) -.HP -\fB\-bind=\fR[:][=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, testnet3: 127.0.0.1:18334=onion, -testnet4: 127.0.0.1:48334=onion, signet: 127.0.0.1:38334=onion, -regtest: 127.0.0.1:18445=onion) -.HP -\fB\-cjdnsreachable\fR -.IP -If set, then this host is configured for CJDNS (connecting to fc00::/8 -addresses would lead us to the CJDNS network, see doc/cjdns.md) -(default: 0) -.HP -\fB\-connect=\fR -.IP -Connect only to the specified node; \fB\-noconnect\fR disables automatic -connections (the rules for this peer are the same as for -\fB\-addnode\fR). This option can be specified multiple times to connect -to multiple nodes. -.HP -\fB\-discover\fR -.IP -Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR -or \fB\-proxy\fR) -.HP -\fB\-dns\fR -.IP -Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1) -.HP -\fB\-dnsseed\fR -.IP -Query for peer addresses via DNS lookup, if low on addresses (default: 1 -unless \fB\-connect\fR used or \fB\-maxconnections\fR=\fI\,0\/\fR) -.HP -\fB\-externalip=\fR -.IP -Specify your own public address -.HP -\fB\-fixedseeds\fR -.IP -Allow fixed seeds if DNS seeds don't provide peers (default: 1) -.HP -\fB\-forcednsseed\fR -.IP -Always query for peer addresses via DNS lookup (default: 0) -.HP -\fB\-i2pacceptincoming\fR -.IP -Whether to accept inbound I2P connections (default: 1). Ignored if -\fB\-i2psam\fR is not set. Listening for inbound I2P connections is done -through the SAM proxy, not by binding to a local address and -port. -.HP -\fB\-i2psam=\fR -.IP -I2P SAM proxy to reach I2P peers and accept I2P connections (default: -none) -.HP -\fB\-listen\fR -.IP -Accept connections from outside (default: 1 if no \fB\-proxy\fR, \fB\-connect\fR or -\fB\-maxconnections\fR=\fI\,0\/\fR) -.HP -\fB\-listenonion\fR -.IP -Automatically create Tor onion service (default: 1) -.HP -\fB\-maxconnections=\fR -.IP -Maintain at most automatic connections to peers (default: 125). This -limit does not apply to connections manually added via \fB\-addnode\fR -or the addnode RPC, which have a separate limit of 8. -.HP -\fB\-maxreceivebuffer=\fR -.IP -Maximum per\-connection receive buffer, *1000 bytes (default: 5000) -.HP -\fB\-maxsendbuffer=\fR -.IP -Maximum per\-connection memory usage for the send buffer, *1000 bytes -(default: 1000) -.HP -\fB\-maxuploadtarget=\fR -.IP -Tries to keep outbound traffic under the given target per 24h. Limit -does not apply to peers with 'download' permission or blocks -created within past week. 0 = no limit (default: 0M). Optional -suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000 -base while uppercase is 1024 base -.HP -\fB\-natpmp\fR -.IP -Use PCP or NAT\-PMP to map the listening port (default: 0) -.HP -\fB\-networkactive\fR -.IP -Enable all P2P network activity (default: 1). Can be changed by the -setnetworkactive RPC command -.HP -\fB\-onion=\fR -.IP -Use separate SOCKS5 proxy to reach peers via Tor onion services, set -\fB\-noonion\fR to disable (default: \fB\-proxy\fR). May be a local file path -prefixed with 'unix:'. -.HP -\fB\-onlynet=\fR -.IP -Make automatic outbound connections only to network (ipv4, ipv6, -onion, i2p, cjdns). Inbound and manual connections are not -affected by this option. It can be specified multiple times to -allow multiple networks. -.HP -\fB\-peerblockfilters\fR -.IP -Serve compact block filters to peers per BIP 157 (default: 0) -.HP -\fB\-peerbloomfilters\fR -.IP -Support filtering of blocks and transaction with bloom filters (default: -0) -.HP -\fB\-port=\fR -.IP -Listen for connections on (default: 8333, testnet3: 18333, -testnet4: 48333, signet: 38333, regtest: 18444). Not relevant for -I2P (see doc/i2p.md). If set to a value x, the default onion -listening port will be set to x+1. -.HP -\fB\-proxy=\fR -.IP -Connect through SOCKS5 proxy, set \fB\-noproxy\fR to disable (default: -disabled). May be a local file path prefixed with 'unix:' if the -proxy supports it. -.HP -\fB\-proxyrandomize\fR -.IP -Randomize credentials for every proxy connection. This enables Tor -stream isolation (default: 1) -.HP -\fB\-seednode=\fR -.IP -Connect to a node to retrieve peer addresses, and disconnect. This -option can be specified multiple times to connect to multiple -nodes. During startup, seednodes will be tried before dnsseeds. -.HP -\fB\-timeout=\fR -.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 -\fB\-torcontrol=\fR: -.IP -Tor control host and port to use if onion listening enabled (default: -127.0.0.1:9051). If no port is specified, the default port of -9051 will be used. -.HP -\fB\-torpassword=\fR -.IP -Tor control port password (default: empty) -.HP -\fB\-v2transport\fR -.IP -Support v2 transport (default: 1) -.HP -\fB\-whitebind=\fR<[permissions@]addr> -.IP -Bind to the given address and add permission flags to the peers -connecting to it. Use [host]:port notation for IPv6. Allowed -permissions: bloomfilter (allow requesting BIP37 filtered blocks -and transactions), noban (do not ban for misbehavior; implies -download), forcerelay (relay transactions that are already in the -mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode, -and unlimited transaction announcements), mempool (allow -requesting BIP35 mempool contents), download (allow getheaders -during IBD, no disconnect after maxuploadtarget limit), addr -(responses to GETADDR avoid hitting the cache and contain random -records with the most up\-to\-date info). Specify multiple -permissions separated by commas (default: -download,noban,mempool,relay). Can be specified multiple times. -.HP -\fB\-whitelist=\fR<[permissions@]IP address or network> -.IP -Add permission flags to the peers using the given IP address (e.g. -1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses the same -permissions as \fB\-whitebind\fR. Additional flags "in" and "out" -control whether permissions apply to incoming connections and/or -manual (default: incoming only). Can be specified multiple times. -.PP -Wallet options: -.HP -\fB\-addresstype\fR -.IP -What type of addresses to use ("legacy", "p2sh\-segwit", "bech32", or -"bech32m", default: "bech32") -.HP -\fB\-avoidpartialspends\fR -.IP -Group outputs by address, selecting many (possibly all) or none, instead -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 larger\-than\-necessary number of inputs -being used. Always enabled for wallets with "avoid_reuse" -enabled, otherwise default: 0. -.HP -\fB\-changetype\fR -.IP -What type of change to use ("legacy", "p2sh\-segwit", "bech32", or -"bech32m"). Default is "legacy" when \fB\-addresstype\fR=\fI\,legacy\/\fR, else it -is an implementation detail. -.HP -\fB\-consolidatefeerate=\fR -.IP -The maximum feerate (in BTC/kvB) at which transaction building may use -more inputs than strictly necessary so that the wallet's UTXO -pool can be reduced (default: 0.0001). -.HP -\fB\-disablewallet\fR -.IP -Do not load the wallet and disable wallet RPC calls -.HP -\fB\-discardfee=\fR -.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 -\fB\-fallbackfee=\fR -.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 -\fB\-keypool=\fR -.IP -Set key pool size to (default: 1000). Warning: Smaller sizes may -increase the risk of losing funds when restoring from an old -backup, if none of the addresses in the original keypool have -been used. -.HP -\fB\-maxapsfee=\fR -.IP -Spend up to this amount in additional (absolute) fees (in BTC) if it -allows the use of partial spend avoidance (default: 0.00) -.HP -\fB\-mintxfee=\fR -.IP -Fee rates (in BTC/kvB) smaller than this are considered zero fee for -transaction creation (default: 0.00001) -.HP -\fB\-paytxfee=\fR -.IP -Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00) -.HP -\fB\-signer=\fR -.IP -External signing tool, see doc/external\-signer.md -.HP -\fB\-spendzeroconfchange\fR -.IP -Spend unconfirmed change when sending transactions (default: 1) -.HP -\fB\-txconfirmtarget=\fR -.IP -If paytxfee is not set, include enough fee so transactions begin -confirmation on average within n blocks (default: 6) -.HP -\fB\-wallet=\fR -.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 . This only loads existing -wallets and does not create new ones. For backwards compatibility -this also accepts names of existing top\-level data files in -. -.HP -\fB\-walletbroadcast\fR -.IP -Make the wallet broadcast transactions (default: 1) -.HP -\fB\-walletdir=\fR -.IP -Specify directory to hold wallets (default: /wallets if it -exists, otherwise ) -.HP -\fB\-walletnotify=\fR -.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 (\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 -\fB\-walletrbf\fR -.IP -Send transactions with full\-RBF opt\-in enabled (RPC only, default: 1) -.PP -ZeroMQ notification options: -.HP -\fB\-zmqpubhashblock=\fR
-.IP -Enable publish hash block in
-.HP -\fB\-zmqpubhashblockhwm=\fR -.IP -Set publish hash block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubhashtx=\fR
-.IP -Enable publish hash transaction in
-.HP -\fB\-zmqpubhashtxhwm=\fR -.IP -Set publish hash transaction outbound message high water mark (default: -1000) -.HP -\fB\-zmqpubrawblock=\fR
-.IP -Enable publish raw block in
-.HP -\fB\-zmqpubrawblockhwm=\fR -.IP -Set publish raw block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubrawtx=\fR
-.IP -Enable publish raw transaction in
-.HP -\fB\-zmqpubrawtxhwm=\fR -.IP -Set publish raw transaction outbound message high water mark (default: -1000) -.HP -\fB\-zmqpubsequence=\fR
-.IP -Enable publish hash block and tx sequence in
-.HP -\fB\-zmqpubsequencehwm=\fR -.IP -Set publish hash sequence message high water mark (default: 1000) -.PP -Debugging/Testing options: -.HP -\fB\-debug=\fR -.IP -Output debug and trace logging (default: \fB\-nodebug\fR, supplying -is optional). If is not supplied or if is 1 -or "all", output all debug logging. If is 0 or "none", -any other categories are ignored. Other valid values for - are: addrman, bench, blockstorage, cmpctblock, coindb, -estimatefee, http, i2p, ipc, leveldb, libevent, mempool, -mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, scan, -selectcoins, tor, txpackages, txreconciliation, validation, -walletdb, zmq. This option can be specified multiple times to -output multiple categories. -.HP -\fB\-debugexclude=\fR -.IP -Exclude debug and trace logging for a category. Can be used in -conjunction with \fB\-debug\fR=\fI\,1\/\fR to output debug and trace logging for -all categories except the specified category. This option can be -specified multiple times to exclude multiple categories. This -takes priority over "\-debug" -.HP -\fB\-help\-debug\fR -.IP -Print help message with debugging options and exit -.HP -\fB\-logips\fR -.IP -Include IP addresses in debug output (default: 0) -.HP -\fB\-loglevelalways\fR -.IP -Always prepend a category and level (default: 0) -.HP -\fB\-logsourcelocations\fR -.IP -Prepend debug output with name of the originating source location -(source file, line number and function name) (default: 0) -.HP -\fB\-logthreadnames\fR -.IP -Prepend debug output with name of the originating thread (default: 0) -.HP -\fB\-logtimestamps\fR -.IP -Prepend debug output with timestamp (default: 1) -.HP -\fB\-maxtxfee=\fR -.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 -\fB\-printtoconsole\fR -.IP -Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable -logging to file, set \fB\-nodebuglogfile\fR) -.HP -\fB\-shrinkdebugfile\fR -.IP -Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) -.HP -\fB\-uacomment=\fR -.IP -Append comment to the user agent string -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -testnet4, signet, regtest -.HP -\fB\-signet\fR -.IP -Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network -is defined by the \fB\-signetchallenge\fR parameter -.HP -\fB\-signetchallenge\fR -.IP -Blocks must satisfy the given script to be considered valid (only for -signet networks; defaults to the global default signet test -network challenge) -.HP -\fB\-signetseednode\fR -.IP -Specify a seed node for the signet network, in the hostname[:port] -format, e.g. sig.net:1234 (may be used multiple times to specify -multiple seed nodes; defaults to the global default signet test -network seed node(s)) -.HP -\fB\-testnet\fR -.IP -Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 -is deprecated and will be removed in an upcoming release. -Consider moving to testnet4 now by using \fB\-testnet4\fR. -.HP -\fB\-testnet4\fR -.IP -Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR. -.PP -Node relay options: -.HP -\fB\-bytespersigop\fR -.IP -Equivalent bytes per sigop in transactions for relay and mining -(default: 20) -.HP -\fB\-datacarrier\fR -.IP -Relay and mine data carrier transactions (default: 1) -.HP -\fB\-datacarriersize\fR -.IP -Relay and mine transactions whose data\-carrying raw scriptPubKey is of -this size or less (default: 83) -.HP -\fB\-minrelaytxfee=\fR -.IP -Fees (in BTC/kvB) smaller than this are considered zero fee for -relaying, mining and transaction creation (default: 0.000001) -.HP -\fB\-permitbaremultisig\fR -.IP -Relay transactions creating non\-P2SH multisig outputs (default: 1) -.HP -\fB\-whitelistforcerelay\fR -.IP -Add 'forcerelay' permission to whitelisted peers with default -permissions. This will relay transactions even if the -transactions were already in the mempool. (default: 0) -.HP -\fB\-whitelistrelay\fR -.IP -Add 'relay' permission to whitelisted peers with default permissions. -This will accept relayed transactions even when not relaying -transactions (default: 1) -.PP -Block creation options: -.HP -\fB\-blockmaxweight=\fR -.IP -Set maximum BIP141 block weight (default: 4000000) -.HP -\fB\-blockmintxfee=\fR -.IP -Set lowest fee rate (in BTC/kvB) for transactions to be included in -block creation. (default: 0.00000001) -.HP -\fB\-blockreservedweight=\fR -.IP -Reserve space for the fixed\-size block header plus the largest coinbase -transaction the mining software may add to the block. (default: -8000). -.PP -RPC server options: -.HP -\fB\-rest\fR -.IP -Accept public REST requests (default: 0) -.HP -\fB\-rpcallowip=\fR -.IP -Allow JSON\-RPC connections from specified source. Valid values for -are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. -1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all -ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be -specified multiple times -.HP -\fB\-rpcauth=\fR -.IP -Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The -field comes in the format: :$. A -canonical python script is included in share/rpcauth. The client -then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times -.HP -\fB\-rpcbind=\fR[:port] -.IP -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 \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 -\fB\-rpccookiefile=\fR -.IP -Location of the auth cookie. Relative paths will be prefixed by a -net\-specific datadir location. (default: data dir) -.HP -\fB\-rpccookieperms=\fR -.IP -Set permissions on the RPC auth cookie file so that it is readable by -[owner|group|all] (default: owner [via umask 0077]) -.HP -\fB\-rpcpassword=\fR -.IP -Password for JSON\-RPC connections -.HP -\fB\-rpcport=\fR -.IP -Listen for JSON\-RPC connections on (default: 8332, testnet3: -18332, testnet4: 48332, signet: 38332, regtest: 18443) -.HP -\fB\-rpcthreads=\fR -.IP -Set the number of threads to service RPC calls (default: 16) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections -.HP -\fB\-rpcwhitelist=\fR -.IP -Set a whitelist to filter incoming RPC calls for a specific user. The -field comes in the format: :,,...,. If multiple whitelists are set for a given user, -they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation -for information on default whitelist behavior. -.HP -\fB\-rpcwhitelistdefault\fR -.IP -Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault -is set to 0, if any \fB\-rpcwhitelist\fR is set, the rpc server acts as -if all rpc users are subject to empty\-unless\-otherwise\-specified -whitelists. If rpcwhitelistdefault is set to 1 and no -\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are -subject to empty whitelists. -.HP -\fB\-server\fR -.IP -Accept command line and JSON\-RPC commands -.SH COPYRIGHT -Copyright (C) 2009-2025 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or -.SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/elements-cli.1 b/doc/man/elements-cli.1 index 9c4927966a..8641344513 100644 --- a/doc/man/elements-cli.1 +++ b/doc/man/elements-cli.1 @@ -1,13 +1,307 @@ -.TH ELEMENTS-CLI "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. +.TH ELEMENTS-CLI "1" "August 2026" "elements-cli v29.4.1rc1" "User Commands" .SH NAME -elements-cli \- manual page for elements-cli +elements-cli \- manual page for elements-cli v29.4.1rc1 +.SH SYNOPSIS +.B elements-cli +[\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] +.br +.B elements-cli +[\fI\,options\/\fR] \fI\,-named \/\fR[\fI\,name=value\/\fR]... +.br +.B elements-cli +[\fI\,options\/\fR] \fI\,help\/\fR +.br +.B elements-cli +[\fI\,options\/\fR] \fI\,help \/\fR +.SH DESCRIPTION +Elements Core RPC client version v29.4.1rc1 +.PP +The elements\-cli utility provides a command line interface to interact with a Elements Core RPC server. +.PP +It can be used to query network information, manage wallets, create or broadcast transactions, and control the Elements Core server. +.PP +Use the "help" command to list all commands. Use "help " to show help for that command. +The \fB\-named\fR option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters. +.SH OPTIONS +.HP +\fB\-color=\fR +.IP +Color setting for CLI output (default: auto). Valid values: always, auto +(add color codes when standard output is connected to a terminal +and OS is not WIN32), never. Only applies to the output of +\fB\-getinfo\fR. +.HP +\fB\-conf=\fR +.IP +Specify configuration file. Relative paths will be prefixed by datadir +location. (default: elements.conf) +.HP +\fB\-datadir=\fR +.IP +Specify data directory +.HP +\fB\-help\fR +.IP +Print this help message and exit (also \fB\-h\fR or \-?) +.HP +\fB\-named\fR +.IP +Pass named instead of positional arguments (default: false) +.HP +\fB\-rpcclienttimeout=\fR +.IP +Timeout in seconds during HTTP requests, or 0 for no timeout. (default: +900) +.HP +\fB\-rpcconnect=\fR +.IP +Send commands to node running on (default: 127.0.0.1) +.HP +\fB\-rpccookiefile=\fR +.IP +Location of the auth cookie. Relative paths will be prefixed by a +net\-specific datadir location. (default: data dir) +.HP +\fB\-rpcpassword=\fR +.IP +Password for JSON\-RPC connections +.HP +\fB\-rpcport=\fR +.IP +Connect to JSON\-RPC on (default: 7041, testnet: 18332, testnet4: +48332, signet: 38332, regtest: 18443) +.HP +\fB\-rpcuser=\fR +.IP +Username for JSON\-RPC connections +.HP +\fB\-rpcwait\fR +.IP +Wait for RPC server to start +.HP +\fB\-rpcwaittimeout=\fR +.IP +Timeout in seconds to wait for the RPC server to start, or 0 for no +timeout. (default: 0) +.HP +\fB\-rpcwallet=\fR +.IP +Send RPC for non\-default wallet on RPC server (needs to exactly match +corresponding \fB\-wallet\fR option passed to elementsd). This changes +the RPC endpoint used, e.g. +http://127.0.0.1:8332/wallet/ +.HP +\fB\-stdin\fR +.IP +Read extra arguments from standard input, one per line until EOF/Ctrl\-D +(recommended for sensitive information such as passphrases). When +combined with \fB\-stdinrpcpass\fR, the first line from standard input +is used for the RPC password. +.HP +\fB\-stdinrpcpass\fR +.IP +Read RPC password from standard input as a single line. When combined +with \fB\-stdin\fR, the first line from standard input is used for the +RPC password. When combined with \fB\-stdinwalletpassphrase\fR, +\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR +consumes the second. +.HP +\fB\-stdinwalletpassphrase\fR +.IP +Read wallet passphrase from standard input as a single line. When +combined with \fB\-stdin\fR, the first line from standard input is used +for the wallet passphrase. +.HP +\fB\-version\fR +.IP +Print version and exit +.PP +Debugging/Testing options: +.PP +Chain selection options: +.HP +\fB\-chain=\fR +.IP +Use the chain (default: liquidv1). Reserved values: main, test, +signet, regtest, liquidv1, liquidv1test, liquidtestnet +.HP +\fB\-con_blockheightinheader\fR +.IP +Whether the chain includes the block height directly in the header, for +easier validation of block height in low\-resource environments. +(default: 1) +.HP +\fB\-con_has_parent_chain\fR +.IP +Whether or not there is a parent chain. +.HP +\fB\-con_max_block_sig_size\fR +.IP +Max allowed witness data for the signed block header. +.HP +\fB\-con_parent_chain_signblockscript\fR +.IP +Whether parent chain uses pow or signed blocks. If the parent chain uses +signed blocks, the challenge (scriptPubKey) script. If not, an +empty string. (default: empty script [ie parent uses pow]) +.HP +\fB\-con_parentpowlimit\fR +.IP +The proof\-of\-work limit value for the parent chain. +.HP +\fB\-con_signed_blocks\fR +.IP +Signed blockchain. Uses input of `\-signblockscript` to define what +signatures are necessary to solve it. +.HP +\fB\-fedpegscript\fR +.IP +The script for the federated peg enforce from genesis block. This script +may stop being enforced once dynamic federations activates. +.HP +\fB\-parentgenesisblockhash\fR +.IP +The genesis blockhash of the parent chain. +.HP +\fB\-signblockscript\fR +.IP +Signed blockchain enumberance. Only active when `\-con_signed_blocks` set +to true. +.HP +\fB\-signet\fR +.IP +Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fB\-signetchallenge\fR parameter +.HP +\fB\-signetchallenge\fR +.IP +Blocks must satisfy the given script to be considered valid (only for +signet networks; defaults to the global default signet test +network challenge) +.HP +\fB\-signetseednode\fR +.IP +Specify a seed node for the signet network, in the hostname[:port] +format, e.g. sig.net:1234 (may be used multiple times to specify +multiple seed nodes; defaults to the global default signet test +network seed node(s)) +.HP +\fB\-testnet\fR +.IP +Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 +is deprecated and will be removed in an upcoming release. +Consider moving to testnet4 now by using \fB\-testnet4\fR. +.HP +\fB\-testnet4\fR +.IP +Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR. +.PP +Elements Options: +.HP +\fB\-acceptunlimitedissuances\fR +.IP +Allow unblinded issuance amounts to exceed 21 million units +.HP +\fB\-con_blocksubsidy\fR +.IP +Defines the amount of block subsidy to start with, at genesis block, in +satoshis. +.HP +\fB\-con_connect_genesis_outputs\fR +.IP +Connect outputs in genesis block to utxo database. +.HP +\fB\-con_csv_deploy_start\fR +.IP +Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE +from genesis) +.HP +\fB\-con_dyna_deploy_signal\fR +.IP +Whether to signal for the Dynamic Federations deployment (default: 1). +.HP +\fB\-con_elementsmode\fR +.TP +Use Elements\-like instead of Core\-like witness encoding. +This is +.IP +required for CA/CT. (default: 1) +.HP +\fB\-con_mandatorycoinbase\fR +.IP +All non\-zero valued coinbase outputs must go to this scriptPubKey, if +set. +.HP +\fB\-dynamic_epoch_length\fR +.IP +Per\-chain parameter that sets how many blocks dynamic federation voting +and enforcement are in effect for. +.HP +\fB\-enforce_pak\fR +.IP +Causes standardness checks to enforce Pegout Authorization Key(PAK) +validation before dynamic federations, and consensus enforcement +after. +.HP +\fB\-multi_data_permitted\fR +.IP +Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR) +.HP +\fB\-pak\fR +.IP +Sets the 'first extension space' field to the pak entries ala +pre\-dynamic federations. Only used for testing in custom chains. +.HP +\fB\-total_valid_epochs\fR +.IP +Per\-chain parameter that sets how long a particular fedpegscript is in +effect for. +.PP +CLI Commands: +.HP +\fB\-addrinfo\fR +.IP +Get the number of addresses known to the node, per network and total, +after filtering for quality and recency. The total number of +addresses known to the node may be higher. +.HP +\fB\-generate\fR +.IP +Generate blocks, 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: elements\-cli \fB\-generate\fR 4 +1000 +.HP +\fB\-getinfo\fR +.IP +Get general information from the remote server. Note that unlike +server\-side RPC calls, the output of \fB\-getinfo\fR is the result of +multiple non\-atomic requests. Some entries in the output may +represent results from different states (e.g. wallet balance may +be as of a different block from the chain state reported) +.HP +\fB\-netinfo\fR +.IP +Get network peer connection information from the remote server. An +optional argument from 0 to 4 can be passed for different peers +listings (default: 0). If a non\-zero value is passed, an +additional "outonly" (or "o") argument can be passed to see +outbound peers only. Pass "help" (or "h") for detailed help +documentation. +.SH COPYRIGHT +Copyright (C) 2009-2026 The Elements Project developers +Copyright (C) 2009-2026 The Bitcoin Core developers -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . +Please contribute if you find Elements Core useful. Visit + for further information about the software. +The source code is available from +. This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING or .SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) +elementsd(1), elements-cli(1), elements-tx(1), elements-wallet(1), elements-util(1), elements-qt(1) diff --git a/doc/man/elements-qt.1 b/doc/man/elements-qt.1 index a3056a19b5..968b6f1f89 100644 --- a/doc/man/elements-qt.1 +++ b/doc/man/elements-qt.1 @@ -1,13 +1,1101 @@ -.TH ELEMENTS-QT "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. +.TH ELEMENTS-QT "1" "August 2026" "elements-qt v29.4.1rc1" "User Commands" .SH NAME -elements-qt \- manual page for elements-qt +elements-qt \- manual page for elements-qt v29.4.1rc1 +.SH SYNOPSIS +.B elements-qt +[\fI\,options\/\fR] [\fI\,URI\/\fR] +.SH DESCRIPTION +Elements Core version v29.4.1rc1 +.PP +The elements\-qt application provides a graphical interface for interacting with Elements Core. +.PP +It combines the core functionalities of elementsd with a user\-friendly interface for wallet management, transaction history, and network statistics. +.PP +It is suitable for users who prefer a graphical over a command\-line interface. +.PP +You can optionally specify a payment [URI], in e.g. the BIP21 URI format. +.SH OPTIONS +.HP +\fB\-alertnotify=\fR +.IP +Execute command when an alert is raised (%s in cmd is replaced by +message) +.HP +\fB\-allowignoredconf\fR +.IP +For backwards compatibility, treat an unused elements.conf file in the +datadir as a warning, not an error. +.HP +\fB\-assumevalid=\fR +.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: +0000000000000000000000000000000000000000000000000000000000000000, +testnet3: +00000000000003fc7967410ba2d0a8a8d50daedc318d43e8baf1a9782c236a57, +testnet4: +0000000000003ed4f08dbdf6f7d6b271a6bcffce25675cb40aa9fa43179a89f3, +signet: +000000895a110f46e59eb82bbc5bfb67fa314656009c295509c21b4999f5180a) +.HP +\fB\-blockfilterindex=\fR +.IP +Maintain an index of compact filters by block (default: 0, values: +basic). If is not supplied or if = 1, indexes for +all known types are enabled. +.HP +\fB\-blocknotify=\fR +.IP +Execute command when the best block changes (%s in cmd is replaced by +block hash) +.HP +\fB\-blockreconstructionextratxn=\fR +.IP +Extra transactions to keep in memory for compact block reconstructions +(default: 100) +.HP +\fB\-blocksdir=\fR +.IP +Specify directory to hold blocks subdirectory for *.dat files (default: +) +.HP +\fB\-blocksonly\fR +.IP +Whether to reject transactions from network peers. Disables automatic +broadcast and rebroadcast of transactions, unless the source peer +has the 'forcerelay' permission. RPC transactions are not +affected. (default: 0) +.HP +\fB\-blocksxor\fR +.IP +Whether an XOR\-key applies to blocksdir *.dat files. The created XOR\-key +will be zeros for an existing blocksdir or when `\-blocksxor=0` is +set, and random for a freshly initialized blocksdir. (default: 1) +.HP +\fB\-coinstatsindex\fR +.IP +Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) +.HP +\fB\-conf=\fR +.IP +Specify path to read\-only configuration file. Relative paths will be +prefixed by datadir location (only useable from command line, not +configuration file) (default: elements.conf) +.HP +\fB\-daemon\fR +.IP +Run in the background as a daemon and accept commands (default: 0) +.HP +\fB\-daemonwait\fR +.IP +Wait for initialization to be finished before exiting. This implies +\fB\-daemon\fR (default: 0) +.HP +\fB\-datadir=\fR +.IP +Specify data directory +.HP +\fB\-dbcache=\fR +.IP +Maximum database cache size MiB (minimum 4, default: 450). Make sure +you have enough RAM. In addition, unused memory allocated to the +mempool is shared with this cache (see \fB\-maxmempool\fR). +.HP +\fB\-debuglogfile=\fR +.IP +Specify location of debug log file (default: debug.log). Relative paths +will be prefixed by a net\-specific datadir location. Pass +\fB\-nodebuglogfile\fR to disable writing the log to a file. +.HP +\fB\-help\fR +.IP +Print this help message and exit (also \fB\-h\fR or \-?) +.HP +\fB\-includeconf=\fR +.IP +Specify additional configuration file, relative to the \fB\-datadir\fR path +(only useable from configuration file, not command line) +.HP +\fB\-loadblock=\fR +.IP +Imports blocks from external file on startup +.HP +\fB\-maxmempool=\fR +.IP +Keep the transaction memory pool below megabytes (default: 300) +.HP +\fB\-maxorphantx=\fR +.IP +Keep at most unconnectable transactions in memory (default: 100) +.HP +\fB\-mempoolexpiry=\fR +.IP +Do not keep transactions in the mempool longer than hours (default: +336) +.HP +\fB\-par=\fR +.IP +Set the number of script verification threads (0 = auto, up to 15, <0 = +leave that many cores free, default: 0) +.HP +\fB\-persistmempool\fR +.IP +Whether to save the mempool on shutdown and load on restart (default: 1) +.HP +\fB\-persistmempoolv1\fR +.IP +Whether a mempool.dat file created by \fB\-persistmempool\fR or the savemempool +RPC will be written in the legacy format (version 1) or the +current format (version 2). This temporary option will be removed +in the future. (default: 0) +.HP +\fB\-pid=\fR +.IP +Specify pid file. Relative paths will be prefixed by a net\-specific +datadir location. (default: elementsd.pid) +.HP +\fB\-prune=\fR +.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 \fB\-txindex\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 +\fB\-reindex\fR +.IP +If enabled, wipe chain state and block index, and rebuild them from +blk*.dat files on disk. Also wipe and rebuild other optional +indexes that are active. If an assumeutxo snapshot was loaded, +its chainstate will be wiped as well. The snapshot can then be +reloaded via RPC. +.HP +\fB\-reindex\-chainstate\fR +.IP +If enabled, wipe chain state, and rebuild it from blk*.dat files on +disk. If an assumeutxo snapshot was loaded, its chainstate will +be wiped as well. The snapshot can then be reloaded via RPC. +.HP +\fB\-settings=\fR +.IP +Specify path to dynamic settings data file. Can be disabled with +\fB\-nosettings\fR. File is written at runtime and not meant to be +edited by users (use elements.conf instead for custom settings). +Relative paths will be prefixed by datadir location. (default: +settings.json) +.HP +\fB\-shutdownnotify=\fR +.IP +Execute command immediately before beginning shutdown. The need for +shutdown may be urgent, so be careful not to delay it long (if +the command doesn't require interaction with the server, consider +having it fork into the background). +.HP +\fB\-startupnotify=\fR +.IP +Execute command on startup. +.HP +\fB\-trim_headers\fR +.IP +Trim old headers in memory (by default older than 2 epochs), removing +blocksigning and dynafed\-related fields. Saves memory, but blocks +us from serving blocks or headers to peers, and removes trimmed +fields from some JSON RPC outputs. (default: 0) +.HP +\fB\-txindex\fR +.IP +Maintain a full transaction index, used by the getrawtransaction rpc +call (default: 0) +.HP +\fB\-version\fR +.IP +Print version and exit +.PP +Connection options: +.HP +\fB\-addnode=\fR +.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 \fB\-maxconnections\fR +limit. +.HP +\fB\-asmap=\fR +.IP +Specify asn mapping used for bucketing of the peers (default: +ip_asn.map). Relative paths will be prefixed by the net\-specific +datadir location. +.HP +\fB\-bantime=\fR +.IP +Default duration (in seconds) of manually configured bans (default: +86400) +.HP +\fB\-bind=\fR[:][=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:7043=onion, testnet3: 127.0.0.1:18334=onion, +testnet4: 127.0.0.1:48334=onion, signet: 127.0.0.1:38334=onion, +regtest: 127.0.0.1:18445=onion) +.HP +\fB\-cjdnsreachable\fR +.IP +If set, then this host is configured for CJDNS (connecting to fc00::/8 +addresses would lead us to the CJDNS network, see doc/cjdns.md) +(default: 0) +.HP +\fB\-connect=\fR +.IP +Connect only to the specified node; \fB\-noconnect\fR disables automatic +connections (the rules for this peer are the same as for +\fB\-addnode\fR). This option can be specified multiple times to connect +to multiple nodes. +.HP +\fB\-discover\fR +.IP +Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR +or \fB\-proxy\fR) +.HP +\fB\-dns\fR +.IP +Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1) +.HP +\fB\-dnsseed\fR +.IP +Query for peer addresses via DNS lookup, if low on addresses (default: 1 +unless \fB\-connect\fR used or \fB\-maxconnections\fR=\fI\,0\/\fR) +.HP +\fB\-externalip=\fR +.IP +Specify your own public address +.HP +\fB\-fixedseeds\fR +.IP +Allow fixed seeds if DNS seeds don't provide peers (default: 1) +.HP +\fB\-forcednsseed\fR +.IP +Always query for peer addresses via DNS lookup (default: 0) +.HP +\fB\-i2pacceptincoming\fR +.IP +Whether to accept inbound I2P connections (default: 1). Ignored if +\fB\-i2psam\fR is not set. Listening for inbound I2P connections is done +through the SAM proxy, not by binding to a local address and +port. +.HP +\fB\-i2psam=\fR +.IP +I2P SAM proxy to reach I2P peers and accept I2P connections (default: +none) +.HP +\fB\-listen\fR +.IP +Accept connections from outside (default: 1 if no \fB\-proxy\fR, \fB\-connect\fR or +\fB\-maxconnections\fR=\fI\,0\/\fR) +.HP +\fB\-listenonion\fR +.IP +Automatically create Tor onion service (default: 1) +.HP +\fB\-maxconnections=\fR +.IP +Maintain at most automatic connections to peers (default: 125). This +limit does not apply to connections manually added via \fB\-addnode\fR +or the addnode RPC, which have a separate limit of 8. +.HP +\fB\-maxreceivebuffer=\fR +.IP +Maximum per\-connection receive buffer, *1000 bytes (default: 5000) +.HP +\fB\-maxsendbuffer=\fR +.IP +Maximum per\-connection memory usage for the send buffer, *1000 bytes +(default: 1000) +.HP +\fB\-maxuploadtarget=\fR +.IP +Tries to keep outbound traffic under the given target per 24h. Limit +does not apply to peers with 'download' permission or blocks +created within past week. 0 = no limit (default: 0M). Optional +suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000 +base while uppercase is 1024 base +.HP +\fB\-natpmp\fR +.IP +Use PCP or NAT\-PMP to map the listening port (default: 0) +.HP +\fB\-networkactive\fR +.IP +Enable all P2P network activity (default: 1). Can be changed by the +setnetworkactive RPC command +.HP +\fB\-onion=\fR +.IP +Use separate SOCKS5 proxy to reach peers via Tor onion services, set +\fB\-noonion\fR to disable (default: \fB\-proxy\fR). May be a local file path +prefixed with 'unix:'. +.HP +\fB\-onlynet=\fR +.IP +Make automatic outbound connections only to network (ipv4, ipv6, +onion, i2p, cjdns). Inbound and manual connections are not +affected by this option. It can be specified multiple times to +allow multiple networks. +.HP +\fB\-peerblockfilters\fR +.IP +Serve compact block filters to peers per BIP 157 (default: 0) +.HP +\fB\-peerbloomfilters\fR +.IP +Support filtering of blocks and transaction with bloom filters (default: +0) +.HP +\fB\-port=\fR +.IP +Listen for connections on (default: 7042, testnet3: 18333, +testnet4: 48333, signet: 38333, regtest: 18444). Not relevant for +I2P (see doc/i2p.md). If set to a value x, the default onion +listening port will be set to x+1. +.HP +\fB\-proxy=\fR +.IP +Connect through SOCKS5 proxy, set \fB\-noproxy\fR to disable (default: +disabled). May be a local file path prefixed with 'unix:' if the +proxy supports it. +.HP +\fB\-proxyrandomize\fR +.IP +Randomize credentials for every proxy connection. This enables Tor +stream isolation (default: 1) +.HP +\fB\-seednode=\fR +.IP +Connect to a node to retrieve peer addresses, and disconnect. This +option can be specified multiple times to connect to multiple +nodes. During startup, seednodes will be tried before dnsseeds. +.HP +\fB\-timeout=\fR +.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 +\fB\-torcontrol=\fR: +.IP +Tor control host and port to use if onion listening enabled (default: +127.0.0.1:9051). If no port is specified, the default port of +9051 will be used. +.HP +\fB\-torpassword=\fR +.IP +Tor control port password (default: empty) +.HP +\fB\-v2transport\fR +.IP +Support v2 transport (default: 1) +.HP +\fB\-whitebind=\fR<[permissions@]addr> +.IP +Bind to the given address and add permission flags to the peers +connecting to it. Use [host]:port notation for IPv6. Allowed +permissions: bloomfilter (allow requesting BIP37 filtered blocks +and transactions), noban (do not ban for misbehavior; implies +download), forcerelay (relay transactions that are already in the +mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode, +and unlimited transaction announcements), mempool (allow +requesting BIP35 mempool contents), download (allow getheaders +during IBD, no disconnect after maxuploadtarget limit), addr +(responses to GETADDR avoid hitting the cache and contain random +records with the most up\-to\-date info). Specify multiple +permissions separated by commas (default: +download,noban,mempool,relay). Can be specified multiple times. +.HP +\fB\-whitelist=\fR<[permissions@]IP address or network> +.IP +Add permission flags to the peers using the given IP address (e.g. +1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses the same +permissions as \fB\-whitebind\fR. Additional flags "in" and "out" +control whether permissions apply to incoming connections and/or +manual (default: incoming only). Can be specified multiple times. +.PP +Wallet options: +.HP +\fB\-addresstype\fR +.IP +What type of addresses to use ("legacy", "p2sh\-segwit", "bech32", or +"bech32m", default: "bech32") +.HP +\fB\-avoidpartialspends\fR +.IP +Group outputs by address, selecting many (possibly all) or none, instead +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 larger\-than\-necessary number of inputs +being used. Always enabled for wallets with "avoid_reuse" +enabled, otherwise default: 0. +.HP +\fB\-changetype\fR +.IP +What type of change to use ("legacy", "p2sh\-segwit", "bech32", or +"bech32m"). Default is "legacy" when \fB\-addresstype\fR=\fI\,legacy\/\fR, else it +is an implementation detail. +.HP +\fB\-consolidatefeerate=\fR +.IP +The maximum feerate (in BTC/kvB) at which transaction building may use +more inputs than strictly necessary so that the wallet's UTXO +pool can be reduced (default: 0.0001). +.HP +\fB\-disablewallet\fR +.IP +Do not load the wallet and disable wallet RPC calls +.HP +\fB\-discardfee=\fR +.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 +\fB\-fallbackfee=\fR +.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 +\fB\-keypool=\fR +.IP +Set key pool size to (default: 1000). Warning: Smaller sizes may +increase the risk of losing funds when restoring from an old +backup, if none of the addresses in the original keypool have +been used. +.HP +\fB\-maxapsfee=\fR +.IP +Spend up to this amount in additional (absolute) fees (in BTC) if it +allows the use of partial spend avoidance (default: 0.00) +.HP +\fB\-mintxfee=\fR +.IP +Fee rates (in BTC/kvB) smaller than this are considered zero fee for +transaction creation (default: 0.000001) +.HP +\fB\-paytxfee=\fR +.IP +Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00) +.HP +\fB\-signer=\fR +.IP +External signing tool, see doc/external\-signer.md +.HP +\fB\-spendzeroconfchange\fR +.IP +Spend unconfirmed change when sending transactions (default: 1) +.HP +\fB\-txconfirmtarget=\fR +.IP +If paytxfee is not set, include enough fee so transactions begin +confirmation on average within n blocks (default: 6) +.HP +\fB\-wallet=\fR +.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 . This only loads existing +wallets and does not create new ones. For backwards compatibility +this also accepts names of existing top\-level data files in +. +.HP +\fB\-walletbroadcast\fR +.IP +Make the wallet broadcast transactions (default: 1) +.HP +\fB\-walletdir=\fR +.IP +Specify directory to hold wallets (default: /wallets if it +exists, otherwise ) +.HP +\fB\-walletnotify=\fR +.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 (\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 +\fB\-walletrbf\fR +.IP +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 1) +.PP +Debugging/Testing options: +.HP +\fB\-debug=\fR +.IP +Output debug and trace logging (default: \fB\-nodebug\fR, supplying +is optional). If is not supplied or if is 1 +or "all", output all debug logging. If is 0 or "none", +any other categories are ignored. Other valid values for + are: addrman, bench, blockstorage, cmpctblock, coindb, +estimatefee, http, i2p, ipc, leveldb, libevent, mempool, +mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, scan, +selectcoins, tor, txpackages, txreconciliation, validation, +walletdb, zmq. This option can be specified multiple times to +output multiple categories. +.HP +\fB\-debugexclude=\fR +.IP +Exclude debug and trace logging for a category. Can be used in +conjunction with \fB\-debug\fR=\fI\,1\/\fR to output debug and trace logging for +all categories except the specified category. This option can be +specified multiple times to exclude multiple categories. This +takes priority over "\-debug" +.HP +\fB\-help\-debug\fR +.IP +Print help message with debugging options and exit +.HP +\fB\-logips\fR +.IP +Include IP addresses in debug output (default: 0) +.HP +\fB\-loglevelalways\fR +.IP +Always prepend a category and level (default: 0) +.HP +\fB\-logsourcelocations\fR +.IP +Prepend debug output with name of the originating source location +(source file, line number and function name) (default: 0) +.HP +\fB\-logthreadnames\fR +.IP +Prepend debug output with name of the originating thread (default: 0) +.HP +\fB\-logtimestamps\fR +.IP +Prepend debug output with timestamp (default: 1) +.HP +\fB\-maxtxfee=\fR +.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 +\fB\-printtoconsole\fR +.IP +Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable +logging to file, set \fB\-nodebuglogfile\fR) +.HP +\fB\-shrinkdebugfile\fR +.IP +Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) +.HP +\fB\-uacomment=\fR +.IP +Append comment to the user agent string +.PP +Chain selection options: +.HP +\fB\-acceptdiscountct\fR +.IP +Accept discounted fees for Confidential Transactions (default: 1 in +liquidtestnet and liquidv1, 0 otherwise) +.HP +\fB\-bech32_hrp\fR +.IP +The human\-readable part of the chain's bech32 encoding. (default: ex) +.HP +\fB\-blech32_hrp\fR +.IP +The human\-readable part of the chain's blech32 encoding. Used in +confidential addresses.(default: lq) +.HP +\fB\-chain=\fR +.IP +Use the chain (default: liquidv1). Reserved values: main, test, +signet, regtest, liquidv1, liquidv1test, liquidtestnet +.HP +\fB\-con_blockheightinheader\fR +.IP +Whether the chain includes the block height directly in the header, for +easier validation of block height in low\-resource environments. +(default: 1) +.HP +\fB\-con_has_parent_chain\fR +.IP +Whether or not there is a parent chain. +.HP +\fB\-con_max_block_sig_size\fR +.IP +Max allowed witness data for the signed block header. +.HP +\fB\-con_parent_chain_signblockscript\fR +.IP +Whether parent chain uses pow or signed blocks. If the parent chain uses +signed blocks, the challenge (scriptPubKey) script. If not, an +empty string. (default: empty script [ie parent uses pow]) +.HP +\fB\-con_parent_pegged_asset=\fR +.IP +Asset ID (hex) for pegged asset for when parent chain has CA. (default: +0x00) +.HP +\fB\-con_parentpowlimit\fR +.IP +The proof\-of\-work limit value for the parent chain. +.HP +\fB\-con_signed_blocks\fR +.IP +Signed blockchain. Uses input of `\-signblockscript` to define what +signatures are necessary to solve it. +.HP +\fB\-creatediscountct\fR +.IP +Create Confidential Transactions with discounted fees (default: 0). +Setting this to 1 will also set 'acceptdiscountct' to 1. +.HP +\fB\-ct_bits\fR +.IP +The default number of hiding bits in a rangeproof. Will be exceeded to +cover amounts exceeding the maximum hiding value. (default: 52) +.HP +\fB\-ct_exponent\fR +.IP +The hiding exponent. (default: 0) +.HP +\fB\-extprvkeyprefix\fR +.IP +The 4\-byte prefix, in hex, of the chain's base58 extended private key +encoding. (default: 0488ade4) +.HP +\fB\-extpubkeyprefix\fR +.IP +The 4\-byte prefix, in hex, of the chain's base58 extended public key +encoding. (default: 0488b21e) +.HP +\fB\-fedpegscript\fR +.IP +The script for the federated peg enforce from genesis block. This script +may stop being enforced once dynamic federations activates. +.HP +\fB\-feeasset=\fR +.IP +Asset ID (hex) for mempool/relay fees (default: +6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d) +.HP +\fB\-initialreissuancetokens=\fR +.IP +The amount of reissuance tokens created in the genesis block. (default: +0) +.HP +\fB\-parent_bech32_hrp\fR +.IP +The human\-readable part of the parent chain's bech32 encoding. (default: +bc) +.HP +\fB\-parent_blech32_hrp\fR +.IP +The human\-readable part of the parent chain's blech32 encoding. +(default: bc) +.HP +\fB\-parentgenesisblockhash\fR +.IP +The genesis blockhash of the parent chain. +.HP +\fB\-parentpubkeyprefix\fR +.IP +The byte prefix, in decimal, of the parent chain's base58 pubkey +address. (default: 111) +.HP +\fB\-parentscriptprefix\fR +.IP +The byte prefix, in decimal, of the parent chain's base58 script +address. (default: 196) +.HP +\fB\-peginminamount\fR +.IP +The minimum value for a peg\-in transaction after peginminheight +(default: unset). +.HP +\fB\-peginminheight\fR +.IP +The block height at which a minimum peg\-in value is enforced (default: +not active). +.HP +\fB\-peginsubsidyheight\fR +.IP +The block height at which peg\-in transactions must have a burn subsidy +(default: not active). The subsidy is an OP_RETURN output, with +its value equal to the feerate of the parent transaction +multiplied by the vsize of spending the P2WSH output created by +the peg\-in (feerate * 396 sats for liquidv1). +.HP +\fB\-peginsubsidythreshold\fR +.IP +The output value below which peg\-in transactions must have a burn +subsidy (default: 0). Peg\-ins above this value do not require the +subsidy. +.HP +\fB\-pubkeyprefix\fR +.IP +The byte prefix, in decimal, of the chain's base58 pubkey address. +(default: 57) +.HP +\fB\-scriptprefix\fR +.IP +The byte prefix, in decimal, of the chain's base58 script address. +(default: 39) +.HP +\fB\-secretprefix\fR +.IP +The byte prefix, in decimal, of the chain's base58 secret key encoding. +(default: 128) +.HP +\fB\-signblockscript\fR +.IP +Signed blockchain enumberance. Only active when `\-con_signed_blocks` set +to true. +.HP +\fB\-signet\fR +.IP +Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fB\-signetchallenge\fR parameter +.HP +\fB\-signetchallenge\fR +.IP +Blocks must satisfy the given script to be considered valid (only for +signet networks; defaults to the global default signet test +network challenge) +.HP +\fB\-signetseednode\fR +.IP +Specify a seed node for the signet network, in the hostname[:port] +format, e.g. sig.net:1234 (may be used multiple times to specify +multiple seed nodes; defaults to the global default signet test +network seed node(s)) +.HP +\fB\-subsidyasset=\fR +.IP +Asset ID (hex) for the block subsidy (default: +6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d) +.HP +\fB\-testnet\fR +.IP +Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3 +is deprecated and will be removed in an upcoming release. +Consider moving to testnet4 now by using \fB\-testnet4\fR. +.HP +\fB\-testnet4\fR +.IP +Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR. +.PP +Node relay options: +.HP +\fB\-bytespersigop\fR +.IP +Equivalent bytes per sigop in transactions for relay and mining +(default: 20) +.HP +\fB\-datacarrier\fR +.IP +Relay and mine data carrier transactions (default: 1) +.HP +\fB\-datacarriersize\fR +.IP +Relay and mine transactions whose data\-carrying raw scriptPubKey is of +this size or less (default: 83) +.HP +\fB\-minrelaytxfee=\fR +.IP +Fees (in BTC/kvB) smaller than this are considered zero fee for +relaying, mining and transaction creation (default: 0.000001) +.HP +\fB\-permitbaremultisig\fR +.IP +Relay transactions creating non\-P2SH multisig outputs (default: 1) +.HP +\fB\-whitelistforcerelay\fR +.IP +Add 'forcerelay' permission to whitelisted peers with default +permissions. This will relay transactions even if the +transactions were already in the mempool. (default: 0) +.HP +\fB\-whitelistrelay\fR +.IP +Add 'relay' permission to whitelisted peers with default permissions. +This will accept relayed transactions even when not relaying +transactions (default: 1) +.PP +Block creation options: +.HP +\fB\-blockmaxweight=\fR +.IP +Set maximum BIP141 block weight (default: 4000000) +.HP +\fB\-blockmintxfee=\fR +.IP +Set lowest fee rate (in BTC/kvB) for transactions to be included in +block creation. (default: 0.00000001) +.HP +\fB\-blockreservedweight=\fR +.IP +Reserve space for the fixed\-size block header plus the largest coinbase +transaction the mining software may add to the block. (default: +8000). +.PP +RPC server options: +.HP +\fB\-rest\fR +.IP +Accept public REST requests (default: 0) +.HP +\fB\-rpcallowip=\fR +.IP +Allow JSON\-RPC connections from specified source. Valid values for +are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. +1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all +ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be +specified multiple times +.HP +\fB\-rpcauth=\fR +.IP +Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The +field comes in the format: :$. A +canonical python script is included in share/rpcauth. The client +then connects normally using the +rpcuser=/rpcpassword= pair of arguments. This +option can be specified multiple times +.HP +\fB\-rpcbind=\fR[:port] +.IP +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 \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 +\fB\-rpccookiefile=\fR +.IP +Location of the auth cookie. Relative paths will be prefixed by a +net\-specific datadir location. (default: data dir) +.HP +\fB\-rpccookieperms=\fR +.IP +Set permissions on the RPC auth cookie file so that it is readable by +[owner|group|all] (default: owner [via umask 0077]) +.HP +\fB\-rpcpassword=\fR +.IP +Password for JSON\-RPC connections +.HP +\fB\-rpcport=\fR +.IP +Listen for JSON\-RPC connections on (default: 7041, testnet3: +18332, testnet4: 48332, signet: 38332, regtest: 18443) +.HP +\fB\-rpcthreads=\fR +.IP +Set the number of threads to service RPC calls (default: 16) +.HP +\fB\-rpcuser=\fR +.IP +Username for JSON\-RPC connections +.HP +\fB\-rpcwhitelist=\fR +.IP +Set a whitelist to filter incoming RPC calls for a specific user. The +field comes in the format: :,,...,. If multiple whitelists are set for a given user, +they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation +for information on default whitelist behavior. +.HP +\fB\-rpcwhitelistdefault\fR +.IP +Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault +is set to 0, if any \fB\-rpcwhitelist\fR is set, the rpc server acts as +if all rpc users are subject to empty\-unless\-otherwise\-specified +whitelists. If rpcwhitelistdefault is set to 1 and no +\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are +subject to empty whitelists. +.HP +\fB\-server\fR +.IP +Accept command line and JSON\-RPC commands +.PP +UI Options: +.HP +\fB\-choosedatadir\fR +.IP +Choose data directory on startup (default: 0) +.HP +\fB\-lang=\fR +.IP +Set language, for example "de_DE" (default: system locale) +.HP +\fB\-min\fR +.IP +Start minimized +.HP +\fB\-resetguisettings\fR +.IP +Reset all settings changed in the GUI +.HP +\fB\-splash\fR +.IP +Show splash screen on startup (default: 1) +.PP +Elements Options: +.HP +\fB\-acceptunlimitedissuances\fR +.IP +Allow unblinded issuance amounts to exceed 21 million units +.HP +\fB\-assetdir\fR +.IP +Entries of pet names of assets, in this format:asset=: