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