From dce9062d1bb9fa16885bf219c007c290f008fee5 Mon Sep 17 00:00:00 2001 From: Nils-Erik Frantzell Date: Sat, 19 May 2018 09:16:29 -0700 Subject: [PATCH] Add a "running eth" section which lists the output of 'eth --help' --- .../ethereum-clients/cpp-ethereum/running.rst | 107 +++++++++++++++++- 1 file changed, 105 insertions(+), 2 deletions(-) diff --git a/source/ethereum-clients/cpp-ethereum/running.rst b/source/ethereum-clients/cpp-ethereum/running.rst index 34c74930..13bf36b1 100644 --- a/source/ethereum-clients/cpp-ethereum/running.rst +++ b/source/ethereum-clients/cpp-ethereum/running.rst @@ -4,8 +4,111 @@ Running ################################################################################ -Running eth without any argument will synchronise your node to the public blockchain. -It is also possible to create or synchronise to another blockchain (see :ref:`custom blockchain using eth `). +Run ``eth --help`` to see the various command-line arguments. Running eth without any arguments will synchronise your node to the public blockchain. It is also possible to create or synchronise to another blockchain (see :ref:`custom blockchain using eth `). + + +**Running eth** +:: + + Usage eth [OPTIONS] + Options: + + Wallet usage: + account list List all keys available in wallet. + account new Create a new key and add it to the wallet. + account update [|
, ... ] Decrypt and re-encrypt given keys. + account import [||] Import keys from given source and place in wallet. + wallet import Import a presale wallet. + Client mode (default): + --mainnet Use the main network protocol. + --ropsten Use the Ropsten testnet. + --private Use a private chain. + --test Testing mode: Disable PoW and provide test rpc interface. + --config Configure specialised blockchain using given JSON information. + + --genesis Set genesis JSON file. + -o [ --mode ] Start a full node or a peer node (default: full). + + --ipc Enable IPC server (default: on). + --ipcpath Set .ipc socket path (default: data directory) + --no-ipc Disable IPC server. + --admin Specify admin session key for JSON-RPC (default: auto-generated and printed at start-up). + -K [ --kill ] Kill the blockchain first. + -R [ --rebuild ] Rebuild the blockchain from the existing database. + --rescue Attempt to rescue a corrupt database. + + --import-presale Import a pre-sale key; you'll need to specify the password to this key. + -s [ --import-secret ] Import a secret key into the key store. + -S [ --import-session-secret ] Import a secret session into the key store. + --master Give the master password for the key store. Use --master "" to show a prompt. + --password Give a password for a private key. + + Client transacting: + --ask Set the minimum ask gas price under which no transaction will be mined + (default 20000000000). + --bid Set the bid gas price to pay for transactions + (default 20000000000). + --unsafe-transactions Allow all transactions to proceed without verification. EXTREMELY UNSAFE. + + Client mining: + -a [ --address ] Set the author (mining payout) address to given address (default: auto). + -m [ --mining ] Enable mining, optionally for a specified number of blocks (default: off). + --extra-data arg Set extra data for the sealed blocks. + + Client networking: + -b [ --bootstrap ] Connect to the default Ethereum peer servers (default unless --no-discovery used). + --no-bootstrap Do not connect to the default Ethereum peer servers (default only when --no-discovery is used). + -x [ --peers ] Attempt to connect to a given number of peers (default: 11). + --peer-stretch Give the accepted connection multiplier (default: 7). + --public-ip Force advertised public IP to the given IP (default: auto). + --listen-ip (:) Listen on the given IP for incoming connections (default: 0.0.0.0). + --listen Listen on the given port for incoming connections (default: 30303). + -r [ --remote ] (:) Connect to the given remote host (default: none). + --port Connect to the given remote port (default: 30303). + --network-id Only connect to other hosts with this network id. + --peerset Space delimited list of peers; element format: type:publickey@ipAddress[:port]. + Types: + default Attempt connection when no other peers are available and pinning is disabled. + required Keep connected at all times. + + --no-discovery Disable node discovery, implies --no-bootstrap. + --pin Only accept or connect to trusted peers. + Work farming mode: + --no-precompute Don't precompute the next epoch's DAG. + Ethash verify mode: + -w,--check-pow Check PoW credentials for validity. + + Benchmarking mode: + -M,--benchmark Benchmark for mining and exit; use with --cpu and --opencl. + --benchmark-warmup Set the duration of warmup for the benchmark tests (default: 3). + --benchmark-trial Set the duration for each trial for the benchmark tests (default: 3). + --benchmark-trials Set the number of trials for the benchmark tests (default: 5). + DAG creation mode: + -D,--create-dag Create the DAG in preparation for mining on given block and exit. + Mining configuration: + -C,--cpu When mining, use the CPU. + -t, --mining-threads Limit number of CPU/GPU miners to n (default: use everything available on selected platform) + --current-block Let the miner know the current block number at configuration time. Will help determine DAG size and required GPU memory. + --disable-submit-hashrate When mining, don't submit hashrate to node. + Import/export modes: + -I [ --import ] Import blocks from file. + -E [ --export ] Export blocks to file. + --from Export only from block n; n may be a decimal, a '0x' prefixed hash, or 'latest'. + --to Export only to block n (inclusive); n may be a decimal, a '0x' prefixed hash, or 'latest'. + --only Equivalent to --export-from n --export-to n. + --format Set export format. + --dont-check Prevent checking some block aspects. Faster importing, but to apply only when the data is known to be valid. + --download-snapshot Download Parity Warp Sync snapshot data to the specified path. + --import-snapshot Import blockchain and state data from the Parity Warp Sync snapshot. + + General Options: + -d [ --db-path ] Load database from path + (default: C:\Users\nilse\AppData\Roaming\Ethereum). + + -v [ --verbosity ] <0 - 15> Set the log verbosity from 0 to 15 (default: 1). + -V [ --version ] Show the version and exit. + -h [ --help ] Show this help message and exit. + Interacting with your node can be done using either geth or the ethereum console: