From 2b6a2f4a28792f2fe9dc1be843b1ff1ecae35e8a Mon Sep 17 00:00:00 2001 From: DrahtBot <39886733+DrahtBot@users.noreply.github.com> Date: Thu, 26 Jul 2018 18:39:42 -0400 Subject: [PATCH] Regenerate manpages --- doc/man/bitcoin-cli.1 | 77 ++++++------- doc/man/bitcoin-qt.1 | 250 ++++++++++++++++++++++++------------------ doc/man/bitcoin-tx.1 | 44 ++++---- doc/man/bitcoind.1 | 238 +++++++++++++++++++++++----------------- 4 files changed, 337 insertions(+), 272 deletions(-) diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index 168a68cb3..bf24d929b 100644 --- a/doc/man/bitcoin-cli.1 +++ b/doc/man/bitcoin-cli.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. -.TH BITCOIN-CLI "1" "January 2018" "bitcoin-cli v0.16.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH BITCOIN-CLI "1" "July 2018" "bitcoin-cli v0.16.99.0" "User Commands" .SH NAME bitcoin-cli \- manual page for bitcoin-cli v0.16.99.0 .SH DESCRIPTION @@ -20,7 +20,8 @@ This help message .HP \fB\-conf=\fR .IP -Specify configuration file (default: bitcoin.conf) +Specify configuration file. Relative paths will be prefixed by datadir +location. (default: bitcoin.conf) .HP \fB\-datadir=\fR .IP @@ -33,47 +34,52 @@ server\-side RPC calls, the results of \fB\-getinfo\fR is the result of multiple non\-atomic requests. Some entries in the result may represent results from different states (e.g. wallet balance may be as of a different block from the chain state reported) -.PP -Chain selection options: -.HP -\fB\-testnet\fR -.IP -Use the test chain -.HP -\fB\-regtest\fR -.IP -Enter regression test mode, which uses a special chain in which blocks -can be solved instantly. This is intended for regression testing -tools and app development. .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\-rpcport=\fR +\fB\-rpccookiefile=\fR .IP -Connect to JSON\-RPC on (default: 8332 or testnet: 18332) -.HP -\fB\-rpcwait\fR -.IP -Wait for RPC server to start -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections +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\-rpcclienttimeout=\fR +\fB\-rpcport=\fR .IP -Timeout in seconds during HTTP requests, or 0 for no timeout. (default: -900) +Connect to JSON\-RPC on (default: 8332 or testnet: 18332) +.HP +\fB\-rpcuser=\fR +.IP +Username for JSON\-RPC connections +.HP +\fB\-rpcwait\fR +.IP +Wait for RPC server to start +.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) +.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 .TP @@ -83,18 +89,15 @@ When combined with \fB\-stdin\fR, the first line from standard input is used for the RPC password. .HP -\fB\-stdin\fR +\fB\-version\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. +Print version and exit +.PP +Chain selection options: .HP -\fB\-rpcwallet=\fR +\fB\-testnet\fR .IP -Send RPC for non\-default wallet on RPC server (argument is wallet -filename in bitcoind directory, required if bitcoind/\-Qt runs -with multiple wallets) +Use the test chain .SH COPYRIGHT Copyright (C) 2009-2018 The Bitcoin Core developers diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 index a8c55fb0b..3a18c9f49 100644 --- a/doc/man/bitcoin-qt.1 +++ b/doc/man/bitcoin-qt.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. -.TH BITCOIN-QT "1" "January 2018" "bitcoin-qt v0.16.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH BITCOIN-QT "1" "July 2018" "bitcoin-qt v0.16.99.0" "User Commands" .SH NAME bitcoin-qt \- manual page for bitcoin-qt v0.16.99.0 .SH DESCRIPTION @@ -13,20 +13,11 @@ bitcoin\-qt [command\-line options] .IP Print this help message and exit .HP -\fB\-version\fR -.IP -Print version and exit -.HP \fB\-alertnotify=\fR .IP Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message) .HP -\fB\-blocknotify=\fR -.IP -Execute command when the best block changes (%s in cmd is replaced by -block hash) -.HP \fB\-assumevalid=\fR .IP If this block is in the chain assume that it and its ancestors are valid @@ -36,9 +27,28 @@ default: testnet: 0000000002e9e7b00e1f6dc5123a04aad68dd0f0968d8c7aa45f6640795c37b1) .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 blocks directory (default: /blocks) +.HP \fB\-conf=\fR .IP -Specify configuration file (default: bitcoin.conf) +Specify configuration file. Relative paths will be prefixed by datadir +location. (default: bitcoin.conf) +.HP +\fB\-daemon\fR +.IP +Run in the background as a daemon and accept commands .HP \fB\-datadir=\fR .IP @@ -48,45 +58,46 @@ Specify data directory .IP Set database cache size in megabytes (4 to 16384, default: 450) .HP +\fB\-debuglogfile=\fR +.IP +Specify location of debug log file. Relative paths will be prefixed by a +net\-specific datadir location. (0 to disable; default: debug.log) +.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 blk000??.dat file on startup .HP -\fB\-debuglogfile=\fR +\fB\-maxmempool=\fR .IP -Specify location of debug log file: this can be an absolute path or a -path relative to the data directory (default: debug.log) +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\-maxmempool=\fR -.IP -Keep the transaction memory pool below megabytes (default: 300) -.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 (\fB\-8\fR to 16, 0 = auto, <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\-blockreconstructionextratxn=\fR -.IP -Extra transactions to keep in memory for compact block reconstructions -(default: 100) -.HP -\fB\-par=\fR -.IP -Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 = -leave that many cores free, default: 0) -.HP \fB\-pid=\fR .IP -Specify pid file (default: bitcoind.pid) +Specify pid file. Relative paths will be prefixed by a net\-specific +datadir location. (default: bitcoind.pid) .HP \fB\-prune=\fR .IP @@ -100,14 +111,14 @@ setting requires re\-downloading the entire blockchain. (default: >550 = automatically prune block files to stay under the specified target size in MiB) .HP -\fB\-reindex\-chainstate\fR -.IP -Rebuild chain state from the currently indexed blocks -.HP \fB\-reindex\fR .IP Rebuild chain state and block index from the blk*.dat files on disk .HP +\fB\-reindex\-chainstate\fR +.IP +Rebuild chain state from the currently indexed blocks +.HP \fB\-sysperms\fR .IP Create new files with system default permissions, instead of umask 077 @@ -117,13 +128,18 @@ Create new files with system default permissions, instead of umask 077 .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 command help for more info) +the `addnode` RPC command help for more info). This option can be +specified multiple times to add multiple nodes. .HP \fB\-banscore=\fR .IP @@ -141,9 +157,10 @@ for IPv6 .HP \fB\-connect=\fR .IP -Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic +Connect only to the specified node; \fB\-connect\fR=\fI\,0\/\fR disables automatic connections (the rules for this peer are the same as for -\fB\-addnode\fR) +\fB\-addnode\fR). This option can be specified multiple times to connect +to multiple nodes. .HP \fB\-discover\fR .IP @@ -159,6 +176,10 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless \fB\-connect\fR used) .HP +\fB\-enablebip61\fR +.IP +Send reject messages per BIP61 (default: 1) +.HP \fB\-externalip=\fR .IP Specify your own public address @@ -193,6 +214,11 @@ Maximum allowed median peer time offset adjustment. Local perspective of time may be influenced by peers forward or backward by this amount. (default: 4200 seconds) .HP +\fB\-maxuploadtarget=\fR +.IP +Tries to keep outbound traffic under the given target (in MiB per 24h), +0 = no limit (default: 0) +.HP \fB\-onion=\fR .IP Use separate SOCKS5 proxy to reach peers via Tor hidden services @@ -200,17 +226,20 @@ Use separate SOCKS5 proxy to reach peers via Tor hidden services .HP \fB\-onlynet=\fR .IP -Only connect to nodes in network (ipv4, ipv6 or onion) -.HP -\fB\-permitbaremultisig\fR -.IP -Relay non\-P2SH multisig (default: 1) +Make outgoing connections only through network (ipv4, ipv6 or +onion). Incoming connections are not affected by this option. +This option can be specified multiple times to allow multiple +networks. .HP \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: 1) .HP +\fB\-permitbaremultisig\fR +.IP +Relay non\-P2SH multisig (default: 1) +.HP \fB\-port=\fR .IP Listen for connections on (default: 8333 or testnet: 18333) @@ -226,7 +255,9 @@ stream isolation (default: 1) .HP \fB\-seednode=\fR .IP -Connect to a node to retrieve peer addresses, and disconnect +Connect to a node to retrieve peer addresses, and disconnect. This +option can be specified multiple times to connect to multiple +nodes. .HP \fB\-timeout=\fR .IP @@ -257,11 +288,6 @@ CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple times. Whitelisted peers cannot be DoS banned and their transactions are always relayed, even if they are already in the mempool, useful e.g. for a gateway -.HP -\fB\-maxuploadtarget=\fR -.IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) .PP Wallet options: .HP @@ -270,6 +296,14 @@ Wallet options: What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", default: "p2sh\-segwit") .HP +\fB\-avoidpartialspends\fR +.IP +Group outputs by address, selecting all or none, instead of selecting on +a per\-output basis. Privacy is improved as an address is only +used once (unless someone sends to it after spending from it), +but may result in slightly higher fees as suboptimal coin +selection may result due to the added limitation (default: 0) +.HP \fB\-changetype\fR .IP What type of change to use ("legacy", "p2sh\-segwit", or "bech32"). @@ -281,15 +315,6 @@ sending to a native segwit address) .IP Do not load the wallet and disable wallet RPC calls .HP -\fB\-keypool=\fR -.IP -Set key pool size to (default: 1000) -.HP -\fB\-fallbackfee=\fR -.IP -A fee rate (in BTC/kB) that will be used when fee estimation has -insufficient data (default: 0.0002) -.HP \fB\-discardfee=\fR .IP The fee rate (in BTC/kB) that indicates your tolerance for discarding @@ -298,6 +323,15 @@ 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/kB) that will be used when fee estimation has +insufficient data (default: 0.0002) +.HP +\fB\-keypool=\fR +.IP +Set key pool size to (default: 1000) +.HP \fB\-mintxfee=\fR .IP Fees (in BTC/kB) smaller than this are considered zero fee for @@ -324,17 +358,18 @@ Spend unconfirmed change when sending transactions (default: 1) If paytxfee is not set, include enough fee so transactions begin confirmation on average within n blocks (default: 6) .HP -\fB\-walletrbf\fR -.IP -Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) -.HP \fB\-upgradewallet\fR .IP Upgrade wallet to latest format on startup .HP -\fB\-wallet=\fR +\fB\-wallet=\fR .IP -Specify wallet file (within data directory) (default: wallet.dat) +Specify wallet database path. Can be specified multiple times to load +multiple wallets. Path is interpreted relative to if +it is not absolute, and will be created if it does not exist (as +a directory containing a wallet.dat file and log files). For +backwards compatibility this will also accept names of existing +data files in .) .HP \fB\-walletbroadcast\fR .IP @@ -350,6 +385,10 @@ exists, otherwise ) Execute command when a wallet transaction changes (%s in cmd is replaced by TxID) .HP +\fB\-walletrbf\fR +.IP +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) +.HP \fB\-zapwallettxes=\fR .IP Delete all wallet transactions and only recover those parts of the @@ -377,10 +416,6 @@ Enable publish raw transaction in
.PP Debugging/Testing options: .HP -\fB\-uacomment=\fR -.IP -Append comment to the user agent string -.HP \fB\-debug=\fR .IP Output debugging information (default: 0, supplying is @@ -416,11 +451,16 @@ transaction; setting this too low may abort large transactions .HP \fB\-printtoconsole\fR .IP -Send trace/debug info to console instead of debug.log file +Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable +logging to file, set debuglogfile=0) .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 @@ -453,15 +493,15 @@ Enable transaction replacement in the memory pool (default: 1) Fees (in BTC/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: 0.00001) .HP -\fB\-whitelistrelay\fR -.IP -Accept relayed transactions received from whitelisted peers even when -not relaying transactions (default: 1) -.HP \fB\-whitelistforcerelay\fR .IP Force relay of transactions from whitelisted peers even if they violate local relay policy (default: 1) +.HP +\fB\-whitelistrelay\fR +.IP +Accept relayed transactions received from whitelisted peers even when +not relaying transactions (default: 1) .PP Block creation options: .HP @@ -469,11 +509,6 @@ Block creation options: .IP Set maximum BIP141 block weight (default: 3996000) .HP -\fB\-blockmaxsize=\fR -.IP -Set maximum BIP141 block weight to this * 4. Deprecated, use -blockmaxweight -.HP \fB\-blockmintxfee=\fR .IP Set lowest fee rate (in BTC/kB) for transactions to be included in block @@ -481,14 +516,26 @@ creation. (default: 0.00001) .PP RPC server options: .HP -\fB\-server\fR -.IP -Accept command line and JSON\-RPC commands -.HP \fB\-rest\fR .IP Accept public REST requests (default: 0) .HP +\fB\-rpcallowip=\fR +.IP +Allow JSON\-RPC connections from specified source. Valid for are a +single IP (e.g. 1.2.3.4), a network/netmask (e.g. +1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This +option can be specified multiple times +.HP +\fB\-rpcauth=\fR +.IP +Username and 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. This option is @@ -500,37 +547,18 @@ option can be specified multiple times (default: 127.0.0.1 and .HP \fB\-rpccookiefile=\fR .IP -Location of the auth cookie (default: data dir) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections +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\-rpcauth=\fR -.IP -Username and hashed password for JSON\-RPC connections. The field - comes in the format: :$. A -canonical python script is included in share/rpcuser. The client -then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times -.HP \fB\-rpcport=\fR .IP Listen for JSON\-RPC connections on (default: 8332 or testnet: 18332) .HP -\fB\-rpcallowip=\fR -.IP -Allow JSON\-RPC connections from specified source. Valid for are a -single IP (e.g. 1.2.3.4), a network/netmask (e.g. -1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This -option can be specified multiple times -.HP \fB\-rpcserialversion\fR .IP Sets the serialization of raw transaction or block hex returned in @@ -539,6 +567,14 @@ non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1) \fB\-rpcthreads=\fR .IP Set the number of threads to service RPC calls (default: 4) +.HP +\fB\-rpcuser=\fR +.IP +Username for JSON\-RPC connections +.HP +\fB\-server\fR +.IP +Accept command line and JSON\-RPC commands .PP UI Options: .HP @@ -554,6 +590,10 @@ Set language, for example "de_DE" (default: system locale) .IP Start minimized .HP +\fB\-resetguisettings\fR +.IP +Reset all settings changed in the GUI +.HP \fB\-rootcertificates=\fR .IP Set SSL root certificates for payment request (default: \fB\-system\-\fR) @@ -561,10 +601,6 @@ Set SSL root certificates for payment request (default: \fB\-system\-\fR) \fB\-splash\fR .IP Show splash screen on startup (default: 1) -.HP -\fB\-resetguisettings\fR -.IP -Reset all settings changed in the GUI .SH COPYRIGHT Copyright (C) 2009-2018 The Bitcoin Core developers diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 index 8e6994ac0..e1b81bad6 100644 --- a/doc/man/bitcoin-tx.1 +++ b/doc/man/bitcoin-tx.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. -.TH BITCOIN-TX "1" "January 2018" "bitcoin-tx v0.16.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH BITCOIN-TX "1" "July 2018" "bitcoin-tx v0.16.99.0" "User Commands" .SH NAME bitcoin-tx \- manual page for bitcoin-tx v0.16.99.0 .SH DESCRIPTION @@ -34,12 +34,6 @@ Chain selection options: \fB\-testnet\fR .IP Use the test chain -.HP -\fB\-regtest\fR -.IP -Enter regression test mode, which uses a special chain in which blocks -can be solved instantly. This is intended for regression testing -tools and app development. .PP Commands: .IP @@ -63,31 +57,14 @@ nversion=N .IP Set TX version to N .IP -replaceable(=N) -.IP -Set RBF opt\-in sequence number for input N (if not provided, opt\-in all -available inputs) -.IP outaddr=VALUE:ADDRESS .IP Add address\-based output to TX .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 outdata=[VALUE:]DATA .IP Add data\-based output to TX .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 outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS] .IP Add Pay To n\-of\-m Multi\-sig output to TX. n = REQUIRED, m = PUBKEYS. @@ -95,6 +72,23 @@ 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 +Set RBF opt\-in sequence number for input N (if not provided, opt\-in all +available inputs) +.IP sign=SIGHASH\-FLAGS .IP Add zero or more signatures to transaction. This command requires JSON diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index 8728965b2..d0ba131cd 100644 --- a/doc/man/bitcoind.1 +++ b/doc/man/bitcoind.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. -.TH BITCOIND "1" "January 2018" "bitcoind v0.16.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH BITCOIND "1" "July 2018" "bitcoind v0.16.99.0" "User Commands" .SH NAME bitcoind \- manual page for bitcoind v0.16.99.0 .SH DESCRIPTION @@ -14,20 +14,11 @@ Start Bitcoin Core Daemon .IP Print this help message and exit .HP -\fB\-version\fR -.IP -Print version and exit -.HP \fB\-alertnotify=\fR .IP Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message) .HP -\fB\-blocknotify=\fR -.IP -Execute command when the best block changes (%s in cmd is replaced by -block hash) -.HP \fB\-assumevalid=\fR .IP If this block is in the chain assume that it and its ancestors are valid @@ -37,9 +28,24 @@ default: testnet: 0000000002e9e7b00e1f6dc5123a04aad68dd0f0968d8c7aa45f6640795c37b1) .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 blocks directory (default: /blocks) +.HP \fB\-conf=\fR .IP -Specify configuration file (default: bitcoin.conf) +Specify configuration file. Relative paths will be prefixed by datadir +location. (default: bitcoin.conf) .HP \fB\-daemon\fR .IP @@ -53,45 +59,46 @@ Specify data directory .IP Set database cache size in megabytes (4 to 16384, default: 450) .HP +\fB\-debuglogfile=\fR +.IP +Specify location of debug log file. Relative paths will be prefixed by a +net\-specific datadir location. (0 to disable; default: debug.log) +.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 blk000??.dat file on startup .HP -\fB\-debuglogfile=\fR +\fB\-maxmempool=\fR .IP -Specify location of debug log file: this can be an absolute path or a -path relative to the data directory (default: debug.log) +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\-maxmempool=\fR -.IP -Keep the transaction memory pool below megabytes (default: 300) -.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 (\fB\-8\fR to 16, 0 = auto, <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\-blockreconstructionextratxn=\fR -.IP -Extra transactions to keep in memory for compact block reconstructions -(default: 100) -.HP -\fB\-par=\fR -.IP -Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 = -leave that many cores free, default: 0) -.HP \fB\-pid=\fR .IP -Specify pid file (default: bitcoind.pid) +Specify pid file. Relative paths will be prefixed by a net\-specific +datadir location. (default: bitcoind.pid) .HP \fB\-prune=\fR .IP @@ -105,14 +112,14 @@ setting requires re\-downloading the entire blockchain. (default: >550 = automatically prune block files to stay under the specified target size in MiB) .HP -\fB\-reindex\-chainstate\fR -.IP -Rebuild chain state from the currently indexed blocks -.HP \fB\-reindex\fR .IP Rebuild chain state and block index from the blk*.dat files on disk .HP +\fB\-reindex\-chainstate\fR +.IP +Rebuild chain state from the currently indexed blocks +.HP \fB\-sysperms\fR .IP Create new files with system default permissions, instead of umask 077 @@ -122,13 +129,18 @@ Create new files with system default permissions, instead of umask 077 .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 command help for more info) +the `addnode` RPC command help for more info). This option can be +specified multiple times to add multiple nodes. .HP \fB\-banscore=\fR .IP @@ -146,9 +158,10 @@ for IPv6 .HP \fB\-connect=\fR .IP -Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic +Connect only to the specified node; \fB\-connect\fR=\fI\,0\/\fR disables automatic connections (the rules for this peer are the same as for -\fB\-addnode\fR) +\fB\-addnode\fR). This option can be specified multiple times to connect +to multiple nodes. .HP \fB\-discover\fR .IP @@ -164,6 +177,10 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless \fB\-connect\fR used) .HP +\fB\-enablebip61\fR +.IP +Send reject messages per BIP61 (default: 1) +.HP \fB\-externalip=\fR .IP Specify your own public address @@ -198,6 +215,11 @@ Maximum allowed median peer time offset adjustment. Local perspective of time may be influenced by peers forward or backward by this amount. (default: 4200 seconds) .HP +\fB\-maxuploadtarget=\fR +.IP +Tries to keep outbound traffic under the given target (in MiB per 24h), +0 = no limit (default: 0) +.HP \fB\-onion=\fR .IP Use separate SOCKS5 proxy to reach peers via Tor hidden services @@ -205,17 +227,20 @@ Use separate SOCKS5 proxy to reach peers via Tor hidden services .HP \fB\-onlynet=\fR .IP -Only connect to nodes in network (ipv4, ipv6 or onion) -.HP -\fB\-permitbaremultisig\fR -.IP -Relay non\-P2SH multisig (default: 1) +Make outgoing connections only through network (ipv4, ipv6 or +onion). Incoming connections are not affected by this option. +This option can be specified multiple times to allow multiple +networks. .HP \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: 1) .HP +\fB\-permitbaremultisig\fR +.IP +Relay non\-P2SH multisig (default: 1) +.HP \fB\-port=\fR .IP Listen for connections on (default: 8333 or testnet: 18333) @@ -231,7 +256,9 @@ stream isolation (default: 1) .HP \fB\-seednode=\fR .IP -Connect to a node to retrieve peer addresses, and disconnect +Connect to a node to retrieve peer addresses, and disconnect. This +option can be specified multiple times to connect to multiple +nodes. .HP \fB\-timeout=\fR .IP @@ -262,11 +289,6 @@ CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple times. Whitelisted peers cannot be DoS banned and their transactions are always relayed, even if they are already in the mempool, useful e.g. for a gateway -.HP -\fB\-maxuploadtarget=\fR -.IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) .PP Wallet options: .HP @@ -275,6 +297,14 @@ Wallet options: What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", default: "p2sh\-segwit") .HP +\fB\-avoidpartialspends\fR +.IP +Group outputs by address, selecting all or none, instead of selecting on +a per\-output basis. Privacy is improved as an address is only +used once (unless someone sends to it after spending from it), +but may result in slightly higher fees as suboptimal coin +selection may result due to the added limitation (default: 0) +.HP \fB\-changetype\fR .IP What type of change to use ("legacy", "p2sh\-segwit", or "bech32"). @@ -286,15 +316,6 @@ sending to a native segwit address) .IP Do not load the wallet and disable wallet RPC calls .HP -\fB\-keypool=\fR -.IP -Set key pool size to (default: 1000) -.HP -\fB\-fallbackfee=\fR -.IP -A fee rate (in BTC/kB) that will be used when fee estimation has -insufficient data (default: 0.0002) -.HP \fB\-discardfee=\fR .IP The fee rate (in BTC/kB) that indicates your tolerance for discarding @@ -303,6 +324,15 @@ 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/kB) that will be used when fee estimation has +insufficient data (default: 0.0002) +.HP +\fB\-keypool=\fR +.IP +Set key pool size to (default: 1000) +.HP \fB\-mintxfee=\fR .IP Fees (in BTC/kB) smaller than this are considered zero fee for @@ -329,17 +359,18 @@ Spend unconfirmed change when sending transactions (default: 1) If paytxfee is not set, include enough fee so transactions begin confirmation on average within n blocks (default: 6) .HP -\fB\-walletrbf\fR -.IP -Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) -.HP \fB\-upgradewallet\fR .IP Upgrade wallet to latest format on startup .HP -\fB\-wallet=\fR +\fB\-wallet=\fR .IP -Specify wallet file (within data directory) (default: wallet.dat) +Specify wallet database path. Can be specified multiple times to load +multiple wallets. Path is interpreted relative to if +it is not absolute, and will be created if it does not exist (as +a directory containing a wallet.dat file and log files). For +backwards compatibility this will also accept names of existing +data files in .) .HP \fB\-walletbroadcast\fR .IP @@ -355,6 +386,10 @@ exists, otherwise ) Execute command when a wallet transaction changes (%s in cmd is replaced by TxID) .HP +\fB\-walletrbf\fR +.IP +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) +.HP \fB\-zapwallettxes=\fR .IP Delete all wallet transactions and only recover those parts of the @@ -382,10 +417,6 @@ Enable publish raw transaction in
.PP Debugging/Testing options: .HP -\fB\-uacomment=\fR -.IP -Append comment to the user agent string -.HP \fB\-debug=\fR .IP Output debugging information (default: 0, supplying is @@ -421,11 +452,16 @@ transaction; setting this too low may abort large transactions .HP \fB\-printtoconsole\fR .IP -Send trace/debug info to console instead of debug.log file +Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable +logging to file, set debuglogfile=0) .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 @@ -458,15 +494,15 @@ Enable transaction replacement in the memory pool (default: 1) Fees (in BTC/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: 0.00001) .HP -\fB\-whitelistrelay\fR -.IP -Accept relayed transactions received from whitelisted peers even when -not relaying transactions (default: 1) -.HP \fB\-whitelistforcerelay\fR .IP Force relay of transactions from whitelisted peers even if they violate local relay policy (default: 1) +.HP +\fB\-whitelistrelay\fR +.IP +Accept relayed transactions received from whitelisted peers even when +not relaying transactions (default: 1) .PP Block creation options: .HP @@ -474,11 +510,6 @@ Block creation options: .IP Set maximum BIP141 block weight (default: 3996000) .HP -\fB\-blockmaxsize=\fR -.IP -Set maximum BIP141 block weight to this * 4. Deprecated, use -blockmaxweight -.HP \fB\-blockmintxfee=\fR .IP Set lowest fee rate (in BTC/kB) for transactions to be included in block @@ -486,14 +517,26 @@ creation. (default: 0.00001) .PP RPC server options: .HP -\fB\-server\fR -.IP -Accept command line and JSON\-RPC commands -.HP \fB\-rest\fR .IP Accept public REST requests (default: 0) .HP +\fB\-rpcallowip=\fR +.IP +Allow JSON\-RPC connections from specified source. Valid for are a +single IP (e.g. 1.2.3.4), a network/netmask (e.g. +1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This +option can be specified multiple times +.HP +\fB\-rpcauth=\fR +.IP +Username and 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. This option is @@ -505,37 +548,18 @@ option can be specified multiple times (default: 127.0.0.1 and .HP \fB\-rpccookiefile=\fR .IP -Location of the auth cookie (default: data dir) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections +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\-rpcauth=\fR -.IP -Username and hashed password for JSON\-RPC connections. The field - comes in the format: :$. A -canonical python script is included in share/rpcuser. The client -then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times -.HP \fB\-rpcport=\fR .IP Listen for JSON\-RPC connections on (default: 8332 or testnet: 18332) .HP -\fB\-rpcallowip=\fR -.IP -Allow JSON\-RPC connections from specified source. Valid for are a -single IP (e.g. 1.2.3.4), a network/netmask (e.g. -1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This -option can be specified multiple times -.HP \fB\-rpcserialversion\fR .IP Sets the serialization of raw transaction or block hex returned in @@ -544,6 +568,14 @@ non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1) \fB\-rpcthreads=\fR .IP Set the number of threads to service RPC calls (default: 4) +.HP +\fB\-rpcuser=\fR +.IP +Username for JSON\-RPC connections +.HP +\fB\-server\fR +.IP +Accept command line and JSON\-RPC commands .SH COPYRIGHT Copyright (C) 2009-2018 The Bitcoin Core developers