github.com/palcoin-project/palcd@v1.0.0/doc.go (about) 1 // Copyright (c) 2013-2017 The btcsuite developers 2 // Use of this source code is governed by an ISC 3 // license that can be found in the LICENSE file. 4 5 /* 6 btcd is a full-node bitcoin implementation written in Go. 7 8 The default options are sane for most users. This means btcd will work 'out of 9 the box' for most users. However, there are also a wide variety of flags that 10 can be used to control it. 11 12 The following section provides a usage overview which enumerates the flags. An 13 interesting point to note is that the long form of all of these options 14 (except -C) can be specified in a configuration file that is automatically 15 parsed when btcd starts up. By default, the configuration file is located at 16 ~/.palcd/palcd.conf on POSIX-style operating systems and %LOCALAPPDATA%\btcd\palcd.conf 17 on Windows. The -C (--configfile) flag, as shown below, can be used to override 18 this location. 19 20 Usage: 21 btcd [OPTIONS] 22 23 Application Options: 24 --addcheckpoint= Add a custom checkpoint. Format: 25 '<height>:<hash>' 26 -a, --addpeer= Add a peer to connect with at startup 27 --addrindex Maintain a full address-based transaction index 28 which makes the searchrawtransactions RPC 29 available 30 --banduration= How long to ban misbehaving peers. Valid time 31 units are {s, m, h}. Minimum 1 second (default: 32 24h0m0s) 33 --banthreshold= Maximum allowed ban score before disconnecting 34 and banning misbehaving peers. (default: 100) 35 --blockmaxsize= Maximum block size in bytes to be used when 36 creating a block (default: 750000) 37 --blockminsize= Mininum block size in bytes to be used when 38 creating a block 39 --blockmaxweight= Maximum block weight to be used when creating a 40 block (default: 3000000) 41 --blockminweight= Mininum block weight to be used when creating a 42 block 43 --blockprioritysize= Size in bytes for high-priority/low-fee 44 transactions when creating a block (default: 45 50000) 46 --blocksonly Do not accept transactions from remote peers. 47 -C, --configfile= Path to configuration file 48 --connect= Connect only to the specified peers at startup 49 --cpuprofile= Write CPU profile to the specified file 50 -b, --datadir= Directory to store data 51 --dbtype= Database backend to use for the Block Chain 52 (default: ffldb) 53 -d, --debuglevel= Logging level for all subsystems {trace, debug, 54 info, warn, error, critical} -- You may also 55 specify 56 <subsystem>=<level>,<subsystem2>=<level>,... to 57 set the log level for individual subsystems -- 58 Use show to list available subsystems (default: 59 info) 60 --dropaddrindex Deletes the address-based transaction index from 61 the database on start up and then exits. 62 --dropcfindex Deletes the index used for committed filtering 63 (CF) support from the database on start up and 64 then exits. 65 --droptxindex Deletes the hash-based transaction index from the 66 database on start up and then exits. 67 --externalip= Add an ip to the list of local addresses we claim 68 to listen on to peers 69 --generate Generate (mine) bitcoins using the CPU 70 --limitfreerelay= Limit relay of transactions with no transaction 71 fee to the given amount in thousands of bytes per 72 minute (default: 15) 73 --listen= Add an interface/port to listen for connections 74 (default all interfaces port: 1948, testnet: 75 11948, signet: 31948) 76 --logdir= Directory to log output 77 --maxorphantx= Max number of orphan transactions to keep in 78 memory (default: 100) 79 --maxpeers= Max number of inbound and outbound peers 80 (default: 125) 81 --miningaddr= Add the specified payment address to the list of 82 addresses to use for generated blocks -- At least 83 one address is required if the generate option is 84 set 85 --minrelaytxfee= The minimum transaction fee in BTC/kB to be 86 considered a non-zero fee. (default: 1e-05) 87 --nobanning Disable banning of misbehaving peers 88 --nocfilters Disable committed filtering (CF) support 89 --nocheckpoints Disable built-in checkpoints. Don't do this 90 unless you know what you're doing. 91 --nodnsseed Disable DNS seeding for peers 92 --nolisten Disable listening for incoming connections -- 93 NOTE: Listening is automatically disabled if the 94 --connect or --proxy options are used without 95 also specifying listen interfaces via --listen 96 --noonion Disable connecting to tor hidden services 97 --nopeerbloomfilters Disable bloom filtering support 98 --norelaypriority Do not require free or low-fee transactions to 99 have high priority for relaying 100 --norpc Disable built-in RPC server -- NOTE: The RPC 101 server is disabled by default if no 102 rpcuser/rpcpass or rpclimituser/rpclimitpass is 103 specified 104 --notls Disable TLS for the RPC server -- NOTE: This is 105 only allowed if the RPC server is bound to 106 localhost 107 --onion= Connect to tor hidden services via SOCKS5 proxy 108 (eg. 127.0.0.1:9050) 109 --onionpass= Password for onion proxy server 110 --onionuser= Username for onion proxy server 111 --profile= Enable HTTP profiling on given port -- NOTE port 112 must be between 1024 and 65536 113 --proxy= Connect via SOCKS5 proxy (eg. 127.0.0.1:9050) 114 --proxypass= Password for proxy server 115 --proxyuser= Username for proxy server 116 --regtest Use the regression test network 117 --rejectnonstd Reject non-standard transactions regardless of 118 the default settings for the active network. 119 --relaynonstd Relay non-standard transactions regardless of the 120 default settings for the active network. 121 --rpccert= File containing the certificate file 122 --rpckey= File containing the certificate key 123 --rpclimitpass= Password for limited RPC connections 124 --rpclimituser= Username for limited RPC connections 125 --rpclisten= Add an interface/port to listen for RPC 126 connections (default port: 1967, testnet: 11967) 127 --rpcmaxclients= Max number of RPC clients for standard 128 connections (default: 10) 129 --rpcmaxconcurrentreqs= Max number of concurrent RPC requests that may be 130 processed concurrently (default: 20) 131 --rpcmaxwebsockets= Max number of RPC websocket connections (default: 132 25) 133 --rpcquirks Mirror some JSON-RPC quirks of Bitcoin Core -- 134 NOTE: Discouraged unless interoperability issues 135 need to be worked around 136 -P, --rpcpass= Password for RPC connections 137 -u, --rpcuser= Username for RPC connections 138 --sigcachemaxsize= The maximum number of entries in the signature 139 verification cache (default: 100000) 140 --simnet Use the simulation test network 141 --testnet Use the test network 142 --torisolation Enable Tor stream isolation by randomizing user 143 credentials for each connection. 144 --trickleinterval= Minimum time between attempts to send new 145 inventory to a connected peer (default: 10s) 146 --txindex Maintain a full hash-based transaction index 147 which makes all transactions available via the 148 getrawtransaction RPC 149 --uacomment= Comment to add to the user agent -- See BIP 14 150 for more information. 151 --upnp Use UPnP to map our listening port outside of NAT 152 -V, --version Display version information and exit 153 --whitelist= Add an IP network or IP that will not be banned. 154 (eg. 192.168.1.0/24 or ::1) 155 156 Help Options: 157 -h, --help Show this help message 158 159 */ 160 package main