interesting
/
go-ethereum
mirror of https://github.com/ethereum/go-ethereum.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update Command-Line-Options.md (#21469) 

* Update Command-Line-Options.md

Update to 1.9.19

* fix home path
This commit is contained in:
Chase Wright 2020-08-21 06:44:29 -05:00 committed by GitHub
parent 121f2776c9
commit 68cbf054cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 86 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

148
docs/_interface/Command-Line-Options.md
View File

@ -12,10 +12,10 @@ NAME:
USAGE: USAGE:
geth [options] command [command options] [arguments...] geth [options] command [command options] [arguments...]
VERSION: VERSION:
1.9.6-stable 1.9.19-stable-3e064192
COMMANDS: COMMANDS:
account Manage accounts account Manage accounts
attach Start an interactive JavaScript environment (connect to node) attach Start an interactive JavaScript environment (connect to node)
@ -23,6 +23,7 @@ COMMANDS:
copydb Create a local chain from a target chaindata folder copydb Create a local chain from a target chaindata folder
dump Dump a specific block from storage dump Dump a specific block from storage
dumpconfig Show configuration values dumpconfig Show configuration values
dumpgenesis Dumps genesis block JSON configuration to stdout
export Export blockchain into file export Export blockchain into file
export-preimages Export the preimage database into an RLP stream export-preimages Export the preimage database into an RLP stream
import Import a blockchain file import Import a blockchain file
@ -35,29 +36,32 @@ COMMANDS:
makedag Generate ethash mining DAG (for testing) makedag Generate ethash mining DAG (for testing)
removedb Remove blockchain and state databases removedb Remove blockchain and state databases
retesteth Launches geth in retesteth mode retesteth Launches geth in retesteth mode
show-deprecated-flags Show flags that have been deprecated
version Print version numbers version Print version numbers
wallet Manage Ethereum presale wallets wallet Manage Ethereum presale wallets
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
ETHEREUM OPTIONS: ETHEREUM OPTIONS:
--config value TOML configuration file --config value TOML configuration file
--datadir value Data directory for the databases and keystore (default: "~/Library/Ethereum") --datadir value Data directory for the databases and keystore (default: "~/.ethereum")
--datadir.ancient value Data directory for ancient chain segments (default = inside chaindata) --datadir.ancient value Data directory for ancient chain segments (default = inside chaindata)
--keystore value Directory for the keystore (default = inside the datadir) --keystore value Directory for the keystore (default = inside the datadir)
--nousb Disables monitoring for and managing USB hardware wallets --nousb Disables monitoring for and managing USB hardware wallets
--pcscdpath value Path to the smartcard daemon (pcscd) socket file --pcscdpath value Path to the smartcard daemon (pcscd) socket file (default: "/run/pcscd/pcscd.comm")
--networkid value Network identifier (integer, 1=Frontier, 2=Morden (disused), 3=Ropsten, 4=Rinkeby) (default: 1) --networkid value Network identifier (integer, 1=Frontier, 3=Ropsten, 4=Rinkeby, 5=Görli) (default: 1)
--testnet Ropsten network: pre-configured proof-of-work test network
--rinkeby Rinkeby network: pre-configured proof-of-authority test network
--goerli Görli network: pre-configured proof-of-authority test network --goerli Görli network: pre-configured proof-of-authority test network
--rinkeby Rinkeby network: pre-configured proof-of-authority test network
--yolov1 YOLOv1 network: pre-configured proof-of-authority shortlived test network.
--ropsten Ropsten network: pre-configured proof-of-work test network
--syncmode value Blockchain sync mode ("fast", "full", or "light") (default: fast) --syncmode value Blockchain sync mode ("fast", "full", or "light") (default: fast)
--exitwhensynced Exits after block synchronisation completes --exitwhensynced Exits after block synchronisation completes
--gcmode value Blockchain garbage collection mode ("full", "archive") (default: "full") --gcmode value Blockchain garbage collection mode ("full", "archive") (default: "full")
--txlookuplimit value Number of recent blocks to maintain transactions index by-hash for (default = index all blocks) (default: 0)
--ethstats value Reporting URL of a ethstats service (nodename:secret@host:port) --ethstats value Reporting URL of a ethstats service (nodename:secret@host:port)
--identity value Custom node name --identity value Custom node name
--lightkdf Reduce key-derivation RAM & CPU usage at some expense of KDF strength --lightkdf Reduce key-derivation RAM & CPU usage at some expense of KDF strength
--whitelist value Comma separated block number-to-hash mappings to enforce (<number>=<hash>) --whitelist value Comma separated block number-to-hash mappings to enforce (<number>=<hash>)
LIGHT CLIENT OPTIONS: LIGHT CLIENT OPTIONS:
--light.serve value Maximum percentage of time allowed for serving LES requests (multi-threaded processing allows values over 100) (default: 0) --light.serve value Maximum percentage of time allowed for serving LES requests (multi-threaded processing allows values over 100) (default: 0)
--light.ingress value Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited) (default: 0) --light.ingress value Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited) (default: 0)
@ -66,19 +70,22 @@ LIGHT CLIENT OPTIONS:
--ulc.servers value List of trusted ultra-light servers --ulc.servers value List of trusted ultra-light servers
--ulc.fraction value Minimum % of trusted ultra-light servers required to announce a new head (default: 75) --ulc.fraction value Minimum % of trusted ultra-light servers required to announce a new head (default: 75)
--ulc.onlyannounce Ultra light server sends announcements only --ulc.onlyannounce Ultra light server sends announcements only
--light.nopruning Disable ancient light chain data pruning
DEVELOPER CHAIN OPTIONS: DEVELOPER CHAIN OPTIONS:
--dev Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled --dev Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled
--dev.period value Block period to use in developer mode (0 = mine only if transaction pending) (default: 0) --dev.period value Block period to use in developer mode (0 = mine only if transaction pending) (default: 0)
ETHASH OPTIONS: ETHASH OPTIONS:
--ethash.cachedir value Directory to store the ethash verification caches (default = inside the datadir) --ethash.cachedir value Directory to store the ethash verification caches (default = inside the datadir)
--ethash.cachesinmem value Number of recent ethash caches to keep in memory (16MB each) (default: 2) --ethash.cachesinmem value Number of recent ethash caches to keep in memory (16MB each) (default: 2)
--ethash.cachesondisk value Number of recent ethash caches to keep on disk (16MB each) (default: 3) --ethash.cachesondisk value Number of recent ethash caches to keep on disk (16MB each) (default: 3)
--ethash.dagdir value Directory to store the ethash mining DAGs (default: "~/Library/Ethash") --ethash.cacheslockmmap Lock memory maps of recent ethash caches
--ethash.dagdir value Directory to store the ethash mining DAGs (default: "~/.ethash")
--ethash.dagsinmem value Number of recent ethash mining DAGs to keep in memory (1+GB each) (default: 1) --ethash.dagsinmem value Number of recent ethash mining DAGs to keep in memory (1+GB each) (default: 1)
--ethash.dagsondisk value Number of recent ethash mining DAGs to keep on disk (1+GB each) (default: 2) --ethash.dagsondisk value Number of recent ethash mining DAGs to keep on disk (1+GB each) (default: 2)
--ethash.dagslockmmap Lock memory maps for recent ethash mining DAGs
TRANSACTION POOL OPTIONS: TRANSACTION POOL OPTIONS:
--txpool.locals value Comma separated accounts to treat as locals (no flush, priority inclusion) --txpool.locals value Comma separated accounts to treat as locals (no flush, priority inclusion)
--txpool.nolocals Disables price exemptions for locally submitted transactions --txpool.nolocals Disables price exemptions for locally submitted transactions
@ -91,48 +98,51 @@ TRANSACTION POOL OPTIONS:
--txpool.accountqueue value Maximum number of non-executable transaction slots permitted per account (default: 64) --txpool.accountqueue value Maximum number of non-executable transaction slots permitted per account (default: 64)
--txpool.globalqueue value Maximum number of non-executable transaction slots for all accounts (default: 1024) --txpool.globalqueue value Maximum number of non-executable transaction slots for all accounts (default: 1024)
--txpool.lifetime value Maximum amount of time non-executable transaction are queued (default: 3h0m0s) --txpool.lifetime value Maximum amount of time non-executable transaction are queued (default: 3h0m0s)
PERFORMANCE TUNING OPTIONS: PERFORMANCE TUNING OPTIONS:
--cache value Megabytes of memory allocated to internal caching (default = 4096 mainnet full node, 128 light mode) (default: 1024) --cache value Megabytes of memory allocated to internal caching (default = 4096 mainnet full node, 128 light mode) (default: 1024)
--cache.database value Percentage of cache memory allowance to use for database io (default: 50) --cache.database value Percentage of cache memory allowance to use for database io (default: 50)
--cache.trie value Percentage of cache memory allowance to use for trie caching (default = 25% full mode, 50% archive mode) (default: 25) --cache.trie value Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode) (default: 15)
--cache.trie.journal value Disk journal directory for trie cache to survive node restarts (default: "triecache")
--cache.trie.rejournal value Time interval to regenerate the trie cache journal (default: 1h0m0s)
--cache.gc value Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode) (default: 25) --cache.gc value Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode) (default: 25)
--cache.snapshot value Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode) (default: 10)
--cache.noprefetch Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data) --cache.noprefetch Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)
ACCOUNT OPTIONS: ACCOUNT OPTIONS:
--unlock value Comma separated list of accounts to unlock --unlock value Comma separated list of accounts to unlock
--password value Password file to use for non-interactive password input --password value Password file to use for non-interactive password input
--signer value External signer (url or path to ipc file) --signer value External signer (url or path to ipc file)
--allow-insecure-unlock Allow insecure account unlocking when account-related RPCs are exposed by http --allow-insecure-unlock Allow insecure account unlocking when account-related RPCs are exposed by http
API AND CONSOLE OPTIONS: API AND CONSOLE OPTIONS:
--ipcdisable Disable the IPC-RPC server --ipcdisable Disable the IPC-RPC server
--ipcpath value Filename for IPC socket/pipe within the datadir (explicit paths escape it) --ipcpath value Filename for IPC socket/pipe within the datadir (explicit paths escape it)
--rpc Enable the HTTP-RPC server --http Enable the HTTP-RPC server
--rpcaddr value HTTP-RPC server listening interface (default: "localhost") --http.addr value HTTP-RPC server listening interface (default: "localhost")
--rpcport value HTTP-RPC server listening port (default: 8545) --http.port value HTTP-RPC server listening port (default: 8545)
--rpcapi value API's offered over the HTTP-RPC interface --http.api value API's offered over the HTTP-RPC interface
--rpc.gascap value Sets a cap on gas that can be used in eth_call/estimateGas (default: 0) --http.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced)
--rpccorsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced) --http.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost")
--rpcvhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost")
--ws Enable the WS-RPC server --ws Enable the WS-RPC server
--wsaddr value WS-RPC server listening interface (default: "localhost") --ws.addr value WS-RPC server listening interface (default: "localhost")
--wsport value WS-RPC server listening port (default: 8546) --ws.port value WS-RPC server listening port (default: 8546)
--wsapi value API's offered over the WS-RPC interface --ws.api value API's offered over the WS-RPC interface
--wsorigins value Origins from which to accept websockets requests --ws.origins value Origins from which to accept websockets requests
--graphql Enable the GraphQL server --graphql Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.
--graphql.addr value GraphQL server listening interface (default: "localhost")
--graphql.port value GraphQL server listening port (default: 8547)
--graphql.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced) --graphql.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced)
--graphql.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost") --graphql.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost")
--rpc.gascap value Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite) (default: 25000000)
--rpc.txfeecap value Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap) (default: 1)
--jspath loadScript JavaScript root path for loadScript (default: ".") --jspath loadScript JavaScript root path for loadScript (default: ".")
--exec value Execute JavaScript statement --exec value Execute JavaScript statement
--preload value Comma separated list of JavaScript files to preload into the console --preload value Comma separated list of JavaScript files to preload into the console
NETWORKING OPTIONS: NETWORKING OPTIONS:
--bootnodes value Comma separated enode URLs for P2P discovery bootstrap (set v4+v5 instead for light servers) --bootnodes value Comma separated enode URLs for P2P discovery bootstrap
--bootnodesv4 value Comma separated enode URLs for P2P v4 discovery bootstrap (light server, full nodes) --bootnodesv4 value Comma separated enode URLs for P2P v4 discovery bootstrap (light server, full nodes) (deprecated, use --bootnodes)
--bootnodesv5 value Comma separated enode URLs for P2P v5 discovery bootstrap (light server, light nodes) --bootnodesv5 value Comma separated enode URLs for P2P v5 discovery bootstrap (light server, light nodes) (deprecated, use --bootnodes)
--discovery.dns value Sets DNS discovery entry points (use "" to disable DNS)
--port value Network listening port (default: 30303) --port value Network listening port (default: 30303)
--maxpeers value Maximum number of network peers (network disabled if set to 0) (default: 50) --maxpeers value Maximum number of network peers (network disabled if set to 0) (default: 50)
--maxpendpeers value Maximum number of pending connection attempts (defaults used if set to 0) (default: 0) --maxpendpeers value Maximum number of pending connection attempts (defaults used if set to 0) (default: 0)
@ -142,7 +152,7 @@ NETWORKING OPTIONS:
--netrestrict value Restricts network communication to the given IP networks (CIDR masks) --netrestrict value Restricts network communication to the given IP networks (CIDR masks)
--nodekey value P2P node key file --nodekey value P2P node key file
--nodekeyhex value P2P node key as hex (for testing) --nodekeyhex value P2P node key as hex (for testing)
MINER OPTIONS: MINER OPTIONS:
--mine Enable mining --mine Enable mining
--miner.threads value Number of CPU threads to use for mining (default: 0) --miner.threads value Number of CPU threads to use for mining (default: 0)
@ -154,16 +164,16 @@ MINER OPTIONS:
--miner.extradata value Block extra data set by the miner (default = client version) --miner.extradata value Block extra data set by the miner (default = client version)
--miner.recommit value Time interval to recreate the block being mined (default: 3s) --miner.recommit value Time interval to recreate the block being mined (default: 3s)
--miner.noverify Disable remote sealing verification --miner.noverify Disable remote sealing verification
GAS PRICE ORACLE OPTIONS: GAS PRICE ORACLE OPTIONS:
--gpoblocks value Number of recent blocks to check for gas prices (default: 20) --gpo.blocks value Number of recent blocks to check for gas prices (default: 20)
--gpopercentile value Suggested gas price is the given percentile of a set of recent transaction gas prices (default: 60) --gpo.percentile value Suggested gas price is the given percentile of a set of recent transaction gas prices (default: 60)
VIRTUAL MACHINE OPTIONS: VIRTUAL MACHINE OPTIONS:
--vmdebug Record information useful for VM and contract debugging --vmdebug Record information useful for VM and contract debugging
--vm.evm value External EVM configuration (default = built-in interpreter) --vm.evm value External EVM configuration (default = built-in interpreter)
--vm.ewasm value External ewasm configuration (default = built-in interpreter) --vm.ewasm value External ewasm configuration (default = built-in interpreter)
LOGGING AND DEBUGGING OPTIONS: LOGGING AND DEBUGGING OPTIONS:
--fakepow Disables proof-of-work verification --fakepow Disables proof-of-work verification
--nocompaction Disables db compaction after import --nocompaction Disables db compaction after import
@ -172,43 +182,57 @@ LOGGING AND DEBUGGING OPTIONS:
--backtrace value Request a stack trace at a specific logging statement (e.g. "block.go:271") --backtrace value Request a stack trace at a specific logging statement (e.g. "block.go:271")
--debug Prepends log messages with call-site location (file and line number) --debug Prepends log messages with call-site location (file and line number)
--pprof Enable the pprof HTTP server --pprof Enable the pprof HTTP server
--pprofaddr value pprof HTTP server listening interface (default: "127.0.0.1") --pprof.addr value pprof HTTP server listening interface (default: "127.0.0.1")
--pprofport value pprof HTTP server listening port (default: 6060) --pprof.port value pprof HTTP server listening port (default: 6060)
--memprofilerate value Turn on memory profiling with the given rate (default: 524288) --pprof.memprofilerate value Turn on memory profiling with the given rate (default: 524288)
--blockprofilerate value Turn on block profiling with the given rate (default: 0) --pprof.blockprofilerate value Turn on block profiling with the given rate (default: 0)
--cpuprofile value Write CPU profile to the given file --pprof.cpuprofile value Write CPU profile to the given file
--trace value Write execution trace to the given file --trace value Write execution trace to the given file
METRICS AND STATS OPTIONS: METRICS AND STATS OPTIONS:
--metrics Enable metrics collection and reporting --metrics Enable metrics collection and reporting
--metrics.expensive Enable expensive metrics collection and reporting --metrics.expensive Enable expensive metrics collection and reporting
--metrics.addr value Enable stand-alone metrics HTTP server listening interface (default: "127.0.0.1")
--metrics.port value Metrics HTTP server listening port (default: 6060)
--metrics.influxdb Enable metrics export/push to an external InfluxDB database --metrics.influxdb Enable metrics export/push to an external InfluxDB database
--metrics.influxdb.endpoint value InfluxDB API endpoint to report metrics to (default: "http://localhost:8086") --metrics.influxdb.endpoint value InfluxDB API endpoint to report metrics to (default: "http://localhost:8086")
--metrics.influxdb.database value InfluxDB database name to push reported metrics to (default: "geth") --metrics.influxdb.database value InfluxDB database name to push reported metrics to (default: "geth")
--metrics.influxdb.username value Username to authorize access to the database (default: "test") --metrics.influxdb.username value Username to authorize access to the database (default: "test")
--metrics.influxdb.password value Password to authorize access to the database (default: "test") --metrics.influxdb.password value Password to authorize access to the database (default: "test")
--metrics.influxdb.tags value Comma-separated InfluxDB tags (key/values) attached to all measurements (default: "host=localhost") --metrics.influxdb.tags value Comma-separated InfluxDB tags (key/values) attached to all measurements (default: "host=localhost")
WHISPER (EXPERIMENTAL) OPTIONS: WHISPER (EXPERIMENTAL) OPTIONS:
--shh Enable Whisper --shh Enable Whisper
--shh.maxmessagesize value Max message size accepted (default: 1048576) --shh.maxmessagesize value Max message size accepted (default: 1048576)
--shh.pow value Minimum POW accepted (default: 0.2) --shh.pow value Minimum POW accepted (default: 0.2)
--shh.restrict-light Restrict connection between two whisper light clients --shh.restrict-light Restrict connection between two whisper light clients
DEPRECATED OPTIONS: ALIASED (deprecated) OPTIONS:
--lightserv value Maximum percentage of time allowed for serving LES requests (deprecated, use --light.serve) (default: 0) --rpc Enable the HTTP-RPC server (deprecated, use --http)
--lightpeers value Maximum number of light clients to serve, or light servers to attach to (deprecated, use --light.maxpeers) (default: 100) --rpcaddr value HTTP-RPC server listening interface (deprecated, use --http.addr) (default: "localhost")
--minerthreads value Number of CPU threads to use for mining (deprecated, use --miner.threads) (default: 0) --rpcport value HTTP-RPC server listening port (deprecated, use --http.port) (default: 8545)
--targetgaslimit value Target gas floor for mined blocks (deprecated, use --miner.gastarget) (default: 8000000) --rpccorsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced) (deprecated, use --http.corsdomain)
--gasprice value Minimum gas price for mining a transaction (deprecated, use --miner.gasprice) (default: 1000000000) --rpcvhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (deprecated, use --http.vhosts) (default: "localhost")
--etherbase value Public address for block mining rewards (default = first account, deprecated, use --miner.etherbase) (default: "0") --rpcapi value API's offered over the HTTP-RPC interface (deprecated, use --http.api)
--extradata value Block extra data set by the miner (default = client version, deprecated, use --miner.extradata) --wsaddr value WS-RPC server listening interface (deprecated, use --ws.addr) (default: "localhost")
--wsport value WS-RPC server listening port (deprecated, use --ws.port) (default: 8546)
--wsorigins value Origins from which to accept websockets requests (deprecated, use --ws.origins)
--wsapi value API's offered over the WS-RPC interface (deprecated, use --ws.api)
--gpoblocks value Number of recent blocks to check for gas prices (deprecated, use --gpo.blocks) (default: 20)
--gpopercentile value Suggested gas price is the given percentile of a set of recent transaction gas prices (deprecated, use --gpo.percentile) (default: 60)
--graphql.addr value GraphQL server listening interface (deprecated, graphql can only be enabled on the HTTP-RPC server endpoint, use --graphql)
--graphql.port value GraphQL server listening port (deprecated, graphql can only be enabled on the HTTP-RPC server endpoint, use --graphql) (default: 8545)
--pprofport value pprof HTTP server listening port (deprecated, use --pprof.port) (default: 6060)
--pprofaddr value pprof HTTP server listening interface (deprecated, use --pprof.addr) (default: "127.0.0.1")
--memprofilerate value Turn on memory profiling with the given rate (deprecated, use --pprof.memprofilerate) (default: 524288)
--blockprofilerate value Turn on block profiling with the given rate (deprecated, use --pprof.blockprofilerate) (default: 0)
--cpuprofile value Write CPU profile to the given file (deprecated, use --pprof.cpuprofile)
MISC OPTIONS: MISC OPTIONS:
--override.istanbul value Manually specify Istanbul fork-block, overriding the bundled setting (default: 0) --snapshot Enables snapshot-database mode -- experimental work in progress feature
--help, -h show help --help, -h show help
COPYRIGHT: COPYRIGHT:
Copyright 2013-2019 The go-ethereum Authors Copyright 2013-2020 The go-ethereum Authors
``` ```