diff options
Diffstat (limited to 'doc/man/bitcoind.1')
| -rw-r--r-- | doc/man/bitcoind.1 | 236 |
1 files changed, 134 insertions, 102 deletions
diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index 8728965b2a..d0ba131cde 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<cmd> .IP Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message) .HP -\fB\-blocknotify=\fR<cmd> -.IP -Execute command when the best block changes (%s in cmd is replaced by -block hash) -.HP \fB\-assumevalid=\fR<hex> .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<cmd> +.IP +Execute command when the best block changes (%s in cmd is replaced by +block hash) +.HP +\fB\-blockreconstructionextratxn=\fR<n> +.IP +Extra transactions to keep in memory for compact block reconstructions +(default: 100) +.HP +\fB\-blocksdir=\fR<dir> +.IP +Specify blocks directory (default: <datadir>/blocks) +.HP \fB\-conf=\fR<file> .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\-loadblock=\fR<file> +\fB\-debuglogfile=\fR<file> .IP -Imports blocks from external blk000??.dat file on startup +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\-debuglogfile=\fR<file> +\fB\-includeconf=\fR<file> .IP -Specify location of debug log file: this can be an absolute path or a -path relative to the data directory (default: debug.log) +Specify additional configuration file, relative to the \fB\-datadir\fR path +(only useable from configuration file, not command line) .HP -\fB\-maxorphantx=\fR<n> +\fB\-loadblock=\fR<file> .IP -Keep at most <n> unconnectable transactions in memory (default: 100) +Imports blocks from external blk000??.dat file on startup .HP \fB\-maxmempool=\fR<n> .IP Keep the transaction memory pool below <n> megabytes (default: 300) .HP +\fB\-maxorphantx=\fR<n> +.IP +Keep at most <n> unconnectable transactions in memory (default: 100) +.HP \fB\-mempoolexpiry=\fR<n> .IP Do not keep transactions in the mempool longer than <n> hours (default: 336) .HP -\fB\-persistmempool\fR -.IP -Whether to save the mempool on shutdown and load on restart (default: 1) -.HP -\fB\-blockreconstructionextratxn=\fR<n> -.IP -Extra transactions to keep in memory for compact block reconstructions -(default: 100) -.HP \fB\-par=\fR<n> .IP -Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 = +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\-pid=\fR<file> .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<n> .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> .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<n> .IP @@ -146,9 +158,10 @@ for IPv6 .HP \fB\-connect=\fR<ip> .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> .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<n> +.IP +Tries to keep outbound traffic under the given target (in MiB per 24h), +0 = no limit (default: 0) +.HP \fB\-onion=\fR<ip:port> .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<net> .IP -Only connect to nodes in network <net> (ipv4, ipv6 or onion) -.HP -\fB\-permitbaremultisig\fR -.IP -Relay non\-P2SH multisig (default: 1) +Make outgoing connections only through network <net> (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<port> .IP Listen for connections on <port> (default: 8333 or testnet: 18333) @@ -231,7 +256,9 @@ stream isolation (default: 1) .HP \fB\-seednode=\fR<ip> .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<n> .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<n> -.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,22 +316,22 @@ sending to a native segwit address) .IP Do not load the wallet and disable wallet RPC calls .HP -\fB\-keypool=\fR<n> +\fB\-discardfee=\fR<amt> .IP -Set key pool size to <n> (default: 1000) +The fee rate (in BTC/kB) 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<amt> .IP A fee rate (in BTC/kB) that will be used when fee estimation has insufficient data (default: 0.0002) .HP -\fB\-discardfee=\fR<amt> +\fB\-keypool=\fR<n> .IP -The fee rate (in BTC/kB) 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 +Set key pool size to <n> (default: 1000) .HP \fB\-mintxfee=\fR<amt> .IP @@ -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<file> +\fB\-wallet=\fR<path> .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 <walletdir> if +it is not absolute, and will be created if it does not exist (as +a directory containing a wallet.dat file and log files). For +backwards compatibility this will also accept names of existing +data files in <walletdir>.) .HP \fB\-walletbroadcast\fR .IP @@ -355,6 +386,10 @@ exists, otherwise <datadir>) 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<mode> .IP Delete all wallet transactions and only recover those parts of the @@ -382,10 +417,6 @@ Enable publish raw transaction in <address> .PP Debugging/Testing options: .HP -\fB\-uacomment=\fR<cmt> -.IP -Append comment to the user agent string -.HP \fB\-debug=\fR<category> .IP Output debugging information (default: 0, supplying <category> 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<cmt> +.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<n> -.IP -Set maximum BIP141 block weight to this * 4. Deprecated, use -blockmaxweight -.HP \fB\-blockmintxfee=\fR<amt> .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> +.IP +Allow JSON\-RPC connections from specified source. Valid for <ip> are a +single IP (e.g. 1.2.3.4), a network/netmask (e.g. +1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This +option can be specified multiple times +.HP +\fB\-rpcauth=\fR<userpw> +.IP +Username and hashed password for JSON\-RPC connections. The field +<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A +canonical python script is included in share/rpcauth. The client +then connects normally using the +rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This +option can be specified multiple times +.HP \fB\-rpcbind=\fR<addr>[: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<loc> .IP -Location of the auth cookie (default: data dir) -.HP -\fB\-rpcuser=\fR<user> -.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<pw> .IP Password for JSON\-RPC connections .HP -\fB\-rpcauth=\fR<userpw> -.IP -Username and hashed password for JSON\-RPC connections. The field -<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A -canonical python script is included in share/rpcuser. The client -then connects normally using the -rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This -option can be specified multiple times -.HP \fB\-rpcport=\fR<port> .IP Listen for JSON\-RPC connections on <port> (default: 8332 or testnet: 18332) .HP -\fB\-rpcallowip=\fR<ip> -.IP -Allow JSON\-RPC connections from specified source. Valid for <ip> are a -single IP (e.g. 1.2.3.4), a network/netmask (e.g. -1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This -option can be specified multiple times -.HP \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<n> .IP Set the number of threads to service RPC calls (default: 4) +.HP +\fB\-rpcuser=\fR<user> +.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 |