doc/man/zcashd.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
   2 .TH ZCASHD "1" "August 2017" "zcashd v1.0.11" "User Commands"
   3 .SH NAME
   4 zcashd \- manual page for zcashd v1.0.11
   5 .SH DESCRIPTION
   6 Zcash Daemon version v1.0.11
   7 .PP
   8 In order to ensure you are adequately protecting your privacy when using Zcash,
   9 please see <https://z.cash/support/security/index.html>.
  10 .SS "Usage:"
  11 .TP
  12 zcashd [options]
  13 Start Zcash Daemon
  14 .SH OPTIONS
  15 .HP
  16 \-?
  17 .IP
  18 This help message
  19 .HP
  20 \fB\-alerts\fR
  21 .IP
  22 Receive and display P2P network alerts (default: 1)
  23 .HP
  24 \fB\-alertnotify=\fR<cmd>
  25 .IP
  26 Execute command when a relevant alert is received or we see a really
  27 long fork (%s in cmd is replaced by message)
  28 .HP
  29 \fB\-blocknotify=\fR<cmd>
  30 .IP
  31 Execute command when the best block changes (%s in cmd is replaced by
  32 block hash)
  33 .HP
  34 \fB\-checkblocks=\fR<n>
  35 .IP
  36 How many blocks to check at startup (default: 288, 0 = all)
  37 .HP
  38 \fB\-checklevel=\fR<n>
  39 .IP
  40 How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3)
  41 .HP
  42 \fB\-conf=\fR<file>
  43 .IP
  44 Specify configuration file (default: zcash.conf)
  45 .HP
  46 \fB\-daemon\fR
  47 .IP
  48 Run in the background as a daemon and accept commands
  49 .HP
  50 \fB\-datadir=\fR<dir>
  51 .IP
  52 Specify data directory
  53 .HP
  54 \fB\-disabledeprecation=\fR<version>
  55 .IP
  56 Disable block\-height node deprecation and automatic shutdown (example:
  57 \fB\-disabledeprecation\fR=\fI\,1\/\fR.0.11)
  58 .HP
  59 \fB\-exportdir=\fR<dir>
  60 .IP
  61 Specify directory to be used when exporting data
  62 .HP
  63 \fB\-dbcache=\fR<n>
  64 .IP
  65 Set database cache size in megabytes (4 to 16384, default: 100)
  66 .HP
  67 \fB\-loadblock=\fR<file>
  68 .IP
  69 Imports blocks from external blk000??.dat file on startup
  70 .HP
  71 \fB\-maxorphantx=\fR<n>
  72 .IP
  73 Keep at most <n> unconnectable transactions in memory (default: 100)
  74 .HP
  75 \fB\-mempooltxinputlimit=\fR<n>
  76 .IP
  77 Set the maximum number of transparent inputs in a transaction that the
  78 mempool will accept (default: 0 = no limit applied)
  79 .HP
  80 \fB\-par=\fR<n>
  81 .IP
  82 Set the number of script verification threads (\fB\-2\fR to 16, 0 = auto, <0 =
  83 leave that many cores free, default: 0)
  84 .HP
  85 \fB\-pid=\fR<file>
  86 .IP
  87 Specify pid file (default: zcashd.pid)
  88 .HP
  89 \fB\-prune=\fR<n>
  90 .IP
  91 Reduce storage requirements by pruning (deleting) old blocks. This mode
  92 disables wallet support and is incompatible with \fB\-txindex\fR. Warning:
  93 Reverting this setting requires re\-downloading the entire blockchain.
  94 (default: 0 = disable pruning blocks, >550 = target size in MiB to use
  95 for block files)
  96 .HP
  97 \fB\-reindex\fR
  98 .IP
  99 Rebuild block chain index from current blk000??.dat files on startup
 100 .HP
 101 \fB\-sysperms\fR
 102 .IP
 103 Create new files with system default permissions, instead of umask 077
 104 (only effective with disabled wallet functionality)
 105 .HP
 106 \fB\-txindex\fR
 107 .IP
 108 Maintain a full transaction index, used by the getrawtransaction rpc
 109 call (default: 0)
 110 .PP
 111 Connection options:
 112 .HP
 113 \fB\-addnode=\fR<ip>
 114 .IP
 115 Add a node to connect to and attempt to keep the connection open
 116 .HP
 117 \fB\-banscore=\fR<n>
 118 .IP
 119 Threshold for disconnecting misbehaving peers (default: 100)
 120 .HP
 121 \fB\-bantime=\fR<n>
 122 .IP
 123 Number of seconds to keep misbehaving peers from reconnecting (default:
 124 86400)
 125 .HP
 126 \fB\-bind=\fR<addr>
 127 .IP
 128 Bind to given address and always listen on it. Use [host]:port notation
 129 for IPv6
 130 .HP
 131 \fB\-connect=\fR<ip>
 132 .IP
 133 Connect only to the specified node(s)
 134 .HP
 135 \fB\-discover\fR
 136 .IP
 137 Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR
 138 or \fB\-proxy\fR)
 139 .HP
 140 \fB\-dns\fR
 141 .IP
 142 Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1)
 143 .HP
 144 \fB\-dnsseed\fR
 145 .IP
 146 Query for peer addresses via DNS lookup, if low on addresses (default: 1
 147 unless \fB\-connect\fR)
 148 .HP
 149 \fB\-externalip=\fR<ip>
 150 .IP
 151 Specify your own public address
 152 .HP
 153 \fB\-forcednsseed\fR
 154 .IP
 155 Always query for peer addresses via DNS lookup (default: 0)
 156 .HP
 157 \fB\-listen\fR
 158 .IP
 159 Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
 160 .HP
 161 \fB\-listenonion\fR
 162 .IP
 163 Automatically create Tor hidden service (default: 1)
 164 .HP
 165 \fB\-maxconnections=\fR<n>
 166 .IP
 167 Maintain at most <n> connections to peers (default: 125)
 168 .HP
 169 \fB\-maxreceivebuffer=\fR<n>
 170 .IP
 171 Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
 172 .HP
 173 \fB\-maxsendbuffer=\fR<n>
 174 .IP
 175 Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
 176 .HP
 177 \fB\-onion=\fR<ip:port>
 178 .IP
 179 Use separate SOCKS5 proxy to reach peers via Tor hidden services
 180 (default: \fB\-proxy\fR)
 181 .HP
 182 \fB\-onlynet=\fR<net>
 183 .IP
 184 Only connect to nodes in network <net> (ipv4, ipv6 or onion)
 185 .HP
 186 \fB\-permitbaremultisig\fR
 187 .IP
 188 Relay non\-P2SH multisig (default: 1)
 189 .HP
 190 \fB\-port=\fR<port>
 191 .IP
 192 Listen for connections on <port> (default: 8233 or testnet: 18233)
 193 .HP
 194 \fB\-proxy=\fR<ip:port>
 195 .IP
 196 Connect through SOCKS5 proxy
 197 .HP
 198 \fB\-proxyrandomize\fR
 199 .IP
 200 Randomize credentials for every proxy connection. This enables Tor
 201 stream isolation (default: 1)
 202 .HP
 203 \fB\-seednode=\fR<ip>
 204 .IP
 205 Connect to a node to retrieve peer addresses, and disconnect
 206 .HP
 207 \fB\-timeout=\fR<n>
 208 .IP
 209 Specify connection timeout in milliseconds (minimum: 1, default: 5000)
 210 .HP
 211 \fB\-torcontrol=\fR<ip>:<port>
 212 .IP
 213 Tor control port to use if onion listening enabled (default:
 214 127.0.0.1:9051)
 215 .HP
 216 \fB\-torpassword=\fR<pass>
 217 .IP
 218 Tor control port password (default: empty)
 219 .HP
 220 \fB\-whitebind=\fR<addr>
 221 .IP
 222 Bind to given address and whitelist peers connecting to it. Use
 223 [host]:port notation for IPv6
 224 .HP
 225 \fB\-whitelist=\fR<netmask>
 226 .IP
 227 Whitelist peers connecting from the given netmask or IP address. Can be
 228 specified multiple times. Whitelisted peers cannot be DoS banned and
 229 their transactions are always relayed, even if they are already in the
 230 mempool, useful e.g. for a gateway
 231 .PP
 232 Wallet options:
 233 .HP
 234 \fB\-disablewallet\fR
 235 .IP
 236 Do not load the wallet and disable wallet RPC calls
 237 .HP
 238 \fB\-keypool=\fR<n>
 239 .IP
 240 Set key pool size to <n> (default: 100)
 241 .HP
 242 \fB\-paytxfee=\fR<amt>
 243 .IP
 244 Fee (in BTC/kB) to add to transactions you send (default: 0.00)
 245 .HP
 246 \fB\-rescan\fR
 247 .IP
 248 Rescan the blockchain for missing wallet transactions on startup
 249 .HP
 250 \fB\-salvagewallet\fR
 251 .IP
 252 Attempt to recover private keys from a corrupt wallet.dat on startup
 253 .HP
 254 \fB\-sendfreetransactions\fR
 255 .IP
 256 Send transactions as zero\-fee transactions if possible (default: 0)
 257 .HP
 258 \fB\-spendzeroconfchange\fR
 259 .IP
 260 Spend unconfirmed change when sending transactions (default: 1)
 261 .HP
 262 \fB\-txconfirmtarget=\fR<n>
 263 .IP
 264 If paytxfee is not set, include enough fee so transactions begin
 265 confirmation on average within n blocks (default: 2)
 266 .HP
 267 \fB\-maxtxfee=\fR<amt>
 268 .IP
 269 Maximum total fees to use in a single wallet transaction; setting this
 270 too low may abort large transactions (default: 0.10)
 271 .HP
 272 \fB\-upgradewallet\fR
 273 .IP
 274 Upgrade wallet to latest format on startup
 275 .HP
 276 \fB\-wallet=\fR<file>
 277 .IP
 278 Specify wallet file (within data directory) (default: wallet.dat)
 279 .HP
 280 \fB\-walletbroadcast\fR
 281 .IP
 282 Make the wallet broadcast transactions (default: 1)
 283 .HP
 284 \fB\-walletnotify=\fR<cmd>
 285 .IP
 286 Execute command when a wallet transaction changes (%s in cmd is replaced
 287 by TxID)
 288 .HP
 289 \fB\-zapwallettxes=\fR<mode>
 290 .IP
 291 Delete all wallet transactions and only recover those parts of the
 292 blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g.
 293 account owner and payment request information, 2 = drop tx meta data)
 294 .PP
 295 ZeroMQ notification options:
 296 .HP
 297 \fB\-zmqpubhashblock=\fR<address>
 298 .IP
 299 Enable publish hash block in <address>
 300 .HP
 301 \fB\-zmqpubhashtx=\fR<address>
 302 .IP
 303 Enable publish hash transaction in <address>
 304 .HP
 305 \fB\-zmqpubrawblock=\fR<address>
 306 .IP
 307 Enable publish raw block in <address>
 308 .HP
 309 \fB\-zmqpubrawtx=\fR<address>
 310 .IP
 311 Enable publish raw transaction in <address>
 312 .PP
 313 Debugging/Testing options:
 314 .HP
 315 \fB\-debug=\fR<category>
 316 .IP
 317 Output debugging information (default: 0, supplying <category> is
 318 optional). If <category> is not supplied or if <category> = 1, output
 319 all debugging information. <category> can be: addrman, alert, bench,
 320 coindb, db, estimatefee, http, libevent, lock, mempool, net,
 321 partitioncheck, pow, proxy, prune, rand, reindex, rpc, selectcoins, tor,
 322 zmq, zrpc, zrpcunsafe (implies zrpc).
 323 .HP
 324 \fB\-experimentalfeatures\fR
 325 .IP
 326 Enable use of experimental features
 327 .HP
 328 \fB\-help\-debug\fR
 329 .IP
 330 Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR)
 331 .HP
 332 \fB\-logips\fR
 333 .IP
 334 Include IP addresses in debug output (default: 0)
 335 .HP
 336 \fB\-logtimestamps\fR
 337 .IP
 338 Prepend debug output with timestamp (default: 1)
 339 .HP
 340 \fB\-minrelaytxfee=\fR<amt>
 341 .IP
 342 Fees (in BTC/Kb) smaller than this are considered zero fee for relaying
 343 (default: 0.000001)
 344 .HP
 345 \fB\-printtoconsole\fR
 346 .IP
 347 Send trace/debug info to console instead of debug.log file
 348 .HP
 349 \fB\-shrinkdebugfile\fR
 350 .IP
 351 Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR)
 352 .HP
 353 \fB\-testnet\fR
 354 .IP
 355 Use the test network
 356 .PP
 357 Node relay options:
 358 .HP
 359 \fB\-datacarrier\fR
 360 .IP
 361 Relay and mine data carrier transactions (default: 1)
 362 .HP
 363 \fB\-datacarriersize\fR
 364 .IP
 365 Maximum size of data in data carrier transactions we relay and mine
 366 (default: 80)
 367 .PP
 368 Block creation options:
 369 .HP
 370 \fB\-blockminsize=\fR<n>
 371 .IP
 372 Set minimum block size in bytes (default: 0)
 373 .HP
 374 \fB\-blockmaxsize=\fR<n>
 375 .IP
 376 Set maximum block size in bytes (default: 2000000)
 377 .HP
 378 \fB\-blockprioritysize=\fR<n>
 379 .IP
 380 Set maximum size of high\-priority/low\-fee transactions in bytes
 381 (default: 1000000)
 382 .PP
 383 Mining options:
 384 .HP
 385 \fB\-gen\fR
 386 .IP
 387 Generate coins (default: 0)
 388 .HP
 389 \fB\-genproclimit=\fR<n>
 390 .IP
 391 Set the number of threads for coin generation if enabled (\fB\-1\fR = all
 392 cores, default: 1)
 393 .HP
 394 \fB\-equihashsolver=\fR<name>
 395 .IP
 396 Specify the Equihash solver to be used if enabled (default: "default")
 397 .HP
 398 \fB\-mineraddress=\fR<addr>
 399 .IP
 400 Send mined coins to a specific single address
 401 .HP
 402 \fB\-minetolocalwallet\fR
 403 .IP
 404 Require that mined blocks use a coinbase address in the local wallet
 405 (default: 1)
 406 .PP
 407 RPC server options:
 408 .HP
 409 \fB\-server\fR
 410 .IP
 411 Accept command line and JSON\-RPC commands
 412 .HP
 413 \fB\-rest\fR
 414 .IP
 415 Accept public REST requests (default: 0)
 416 .HP
 417 \fB\-rpcbind=\fR<addr>
 418 .IP
 419 Bind to given address to listen for JSON\-RPC connections. Use
 420 [host]:port notation for IPv6. This option can be specified multiple
 421 times (default: bind to all interfaces)
 422 .HP
 423 \fB\-rpcuser=\fR<user>
 424 .IP
 425 Username for JSON\-RPC connections
 426 .HP
 427 \fB\-rpcpassword=\fR<pw>
 428 .IP
 429 Password for JSON\-RPC connections
 430 .HP
 431 \fB\-rpcport=\fR<port>
 432 .IP
 433 Listen for JSON\-RPC connections on <port> (default: 8232 or testnet:
 434 18232)
 435 .HP
 436 \fB\-rpcallowip=\fR<ip>
 437 .IP
 438 Allow JSON\-RPC connections from specified source. Valid for <ip> are a
 439 single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0)
 440 or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified
 441 multiple times
 442 .HP
 443 \fB\-rpcthreads=\fR<n>
 444 .IP
 445 Set the number of threads to service RPC calls (default: 4)
 446 .PP
 447 Metrics Options (only if \fB\-daemon\fR and \fB\-printtoconsole\fR are not set):
 448 .HP
 449 \fB\-showmetrics\fR
 450 .IP
 451 Show metrics on stdout (default: 1 if running in a console, 0 otherwise)
 452 .HP
 453 \fB\-metricsui\fR
 454 .IP
 455 Set to 1 for a persistent metrics screen, 0 for sequential metrics
 456 output (default: 1 if running in a console, 0 otherwise)
 457 .HP
 458 \fB\-metricsrefreshtime\fR
 459 .IP
 460 Number of seconds between metrics refreshes (default: 1 if running in a
 461 console, 600 otherwise)
 462 .SH COPYRIGHT
 463
 464 In order to ensure you are adequately protecting your privacy when using Zcash,
 465 please see <https://z.cash/support/security/index.html>.
 466
 467 Copyright (C) 2009-2017 The Bitcoin Core Developers
 468 Copyright (C) 2015-2017 The Zcash Developers
 469
 470 This is experimental software.
 471
 472 Distributed under the MIT software license, see the accompanying file COPYING
 473 or <http://www.opensource.org/licenses/mit-license.php>.
 474
 475 This product includes software developed by the OpenSSL Project for use in the
 476 OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
 477 by Eric Young.