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