You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
493 lines
12 KiB
493 lines
12 KiB
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
|
|
.TH BITCOIND "1" "September 2016" "bitcoind v0.13.0.0" "User Commands"
|
|
.SH NAME
|
|
bitcoind \- manual page for bitcoind v0.13.0.0
|
|
.SH DESCRIPTION
|
|
Bitcoin Core Daemon version v0.13.0.0
|
|
.SS "Usage:"
|
|
.TP
|
|
bitcoind [options]
|
|
Start Bitcoin Core Daemon
|
|
.SH OPTIONS
|
|
.HP
|
|
\-?
|
|
.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\-checkblocks=\fR<n>
|
|
.IP
|
|
How many blocks to check at startup (default: 288, 0 = all)
|
|
.HP
|
|
\fB\-checklevel=\fR<n>
|
|
.IP
|
|
How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3)
|
|
.HP
|
|
\fB\-conf=\fR<file>
|
|
.IP
|
|
Specify configuration file (default: bitcoin.conf)
|
|
.HP
|
|
\fB\-daemon\fR
|
|
.IP
|
|
Run in the background as a daemon and accept commands
|
|
.HP
|
|
\fB\-datadir=\fR<dir>
|
|
.IP
|
|
Specify data directory
|
|
.HP
|
|
\fB\-dbcache=\fR<n>
|
|
.IP
|
|
Set database cache size in megabytes (4 to 16384, default: 300)
|
|
.HP
|
|
\fB\-loadblock=\fR<file>
|
|
.IP
|
|
Imports blocks from external blk000??.dat file on startup
|
|
.HP
|
|
\fB\-maxorphantx=\fR<n>
|
|
.IP
|
|
Keep at most <n> unconnectable transactions in memory (default: 100)
|
|
.HP
|
|
\fB\-maxmempool=\fR<n>
|
|
.IP
|
|
Keep the transaction memory pool below <n> megabytes (default: 300)
|
|
.HP
|
|
\fB\-mempoolexpiry=\fR<n>
|
|
.IP
|
|
Do not keep transactions in the mempool longer than <n> hours (default:
|
|
72)
|
|
.HP
|
|
\fB\-par=\fR<n>
|
|
.IP
|
|
Set the number of script verification threads (\fB\-4\fR to 16, 0 = auto, <0 =
|
|
leave that many cores free, default: 0)
|
|
.HP
|
|
\fB\-pid=\fR<file>
|
|
.IP
|
|
Specify pid file (default: bitcoind.pid)
|
|
.HP
|
|
\fB\-prune=\fR<n>
|
|
.IP
|
|
Reduce storage requirements by pruning (deleting) old blocks. This mode
|
|
is incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting
|
|
this setting requires re\-downloading the entire blockchain.
|
|
(default: 0 = disable pruning blocks, >550 = target size in MiB
|
|
to use for block files)
|
|
.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\-sysperms\fR
|
|
.IP
|
|
Create new files with system default permissions, instead of umask 077
|
|
(only effective with disabled wallet functionality)
|
|
.HP
|
|
\fB\-txindex\fR
|
|
.IP
|
|
Maintain a full transaction index, used by the getrawtransaction rpc
|
|
call (default: 0)
|
|
.PP
|
|
Connection options:
|
|
.HP
|
|
\fB\-addnode=\fR<ip>
|
|
.IP
|
|
Add a node to connect to and attempt to keep the connection open
|
|
.HP
|
|
\fB\-banscore=\fR<n>
|
|
.IP
|
|
Threshold for disconnecting misbehaving peers (default: 100)
|
|
.HP
|
|
\fB\-bantime=\fR<n>
|
|
.IP
|
|
Number of seconds to keep misbehaving peers from reconnecting (default:
|
|
86400)
|
|
.HP
|
|
\fB\-bind=\fR<addr>
|
|
.IP
|
|
Bind to given address and always listen on it. Use [host]:port notation
|
|
for IPv6
|
|
.HP
|
|
\fB\-connect=\fR<ip>
|
|
.IP
|
|
Connect only to the specified node(s)
|
|
.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)
|
|
.HP
|
|
\fB\-externalip=\fR<ip>
|
|
.IP
|
|
Specify your own public address
|
|
.HP
|
|
\fB\-forcednsseed\fR
|
|
.IP
|
|
Always query for peer addresses via DNS lookup (default: 0)
|
|
.HP
|
|
\fB\-listen\fR
|
|
.IP
|
|
Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
|
|
.HP
|
|
\fB\-listenonion\fR
|
|
.IP
|
|
Automatically create Tor hidden service (default: 1)
|
|
.HP
|
|
\fB\-maxconnections=\fR<n>
|
|
.IP
|
|
Maintain at most <n> connections to peers (default: 125)
|
|
.HP
|
|
\fB\-maxreceivebuffer=\fR<n>
|
|
.IP
|
|
Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
|
|
.HP
|
|
\fB\-maxsendbuffer=\fR<n>
|
|
.IP
|
|
Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
|
|
.HP
|
|
\fB\-maxtimeadjustment\fR
|
|
.IP
|
|
Maximum allowed median peer time offset adjustment. Local perspective of
|
|
time may be influenced by peers forward or backward by this
|
|
amount. (default: 4200 seconds)
|
|
.HP
|
|
\fB\-onion=\fR<ip:port>
|
|
.IP
|
|
Use separate SOCKS5 proxy to reach peers via Tor hidden services
|
|
(default: \fB\-proxy\fR)
|
|
.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)
|
|
.HP
|
|
\fB\-peerbloomfilters\fR
|
|
.IP
|
|
Support filtering of blocks and transaction with bloom filters (default:
|
|
1)
|
|
.HP
|
|
\fB\-port=\fR<port>
|
|
.IP
|
|
Listen for connections on <port> (default: 8333 or testnet: 18333)
|
|
.HP
|
|
\fB\-proxy=\fR<ip:port>
|
|
.IP
|
|
Connect through SOCKS5 proxy
|
|
.HP
|
|
\fB\-proxyrandomize\fR
|
|
.IP
|
|
Randomize credentials for every proxy connection. This enables Tor
|
|
stream isolation (default: 1)
|
|
.HP
|
|
\fB\-seednode=\fR<ip>
|
|
.IP
|
|
Connect to a node to retrieve peer addresses, and disconnect
|
|
.HP
|
|
\fB\-timeout=\fR<n>
|
|
.IP
|
|
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
|
|
.HP
|
|
\fB\-torcontrol=\fR<ip>:<port>
|
|
.IP
|
|
Tor control port to use if onion listening enabled (default:
|
|
127.0.0.1:9051)
|
|
.HP
|
|
\fB\-torpassword=\fR<pass>
|
|
.IP
|
|
Tor control port password (default: empty)
|
|
.HP
|
|
\fB\-whitebind=\fR<addr>
|
|
.IP
|
|
Bind to given address and whitelist peers connecting to it. Use
|
|
[host]:port notation for IPv6
|
|
.HP
|
|
\fB\-whitelist=\fR<netmask>
|
|
.IP
|
|
Whitelist peers connecting from the given netmask or IP address. 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\-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 they violate
|
|
local relay policy (default: 1)
|
|
.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
|
|
\fB\-disablewallet\fR
|
|
.IP
|
|
Do not load the wallet and disable wallet RPC calls
|
|
.HP
|
|
\fB\-keypool=\fR<n>
|
|
.IP
|
|
Set key pool size to <n> (default: 100)
|
|
.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\-mintxfee=\fR<amt>
|
|
.IP
|
|
Fees (in BTC/kB) smaller than this are considered zero fee for
|
|
transaction creation (default: 0.00001)
|
|
.HP
|
|
\fB\-paytxfee=\fR<amt>
|
|
.IP
|
|
Fee (in BTC/kB) to add to transactions you send (default: 0.00)
|
|
.HP
|
|
\fB\-rescan\fR
|
|
.IP
|
|
Rescan the block chain for missing wallet transactions on startup
|
|
.HP
|
|
\fB\-salvagewallet\fR
|
|
.IP
|
|
Attempt to recover private keys from a corrupt wallet on startup
|
|
.HP
|
|
\fB\-spendzeroconfchange\fR
|
|
.IP
|
|
Spend unconfirmed change when sending transactions (default: 1)
|
|
.HP
|
|
\fB\-txconfirmtarget=\fR<n>
|
|
.IP
|
|
If paytxfee is not set, include enough fee so transactions begin
|
|
confirmation on average within n blocks (default: 2)
|
|
.HP
|
|
\fB\-usehd\fR
|
|
.IP
|
|
Use hierarchical deterministic key generation (HD) after BIP32. Only has
|
|
effect during wallet creation/first start (default: 1)
|
|
.HP
|
|
\fB\-upgradewallet\fR
|
|
.IP
|
|
Upgrade wallet to latest format on startup
|
|
.HP
|
|
\fB\-wallet=\fR<file>
|
|
.IP
|
|
Specify wallet file (within data directory) (default: wallet.dat)
|
|
.HP
|
|
\fB\-walletbroadcast\fR
|
|
.IP
|
|
Make the wallet broadcast transactions (default: 1)
|
|
.HP
|
|
\fB\-walletnotify=\fR<cmd>
|
|
.IP
|
|
Execute command when a wallet transaction changes (%s in cmd is replaced
|
|
by TxID)
|
|
.HP
|
|
\fB\-zapwallettxes=\fR<mode>
|
|
.IP
|
|
Delete all wallet transactions and only recover those parts of the
|
|
blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g.
|
|
account owner and payment request information, 2 = drop tx meta
|
|
data)
|
|
.PP
|
|
ZeroMQ notification options:
|
|
.HP
|
|
\fB\-zmqpubhashblock=\fR<address>
|
|
.IP
|
|
Enable publish hash block in <address>
|
|
.HP
|
|
\fB\-zmqpubhashtx=\fR<address>
|
|
.IP
|
|
Enable publish hash transaction in <address>
|
|
.HP
|
|
\fB\-zmqpubrawblock=\fR<address>
|
|
.IP
|
|
Enable publish raw block in <address>
|
|
.HP
|
|
\fB\-zmqpubrawtx=\fR<address>
|
|
.IP
|
|
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
|
|
optional). If <category> is not supplied or if <category> = 1,
|
|
output all debugging information.<category> can be: addrman,
|
|
alert, bench, coindb, db, http, libevent, lock, mempool,
|
|
mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins,
|
|
tor, zmq.
|
|
.HP
|
|
\fB\-help\-debug\fR
|
|
.IP
|
|
Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR)
|
|
.HP
|
|
\fB\-logips\fR
|
|
.IP
|
|
Include IP addresses in debug output (default: 0)
|
|
.HP
|
|
\fB\-logtimestamps\fR
|
|
.IP
|
|
Prepend debug output with timestamp (default: 1)
|
|
.HP
|
|
\fB\-minrelaytxfee=\fR<amt>
|
|
.IP
|
|
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
|
|
mining and transaction creation (default: 0.00001)
|
|
.HP
|
|
\fB\-maxtxfee=\fR<amt>
|
|
.IP
|
|
Maximum total fees (in BTC) to use in a single wallet transaction or raw
|
|
transaction; setting this too low may abort large transactions
|
|
(default: 0.10)
|
|
.HP
|
|
\fB\-printtoconsole\fR
|
|
.IP
|
|
Send trace/debug info to console instead of debug.log file
|
|
.HP
|
|
\fB\-shrinkdebugfile\fR
|
|
.IP
|
|
Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR)
|
|
.PP
|
|
Chain selection options:
|
|
.HP
|
|
\fB\-testnet\fR
|
|
.IP
|
|
Use the test chain
|
|
.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
|
|
Maximum size of data in data carrier transactions we relay and mine
|
|
(default: 83)
|
|
.HP
|
|
\fB\-mempoolreplacement\fR
|
|
.IP
|
|
Enable transaction replacement in the memory pool (default: 1)
|
|
.PP
|
|
Block creation options:
|
|
.HP
|
|
\fB\-blockmaxweight=\fR<n>
|
|
.IP
|
|
Set maximum BIP141 block weight (default: 3000000)
|
|
.HP
|
|
\fB\-blockmaxsize=\fR<n>
|
|
.IP
|
|
Set maximum block size in bytes (default: 750000)
|
|
.HP
|
|
\fB\-blockprioritysize=\fR<n>
|
|
.IP
|
|
Set maximum size of high\-priority/low\-fee transactions in bytes
|
|
(default: 0)
|
|
.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\-rpcbind=\fR<addr>
|
|
.IP
|
|
Bind to given address to listen for JSON\-RPC connections. Use
|
|
[host]:port notation for IPv6. This option can be specified
|
|
multiple times (default: bind to all interfaces)
|
|
.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
|
|
.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. 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\-rpcthreads=\fR<n>
|
|
.IP
|
|
Set the number of threads to service RPC calls (default: 4)
|
|
.SH COPYRIGHT
|
|
Copyright (C) 2009-2016 The Bitcoin Core developers
|
|
|
|
Please contribute if you find Bitcoin Core useful. Visit
|
|
<https://bitcoincore.org> for further information about the software.
|
|
The source code is available from <https://github.com/bitcoin/bitcoin>.
|
|
|
|
This is experimental software.
|
|
Distributed under the MIT software license, see the accompanying file COPYING
|
|
or <http://www.opensource.org/licenses/mit-license.php>.
|
|
|
|
This product includes software developed by the OpenSSL Project for use in the
|
|
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
|
|
by Eric Young and UPnP software written by Thomas Bernard.
|