github.com/dashpay/godash@v0.0.0-20160726055534-e038a21e0e3d/doc.go (about) 1 // Copyright (c) 2013-2016 The btcsuite developers 2 // Copyright (c) 2016 The Dash developers 3 // Use of this source code is governed by an ISC 4 // license that can be found in the LICENSE file. 5 6 /* 7 btcd is a full-node bitcoin implementation written in Go. 8 9 The default options are sane for most users. This means btcd will work 'out of 10 the box' for most users. However, there are also a wide variety of flags that 11 can be used to control it. 12 13 The following section provides a usage overview which enumerates the flags. An 14 interesting point to note is that the long form of all of these options 15 (except -C) can be specified in a configuration file that is automatically 16 parsed when btcd starts up. By default, the configuration file is located at 17 ~/.btcd/btcd.conf on POSIX-style operating systems and %LOCALAPPDATA%\btcd\btcd.conf 18 on Windows. The -C (--configfile) flag, as shown below, can be used to override 19 this location. 20 21 Usage: 22 btcd [OPTIONS] 23 24 Application Options: 25 -V, --version Display version information and exit 26 -C, --configfile= Path to configuration file 27 -b, --datadir= Directory to store data 28 --logdir= Directory to log output. 29 -a, --addpeer= Add a peer to connect with at startup 30 --connect= Connect only to the specified peers at startup 31 --nolisten Disable listening for incoming connections -- NOTE: 32 Listening is automatically disabled if the --connect 33 or --proxy options are used without also specifying 34 listen interfaces via --listen 35 --listen= Add an interface/port to listen for connections 36 (default all interfaces port: 8333, testnet: 18333) 37 --maxpeers= Max number of inbound and outbound peers (125) 38 --nobanning Disable banning of misbehaving peers 39 --banthreshold= Maximum allowed ban score before disconnecting and 40 banning misbehaving peers. 41 --banduration= How long to ban misbehaving peers. Valid time units 42 are {s, m, h}. Minimum 1 second (24h0m0s) 43 -u, --rpcuser= Username for RPC connections 44 -P, --rpcpass= Password for RPC connections 45 --rpclimituser= Username for limited RPC connections 46 --rpclimitpass= Password for limited RPC connections 47 --rpclisten= Add an interface/port to listen for RPC connections 48 (default port: 8334, testnet: 18334) 49 --rpccert= File containing the certificate file 50 --rpckey= File containing the certificate key 51 --rpcmaxclients= Max number of RPC clients for standard connections 52 (10) 53 --rpcmaxwebsockets= Max number of RPC websocket connections (25) 54 --norpc Disable built-in RPC server -- NOTE: The RPC server 55 is disabled by default if no rpcuser/rpcpass or 56 rpclimituser/rpclimitpass is specified 57 --notls Disable TLS for the RPC server -- NOTE: This is only 58 allowed if the RPC server is bound to localhost 59 --nodnsseed Disable DNS seeding for peers 60 --externalip= Add an ip to the list of local addresses we claim to 61 listen on to peers 62 --proxy= Connect via SOCKS5 proxy (eg. 127.0.0.1:9050) 63 --proxyuser= Username for proxy server 64 --proxypass= Password for proxy server 65 --onion= Connect to tor hidden services via SOCKS5 proxy 66 (eg. 127.0.0.1:9050) 67 --onionuser= Username for onion proxy server 68 --onionpass= Password for onion proxy server 69 --noonion Disable connecting to tor hidden services 70 --torisolation Enable Tor stream isolation by randomizing user 71 credentials for each connection. 72 --testnet Use the test network 73 --regtest Use the regression test network 74 --simnet Use the simulation test network 75 --nocheckpoints Disable built-in checkpoints. Don't do this unless 76 you know what you're doing. 77 --dbtype= Database backend to use for the Block Chain (ffldb) 78 --profile= Enable HTTP profiling on given port -- NOTE port 79 must be between 1024 and 65536 80 --cpuprofile= Write CPU profile to the specified file 81 -d, --debuglevel= Logging level for all subsystems {trace, debug, 82 info, warn, error, critical} -- You may also specify 83 <subsystem>=<level>,<subsystem2>=<level>,... to set 84 the log level for individual subsystems -- Use show 85 to list available subsystems (info) 86 --upnp Use UPnP to map our listening port outside of NAT 87 --minrelaytxfee= The minimum transaction fee in BTC/kB to be 88 considered a non-zero fee. 89 --limitfreerelay= Limit relay of transactions with no transaction fee 90 to the given amount in thousands of bytes per 91 minute (15) 92 --norelaypriority Do not require free or low-fee transactions to have 93 high priority for relaying 94 --maxorphantx= Max number of orphan transactions to keep in memory 95 (1000) 96 --generate Generate (mine) bitcoins using the CPU 97 --miningaddr= Add the specified payment address to the list of 98 addresses to use for generated blocks -- At least 99 one address is required if the generate option is 100 set 101 --blockminsize= Mininum block size in bytes to be used when creating 102 a block 103 --blockmaxsize= Maximum block size in bytes to be used when creating 104 a block (750000) 105 --blockprioritysize= Size in bytes for high-priority/low-fee transactions 106 when creating a block (50000) 107 --getworkkey= DEPRECATED -- Use the --miningaddr option instead 108 --nopeerbloomfilters Disable bloom filtering support. 109 --sigcachemaxsize= The maximum number of entries in the signature 110 verification cache. 111 --blocksonly Do not accept transactions from remote peers. 112 113 Help Options: 114 -h, --help Show this help message 115 116 */ 117 package main