| blob | baf747436f82a3ca8d2e10f922a62a4c2b0e1b95 |
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2 .TH BITCOIND "1" "September 2017" "bitcoind v0.15.99.0" "User Commands"
3 .SH NAME
4 bitcoind \- manual page for bitcoind v0.15.99.0
5 .SH DESCRIPTION
6 Bitcoin Core Daemon version v0.15.99.0
7 .SS "Usage:"
8 .TP
9 bitcoind [options]
10 Start Bitcoin Core Daemon
11 .SH OPTIONS
12 .HP
13 \-?
14 .IP
15 Print this help message and exit
16 .HP
17 \fB\-version\fR
18 .IP
19 Print version and exit
20 .HP
21 \fB\-alertnotify=\fR<cmd>
22 .IP
23 Execute command when a relevant alert is received or we see a really
24 long fork (%s in cmd is replaced by message)
25 .HP
26 \fB\-blocknotify=\fR<cmd>
27 .IP
28 Execute command when the best block changes (%s in cmd is replaced by
29 block hash)
30 .HP
31 \fB\-assumevalid=\fR<hex>
32 .IP
33 If this block is in the chain assume that it and its ancestors are valid
34 and potentially skip their script verification (0 to verify all,
35 default:
36 0000000000000000003b9ce759c2a087d52abc4266f8f4ebd6d768b89defa50a,
37 testnet:
38 0000000002e9e7b00e1f6dc5123a04aad68dd0f0968d8c7aa45f6640795c37b1)
39 .HP
40 \fB\-conf=\fR<file>
41 .IP
42 Specify configuration file (default: bitcoin.conf)
43 .HP
44 \fB\-daemon\fR
45 .IP
46 Run in the background as a daemon and accept commands
47 .HP
48 \fB\-datadir=\fR<dir>
49 .IP
50 Specify data directory
51 .HP
52 \fB\-dbcache=\fR<n>
53 .IP
54 Set database cache size in megabytes (4 to 16384, default: 450)
55 .HP
56 \fB\-loadblock=\fR<file>
57 .IP
58 Imports blocks from external blk000??.dat file on startup
59 .HP
60 \fB\-maxorphantx=\fR<n>
61 .IP
62 Keep at most <n> unconnectable transactions in memory (default: 100)
63 .HP
64 \fB\-maxmempool=\fR<n>
65 .IP
66 Keep the transaction memory pool below <n> megabytes (default: 300)
67 .HP
68 \fB\-mempoolexpiry=\fR<n>
69 .IP
70 Do not keep transactions in the mempool longer than <n> hours (default:
71 336)
72 .HP
73 \fB\-persistmempool\fR
74 .IP
75 Whether to save the mempool on shutdown and load on restart (default: 1)
76 .HP
77 \fB\-blockreconstructionextratxn=\fR<n>
78 .IP
79 Extra transactions to keep in memory for compact block reconstructions
80 (default: 100)
81 .HP
82 \fB\-par=\fR<n>
83 .IP
84 Set the number of script verification threads (\fB\-2\fR to 16, 0 = auto, <0 =
85 leave that many cores free, default: 0)
86 .HP
87 \fB\-pid=\fR<file>
88 .IP
89 Specify pid file (default: bitcoind.pid)
90 .HP
91 \fB\-prune=\fR<n>
92 .IP
93 Reduce storage requirements by enabling pruning (deleting) of old
94 blocks. This allows the pruneblockchain RPC to be called to
95 delete specific blocks, and enables automatic pruning of old
96 blocks if a target size in MiB is provided. This mode is
97 incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this
98 setting requires re\-downloading the entire blockchain. (default:
99 0 = disable pruning blocks, 1 = allow manual pruning via RPC,
100 >550 = automatically prune block files to stay under the
101 specified target size in MiB)
102 .HP
103 \fB\-reindex\-chainstate\fR
104 .IP
105 Rebuild chain state from the currently indexed blocks
106 .HP
107 \fB\-reindex\fR
108 .IP
109 Rebuild chain state and block index from the blk*.dat files on disk
110 .HP
111 \fB\-sysperms\fR
112 .IP
113 Create new files with system default permissions, instead of umask 077
114 (only effective with disabled wallet functionality)
115 .HP
116 \fB\-txindex\fR
117 .IP
118 Maintain a full transaction index, used by the getrawtransaction rpc
119 call (default: 0)
120 .PP
121 Connection options:
122 .HP
123 \fB\-addnode=\fR<ip>
124 .IP
125 Add a node to connect to and attempt to keep the connection open
126 .HP
127 \fB\-banscore=\fR<n>
128 .IP
129 Threshold for disconnecting misbehaving peers (default: 100)
130 .HP
131 \fB\-bantime=\fR<n>
132 .IP
133 Number of seconds to keep misbehaving peers from reconnecting (default:
134 86400)
135 .HP
136 \fB\-bind=\fR<addr>
137 .IP
138 Bind to given address and always listen on it. Use [host]:port notation
139 for IPv6
140 .HP
141 \fB\-connect=\fR<ip>
142 .IP
143 Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic
144 connections
145 .HP
146 \fB\-discover\fR
147 .IP
148 Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR
149 or \fB\-proxy\fR)
150 .HP
151 \fB\-dns\fR
152 .IP
153 Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1)
154 .HP
155 \fB\-dnsseed\fR
156 .IP
157 Query for peer addresses via DNS lookup, if low on addresses (default: 1
158 unless \fB\-connect\fR used)
159 .HP
160 \fB\-externalip=\fR<ip>
161 .IP
162 Specify your own public address
163 .HP
164 \fB\-forcednsseed\fR
165 .IP
166 Always query for peer addresses via DNS lookup (default: 0)
167 .HP
168 \fB\-listen\fR
169 .IP
170 Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
171 .HP
172 \fB\-listenonion\fR
173 .IP
174 Automatically create Tor hidden service (default: 1)
175 .HP
176 \fB\-maxconnections=\fR<n>
177 .IP
178 Maintain at most <n> connections to peers (default: 125)
179 .HP
180 \fB\-maxreceivebuffer=\fR<n>
181 .IP
182 Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
183 .HP
184 \fB\-maxsendbuffer=\fR<n>
185 .IP
186 Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
187 .HP
188 \fB\-maxtimeadjustment\fR
189 .IP
190 Maximum allowed median peer time offset adjustment. Local perspective of
191 time may be influenced by peers forward or backward by this
192 amount. (default: 4200 seconds)
193 .HP
194 \fB\-onion=\fR<ip:port>
195 .IP
196 Use separate SOCKS5 proxy to reach peers via Tor hidden services
197 (default: \fB\-proxy\fR)
198 .HP
199 \fB\-onlynet=\fR<net>
200 .IP
201 Only connect to nodes in network <net> (ipv4, ipv6 or onion)
202 .HP
203 \fB\-permitbaremultisig\fR
204 .IP
205 Relay non\-P2SH multisig (default: 1)
206 .HP
207 \fB\-peerbloomfilters\fR
208 .IP
209 Support filtering of blocks and transaction with bloom filters (default:
210 1)
211 .HP
212 \fB\-port=\fR<port>
213 .IP
214 Listen for connections on <port> (default: 8333 or testnet: 18333)
215 .HP
216 \fB\-proxy=\fR<ip:port>
217 .IP
218 Connect through SOCKS5 proxy
219 .HP
220 \fB\-proxyrandomize\fR
221 .IP
222 Randomize credentials for every proxy connection. This enables Tor
223 stream isolation (default: 1)
224 .HP
225 \fB\-seednode=\fR<ip>
226 .IP
227 Connect to a node to retrieve peer addresses, and disconnect
228 .HP
229 \fB\-timeout=\fR<n>
230 .IP
231 Specify connection timeout in milliseconds (minimum: 1, default: 5000)
232 .HP
233 \fB\-torcontrol=\fR<ip>:<port>
234 .IP
235 Tor control port to use if onion listening enabled (default:
236 127.0.0.1:9051)
237 .HP
238 \fB\-torpassword=\fR<pass>
239 .IP
240 Tor control port password (default: empty)
241 .HP
242 \fB\-upnp\fR
243 .IP
244 Use UPnP to map the listening port (default: 0)
245 .HP
246 \fB\-whitebind=\fR<addr>
247 .IP
248 Bind to given address and whitelist peers connecting to it. Use
249 [host]:port notation for IPv6
250 .HP
251 \fB\-whitelist=\fR<IP address or network>
252 .IP
253 Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or
254 CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple
255 times. Whitelisted peers cannot be DoS banned and their
256 transactions are always relayed, even if they are already in the
257 mempool, useful e.g. for a gateway
258 .HP
259 \fB\-maxuploadtarget=\fR<n>
260 .IP
261 Tries to keep outbound traffic under the given target (in MiB per 24h),
262 0 = no limit (default: 0)
263 .PP
264 Wallet options:
265 .HP
266 \fB\-disablewallet\fR
267 .IP
268 Do not load the wallet and disable wallet RPC calls
269 .HP
270 \fB\-keypool=\fR<n>
271 .IP
272 Set key pool size to <n> (default: 1000)
273 .HP
274 \fB\-fallbackfee=\fR<amt>
275 .IP
276 A fee rate (in BTC/kB) that will be used when fee estimation has
277 insufficient data (default: 0.0002)
278 .HP
279 \fB\-discardfee=\fR<amt>
280 .IP
281 The fee rate (in BTC/kB) that indicates your tolerance for discarding
282 change by adding it to the fee (default: 0.0001). Note: An output
283 is discarded if it is dust at this rate, but we will always
284 discard up to the dust relay fee and a discard fee above that is
285 limited by the fee estimate for the longest target
286 .HP
287 \fB\-mintxfee=\fR<amt>
288 .IP
289 Fees (in BTC/kB) smaller than this are considered zero fee for
290 transaction creation (default: 0.00001)
291 .HP
292 \fB\-paytxfee=\fR<amt>
293 .IP
294 Fee (in BTC/kB) to add to transactions you send (default: 0.00)
295 .HP
296 \fB\-rescan\fR
297 .IP
298 Rescan the block chain for missing wallet transactions on startup
299 .HP
300 \fB\-salvagewallet\fR
301 .IP
302 Attempt to recover private keys from a corrupt wallet on startup
303 .HP
304 \fB\-spendzeroconfchange\fR
305 .IP
306 Spend unconfirmed change when sending transactions (default: 1)
307 .HP
308 \fB\-txconfirmtarget=\fR<n>
309 .IP
310 If paytxfee is not set, include enough fee so transactions begin
311 confirmation on average within n blocks (default: 6)
312 .HP
313 \fB\-walletrbf\fR
314 .IP
315 Send transactions with full\-RBF opt\-in enabled (default: 0)
316 .HP
317 \fB\-upgradewallet\fR
318 .IP
319 Upgrade wallet to latest format on startup
320 .HP
321 \fB\-wallet=\fR<file>
322 .IP
323 Specify wallet file (within data directory) (default: wallet.dat)
324 .HP
325 \fB\-walletbroadcast\fR
326 .IP
327 Make the wallet broadcast transactions (default: 1)
328 .HP
329 \fB\-walletnotify=\fR<cmd>
330 .IP
331 Execute command when a wallet transaction changes (%s in cmd is replaced
332 by TxID)
333 .HP
334 \fB\-zapwallettxes=\fR<mode>
335 .IP
336 Delete all wallet transactions and only recover those parts of the
337 blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g.
338 account owner and payment request information, 2 = drop tx meta
339 data)
340 .PP
341 ZeroMQ notification options:
342 .HP
343 \fB\-zmqpubhashblock=\fR<address>
344 .IP
345 Enable publish hash block in <address>
346 .HP
347 \fB\-zmqpubhashtx=\fR<address>
348 .IP
349 Enable publish hash transaction in <address>
350 .HP
351 \fB\-zmqpubrawblock=\fR<address>
352 .IP
353 Enable publish raw block in <address>
354 .HP
355 \fB\-zmqpubrawtx=\fR<address>
356 .IP
357 Enable publish raw transaction in <address>
358 .PP
359 Debugging/Testing options:
360 .HP
361 \fB\-uacomment=\fR<cmt>
362 .IP
363 Append comment to the user agent string
364 .HP
365 \fB\-debug=\fR<category>
366 .IP
367 Output debugging information (default: 0, supplying <category> is
368 optional). If <category> is not supplied or if <category> = 1,
369 output all debugging information. <category> can be: net, tor,
370 mempool, http, bench, zmq, db, rpc, estimatefee, addrman,
371 selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej,
372 libevent, coindb, qt, leveldb.
373 .HP
374 \fB\-debugexclude=\fR<category>
375 .IP
376 Exclude debugging information for a category. Can be used in conjunction
377 with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one
378 or more specified categories.
379 .HP
380 \fB\-help\-debug\fR
381 .IP
382 Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR)
383 .HP
384 \fB\-logips\fR
385 .IP
386 Include IP addresses in debug output (default: 0)
387 .HP
388 \fB\-logtimestamps\fR
389 .IP
390 Prepend debug output with timestamp (default: 1)
391 .HP
392 \fB\-maxtxfee=\fR<amt>
393 .IP
394 Maximum total fees (in BTC) to use in a single wallet transaction or raw
395 transaction; setting this too low may abort large transactions
396 (default: 0.10)
397 .HP
398 \fB\-printtoconsole\fR
399 .IP
400 Send trace/debug info to console instead of debug.log file
401 .HP
402 \fB\-shrinkdebugfile\fR
403 .IP
404 Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR)
405 .PP
406 Chain selection options:
407 .HP
408 \fB\-testnet\fR
409 .IP
410 Use the test chain
411 .PP
412 Node relay options:
413 .HP
414 \fB\-bytespersigop\fR
415 .IP
416 Equivalent bytes per sigop in transactions for relay and mining
417 (default: 20)
418 .HP
419 \fB\-datacarrier\fR
420 .IP
421 Relay and mine data carrier transactions (default: 1)
422 .HP
423 \fB\-datacarriersize\fR
424 .IP
425 Maximum size of data in data carrier transactions we relay and mine
426 (default: 83)
427 .HP
428 \fB\-mempoolreplacement\fR
429 .IP
430 Enable transaction replacement in the memory pool (default: 1)
431 .HP
432 \fB\-minrelaytxfee=\fR<amt>
433 .IP
434 Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
435 mining and transaction creation (default: 0.00001)
436 .HP
437 \fB\-whitelistrelay\fR
438 .IP
439 Accept relayed transactions received from whitelisted peers even when
440 not relaying transactions (default: 1)
441 .HP
442 \fB\-whitelistforcerelay\fR
443 .IP
444 Force relay of transactions from whitelisted peers even if they violate
445 local relay policy (default: 1)
446 .PP
447 Block creation options:
448 .HP
449 \fB\-blockmaxweight=\fR<n>
450 .IP
451 Set maximum BIP141 block weight (default: 3996000)
452 .HP
453 \fB\-blockmaxsize=\fR<n>
454 .IP
455 Set maximum BIP141 block weight to this * 4. Deprecated, use
456 blockmaxweight
457 .HP
458 \fB\-blockmintxfee=\fR<amt>
459 .IP
460 Set lowest fee rate (in BTC/kB) for transactions to be included in block
461 creation. (default: 0.00001)
462 .PP
463 RPC server options:
464 .HP
465 \fB\-server\fR
466 .IP
467 Accept command line and JSON\-RPC commands
468 .HP
469 \fB\-rest\fR
470 .IP
471 Accept public REST requests (default: 0)
472 .HP
473 \fB\-rpcbind=\fR<addr>[:port]
474 .IP
475 Bind to given address to listen for JSON\-RPC connections. This option is
476 ignored unless \fB\-rpcallowip\fR is also passed. Port is optional and
477 overrides \fB\-rpcport\fR. Use [host]:port notation for IPv6. This
478 option can be specified multiple times (default: 127.0.0.1 and
479 ::1 i.e., localhost, or if \fB\-rpcallowip\fR has been specified,
480 0.0.0.0 and :: i.e., all addresses)
481 .HP
482 \fB\-rpccookiefile=\fR<loc>
483 .IP
484 Location of the auth cookie (default: data dir)
485 .HP
486 \fB\-rpcuser=\fR<user>
487 .IP
488 Username for JSON\-RPC connections
489 .HP
490 \fB\-rpcpassword=\fR<pw>
491 .IP
492 Password for JSON\-RPC connections
493 .HP
494 \fB\-rpcauth=\fR<userpw>
495 .IP
496 Username and hashed password for JSON\-RPC connections. The field
497 <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
498 canonical python script is included in share/rpcuser. The client
499 then connects normally using the
500 rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
501 option can be specified multiple times
502 .HP
503 \fB\-rpcport=\fR<port>
504 .IP
505 Listen for JSON\-RPC connections on <port> (default: 8332 or testnet:
506 18332)
507 .HP
508 \fB\-rpcallowip=\fR<ip>
509 .IP
510 Allow JSON\-RPC connections from specified source. Valid for <ip> are a
511 single IP (e.g. 1.2.3.4), a network/netmask (e.g.
512 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
513 option can be specified multiple times
514 .HP
515 \fB\-rpcserialversion\fR
516 .IP
517 Sets the serialization of raw transaction or block hex returned in
518 non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1)
519 .HP
520 \fB\-rpcthreads=\fR<n>
521 .IP
522 Set the number of threads to service RPC calls (default: 4)
523 .SH COPYRIGHT
524 Copyright (C) 2009-2017 The Bitcoin Core developers
526 Please contribute if you find Bitcoin Core useful. Visit
527 <https://bitcoincore.org> for further information about the software.
528 The source code is available from <https://github.com/bitcoin/bitcoin>.
530 This is experimental software.
531 Distributed under the MIT software license, see the accompanying file COPYING
532 or <https://opensource.org/licenses/MIT>
534 This product includes software developed by the OpenSSL Project for use in the
535 OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
536 Eric Young and UPnP software written by Thomas Bernard.