From dfb7d2b637b557f0373db7e416126c4403c00029 Mon Sep 17 00:00:00 2001 From: 5chdn <5chdn@users.noreply.github.com> Date: Tue, 29 Aug 2017 15:25:30 +0200 Subject: [PATCH] Update README with new commands --- README.md | 45 +++++++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 56e38c4e..03026802 100644 --- a/README.md +++ b/README.md @@ -171,37 +171,42 @@ Full list of cli options, which is available under `pbtc --help` ``` pbtc 0.1.0 -Parity Technologies -Parity bitcoin client +Parity Technologies +Parity Bitcoin client USAGE: pbtc [FLAGS] [OPTIONS] [SUBCOMMAND] FLAGS: + --bitcoin-cash Use Bitcoin Cash verification rules. -h, --help Prints help information - --no-jsonrpc Disable the JSON-RPC API server - --print-to-console Send sync info to console - --regtest Use private network for regtest - --testnet Use the test network + --no-jsonrpc Disable the JSON-RPC API server. + --print-to-console Show synchronization information in your console. + --regtest Use a private network for regression tests. + --segwit2x Enable SegWit2x verification rules. + --testnet Use the test network (Testnet3). -V, --version Prints version information OPTIONS: - --blocknotify Execute command when the best block changes (%s in cmd is replaced by block hash) - -c, --connect Connect only to the specified node - -d, --data-dir Specify the database & configuration directory PATH - --db-cache Sets db cache size - --jsonrpc-apis Specify the APIs available through the JSONRPC interface. APIS is a comma-delimited list of API name. - --jsonrpc-cors Specify CORS header for JSON-RPC API responses - --jsonrpc-hosts List of allowed Host header values - --jsonrpc-interface The hostname portion of the JSONRPC API server - --jsonrpc-port The port portion of the JSONRPC API server - --only-net Only connect to nodes in network (ipv4 or ipv6) - --port Listen for connections on PORT - -s, --seednode Connect to a node to retrieve peer addresses, and disconnect + --blocknotify Execute command when the best block changes (%s in cmd is replaced by the block hash). + -c, --connect Connect only to the specified node. + -d, --data-dir Specify the database and configuration directory PATH. + --db-cache Sets the database cache size. + --jsonrpc-apis Specify the APIs available through the JSONRPC interface. APIS is a comma-delimited list of API names. + --jsonrpc-cors Specify CORS header for JSON-RPC API responses. + --jsonrpc-hosts List of allowed Host header values. + --jsonrpc-interface The hostname portion of the JSONRPC API server. + --jsonrpc-port Specify the PORT for the JSONRPC API server. + --only-net Only connect to nodes in network version (ipv4 or ipv6). + --port Listen for connections on PORT. + -s, --seednode Connect to a seed-node to retrieve peer addresses, and disconnect. + --verification-edge Non-default verification-level is applied until a block with given hash is met. + --verification-level Sets the Blocks verification level to full (default), header (scripts are not verified), or none (no verification at all). SUBCOMMANDS: - help Prints this message or the help of the given subcommand(s) - import Import blocks from bitcoin core database + help Prints this message or the help of the given subcommand(s) + import Import blocks from a Bitcoin Core database. + rollback Rollback the database to given canonical-chain block. ``` ## JSON-RPC