diff --git a/programs/cli_wallet/cli_wallet.1 b/programs/cli_wallet/cli_wallet.1 new file mode 100644 index 0000000000..984518965c --- /dev/null +++ b/programs/cli_wallet/cli_wallet.1 @@ -0,0 +1,81 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH CLI_WALLET "1" "September 2019" "cli_wallet 2.0.171025-minor-fix-1-2549-g991bd756" "User Commands" +.SH NAME +cli_wallet - Start the bitshares command line wallet. +.SH SYNOPSIS +\fBcli_wallet\fR [OPTIONS]... +.SH DESCRIPTION +Command Line BitShares Wallet +.SH OPTIONS +.TP +\fB\-h\fR [ \fB\-\-help\fR ] +Print this help message and exit. +.TP +\fB\-s\fR [ \fB\-\-server\-rpc\-endpoint\fR ] [=arg(=ws://127.0.0.1:8090)] +Server websocket RPC endpoint +.TP +\fB\-u\fR [ \fB\-\-server\-rpc\-user\fR ] arg +Server Username +.TP +\fB\-p\fR [ \fB\-\-server\-rpc\-password\fR ] arg +Server Password +.TP +\fB\-r\fR [ \fB\-\-rpc\-endpoint\fR ] [=arg(=127.0.0.1:8091)] +Endpoint for wallet websocket RPC to +listen on (DEPRECATED, use +rpc\-http\-endpoint instead) +.TP +\fB\-t\fR [ \fB\-\-rpc\-tls\-endpoint\fR ] [=arg(=127.0.0.1:8092)] +Endpoint for wallet websocket TLS RPC +to listen on +.TP +\fB\-c\fR [ \fB\-\-rpc\-tls\-certificate\fR ] [=arg(=server.pem)] +PEM certificate for wallet websocket +TLS RPC +.TP +\fB\-H\fR [ \fB\-\-rpc\-http\-endpoint\fR ] [=arg(=127.0.0.1:8093)] +Endpoint for wallet HTTP and websocket +RPC to listen on +.TP +\fB\-d\fR [ \fB\-\-daemon\fR ] +Run the wallet in daemon mode +.TP +\fB\-w\fR [ \fB\-\-wallet\-file\fR ] [=arg(=wallet.json)] +wallet to load +.TP +\fB\-\-chain\-id\fR arg +chain ID to connect to +.TP +\fB\-\-suggest\-brain\-key\fR +Suggest a safe brain key to use for +creating your account +.TP +\fB\-\-logs\-rpc\-console\-level\fR arg (=info) +Level of console logging. Allowed +levels: info, debug, warn, error, all +.TP +\fB\-\-logs\-rpc\-file\fR arg (=0) +Turn on/off file logging +.TP +\fB\-\-logs\-rpc\-file\-level\fR arg (=debug) +Level of file logging. Allowed levels: +info, debug, warn, error, all +.TP +\fB\-\-logs\-rpc\-file\-name\fR arg (=rpc.log) +File name for file rpc logs +.TP +\fB\-v\fR [ \fB\-\-version\fR ] +Display version information +.PP +SHA: 991bd756d7db1cf6d790b11bff05f28e625f735a +Timestamp: 35 hours ago +SSL: OpenSSL 1.1.1 11 Sep 2018 +Boost: 1.65.1 +Websocket++: 0.7.0 +.SH AUTHOR +The BitShares Core Team and contributors. +.SH "REPORTING BUGS" +https://github.com/bitshares/bitshares-core/issues/ +.SH COPYRIGHT + +The MIT license. diff --git a/programs/cli_wallet/cli_wallet.h2m b/programs/cli_wallet/cli_wallet.h2m new file mode 100644 index 0000000000..345b83e8e0 --- /dev/null +++ b/programs/cli_wallet/cli_wallet.h2m @@ -0,0 +1,15 @@ +[NAME] +cli_wallet - Start the bitshares command line wallet. + +[SYNOPSIS] +\fBcli_wallet\fR [OPTIONS]... + +[AUTHOR] +The BitShares Core Team and contributors. + +[REPORTING BUGS] +https://github.com/bitshares/bitshares-core/issues/ + +[COPYRIGHT] + +The MIT license. diff --git a/programs/cli_wallet/main.cpp b/programs/cli_wallet/main.cpp index 39d24dd91f..82638ab94a 100644 --- a/programs/cli_wallet/main.cpp +++ b/programs/cli_wallet/main.cpp @@ -126,7 +126,7 @@ int main( int argc, char** argv ) { try { - boost::program_options::options_description opts; + boost::program_options::options_description opts("Command Line BitShares Wallet\n\nOptions"); opts.add_options() ("help,h", "Print this help message and exit.") ("server-rpc-endpoint,s", bpo::value()->implicit_value("ws://127.0.0.1:8090"), "Server websocket RPC endpoint") diff --git a/programs/witness_node/main.cpp b/programs/witness_node/main.cpp index 845087968b..c7ebd63860 100644 --- a/programs/witness_node/main.cpp +++ b/programs/witness_node/main.cpp @@ -63,7 +63,7 @@ int main(int argc, char** argv) { app::application* node = new app::application(); fc::oexception unhandled_exception; try { - bpo::options_description app_options("BitShares Witness Node"); + bpo::options_description app_options("BitShares Witness Node\n\nOptions"); bpo::options_description cfg_options("BitShares Witness Node"); app_options.add_options() ("help,h", "Print this help message and exit.") diff --git a/programs/witness_node/witness_node.1 b/programs/witness_node/witness_node.1 new file mode 100644 index 0000000000..7cf9fbb4f2 --- /dev/null +++ b/programs/witness_node/witness_node.1 @@ -0,0 +1,423 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH WITNESS_NODE "1" "September 2019" "witness_node 2.0.171025-minor-fix-1-2549-g991bd756" "User Commands" +.SH NAME +witness_node - Start the bitshares core program. +.SH SYNOPSIS +\fBwitness_node\fR [OPTIONS]... +.SH DESCRIPTION +BitShares Witness Node +.SH OPTIONS +.TP +\fB\-h\fR [ \fB\-\-help\fR ] +Print this help message and exit. +.TP +\fB\-d\fR [ \fB\-\-data\-dir\fR ] arg (="witness_node_data_dir") +Directory containing databases, +configuration file, etc. +.TP +\fB\-v\fR [ \fB\-\-version\fR ] +Display version information +.TP +\fB\-\-plugins\fR arg (=witness account_history market_history grouped_orders api_helper_indexes) +Space\-separated list of plugins to +activate +.TP +\fB\-\-ignore\-api\-helper\-indexes\-warning\fR +Do not exit if api_helper_indexes +plugin is not enabled. +.TP +\fB\-\-replay\-blockchain\fR +Rebuild object graph by replaying all +blocks without validation +.TP +\fB\-\-revalidate\-blockchain\fR +Rebuild object graph by replaying all +blocks with full validation +.TP +\fB\-\-resync\-blockchain\fR +Delete all blocks and re\-sync with +network from scratch +.TP +\fB\-\-force\-validate\fR +Force validation of all transactions +during normal operation +.TP +\fB\-\-genesis\-timestamp\fR arg +Replace timestamp from genesis.json +with current time plus this many +seconds (experts only!) +.TP +\fB\-\-p2p\-endpoint\fR arg +Endpoint for P2P node to listen on +.TP +\fB\-s\fR [ \fB\-\-seed\-node\fR ] arg +P2P nodes to connect to on startup (may +specify multiple times) +.TP +\fB\-\-seed\-nodes\fR arg +JSON array of P2P nodes to connect to +on startup +.TP +\fB\-c\fR [ \fB\-\-checkpoint\fR ] arg +Pairs of [BLOCK_NUM,BLOCK_ID] that +should be enforced as checkpoints. +.TP +\fB\-\-rpc\-endpoint\fR [=arg(=127.0.0.1:8090)] +Endpoint for websocket RPC to listen on +.TP +\fB\-\-rpc\-tls\-endpoint\fR [=arg(=127.0.0.1:8089)] +Endpoint for TLS websocket RPC to +listen on +.TP +\fB\-p\fR [ \fB\-\-server\-pem\fR ] [=arg(=server.pem)] +The TLS certificate file for this +server +.TP +\fB\-P\fR [ \fB\-\-server\-pem\-password\fR ] arg +Password for this certificate +.TP +\fB\-\-genesis\-json\fR arg +File to read Genesis State from +.TP +\fB\-\-dbg\-init\-key\fR arg +Block signing key to use for init +witnesses, overrides genesis file +.TP +\fB\-\-api\-access\fR arg +JSON file specifying API permissions +.TP +\fB\-\-io\-threads\fR [=arg(=0)] +Number of IO threads, default to 0 for +auto\-configuration +.TP +\fB\-\-enable\-subscribe\-to\-all\fR [=arg(=1)] +Whether allow API clients to subscribe +to universal object creation and +removal events +.TP +\fB\-\-enable\-standby\-votes\-tracking\fR [=arg(=1)] +Whether to enable tracking of votes of +standby witnesses and committee +members. Set it to true to provide +accurate data to API clients, set to +false for slightly better performance. +.TP +\fB\-\-api\-limit\-get\-account\-history\-operations\fR arg (=100) +For history_api::get_account_history_op +erations to set max limit value +.TP +\fB\-\-api\-limit\-get\-account\-history\fR arg (=100) +For history_api::get_account_history to +set max limit value +.TP +\fB\-\-api\-limit\-get\-grouped\-limit\-orders\fR arg (=101) +For orders_api::get_grouped_limit_order +s to set max limit value +.TP +\fB\-\-api\-limit\-get\-relative\-account\-history\fR arg (=100) +For history_api::get_relative_account_h +istory to set max limit value +.TP +\fB\-\-api\-limit\-get\-account\-history\-by\-operations\fR arg (=100) +For history_api::get_account_history_by +_operations to set max limit value +.TP +\fB\-\-api\-limit\-get\-asset\-holders\fR arg (=100) +For asset_api::get_asset_holders to set +max limit value +.TP +\fB\-\-api\-limit\-get\-key\-references\fR arg (=100) +For database_api_impl::get_key_referenc +es to set max limit value +.TP +\fB\-\-api\-limit\-get\-htlc\-by\fR arg (=100) +For database_api_impl::get_htlc_by_from +and get_htlc_by_to to set max limit +value +.TP +\fB\-\-api\-limit\-get\-full\-accounts\fR arg (=10) +For database_api_impl::get_full_account +s to set max limit value +.TP +\fB\-\-api\-limit\-get\-full\-accounts\-lists\fR arg (=100) +For database_api_impl::get_full_account +s to set max limit value +.TP +\fB\-\-api\-limit\-get\-call\-orders\fR arg (=300) +For database_api_impl::get_call_orders +and get_call_orders_by_account to set +max limit value +.TP +\fB\-\-api\-limit\-get\-settle\-orders\fR arg (=300) +For database_api_impl::get_settle_order +s and get_settle_orders_by_account to +set max limit value +.TP +\fB\-\-api\-limit\-get\-assets\fR arg (=101) +For database_api_impl::list_assets and +get_assets_by_issuer to set max limit +value +.TP +\fB\-\-api\-limit\-get\-limit\-orders\fR arg (=300) +For database_api_impl::get_limit_orders +to set max limit value +.TP +\fB\-\-api\-limit\-get\-order\-book\fR arg (=50) +For database_api_impl::get_order_book +to set max limit value +.TP +\fB\-\-api\-limit\-lookup\-accounts\fR arg (=1000) +For database_api_impl::lookup_accounts +to set max limit value +.TP +\fB\-\-api\-limit\-lookup\-witness\-accounts\fR arg (=1000) +For database_api_impl::lookup_witness_a +ccounts to set max limit value +.TP +\fB\-\-api\-limit\-lookup\-committee\-member\-accounts\fR arg (=1000) +For database_api_impl::lookup_committee +_member_accounts to set max limit value +.TP +\fB\-\-api\-limit\-lookup\-vote\-ids\fR arg (=1000) +For database_api_impl::lookup_vote_ids +to set max limit value +.TP +\fB\-\-api\-limit\-get\-account\-limit\-orders\fR arg (=101) +For database_api_impl::get_account_limi +t_orders to set max limit value +.TP +\fB\-\-api\-limit\-get\-collateral\-bids\fR arg (=100) +For database_api_impl::get_collateral_b +ids to set max limit value +.TP +\fB\-\-api\-limit\-get\-top\-markets\fR arg (=100) +For database_api_impl::get_top_markets +to set max limit value +.TP +\fB\-\-api\-limit\-get\-trade\-history\fR arg (=100) +For database_api_impl::get_trade_histor +y to set max limit value +.TP +\fB\-\-api\-limit\-get\-trade\-history\-by\-sequence\fR arg (=100) +For database_api_impl::get_trade_histor +y_by_sequence to set max limit value +.TP +\fB\-\-api\-limit\-get\-withdraw\-permissions\-by\-giver\fR arg (=101) +For database_api_impl::get_withdraw_per +missions_by_giver to set max limit +value +.TP +\fB\-\-api\-limit\-get\-withdraw\-permissions\-by\-recipient\fR arg (=101) +For database_api_impl::get_withdraw_per +missions_by_recipient to set max limit +value +.PP +witness plugin. +Options: +.TP +\fB\-\-enable\-stale\-production\fR +Enable block production, even if the +chain is stale. +.TP +\fB\-\-required\-participation\fR arg (=33) +Percent of witnesses (0\-100) that must +be participating in order to produce +blocks +.TP +\fB\-w\fR [ \fB\-\-witness\-id\fR ] arg +ID of witness controlled by this node +(e.g. "1.6.5", quotes are required, may +specify multiple times) +.TP +\fB\-\-private\-key\fR arg (=["BTS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV","5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"]) +Tuple of [PublicKey, WIF private key] +(may specify multiple times) +.TP +\fB\-\-private\-key\-file\fR arg +Path to a file containing tuples of +[PublicKey, WIF private key]. The file +has to contain exactly one tuple (i.e. +private \- public key pair) per line. +This option may be specified multiple +times, thus multiple files can be +provided. +.PP +debug_witness plugin. +Options: +.TP +\fB\-\-debug\-private\-key\fR arg (=["BTS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV","5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"]) +Tuple of [PublicKey, WIF private key] +(may specify multiple times) +.PP +account_history plugin. +Options: +.TP +\fB\-\-track\-account\fR arg +Account ID to track history for (may +specify multiple times) +.TP +\fB\-\-partial\-operations\fR arg +Keep only those operations in memory +that are related to account history +tracking +.TP +\fB\-\-max\-ops\-per\-account\fR arg +Maximum number of operations per +account will be kept in memory +.PP +elasticsearch plugin. Stores account history data in elasticsearch database(EXPERIMENTAL). +Options: +.TP +\fB\-\-elasticsearch\-node\-url\fR arg +Elastic Search database node +url(http://localhost:9200/) +.TP +\fB\-\-elasticsearch\-bulk\-replay\fR arg +Number of bulk documents to index on +replay(10000) +.TP +\fB\-\-elasticsearch\-bulk\-sync\fR arg +Number of bulk documents to index on a +syncronied chain(100) +.TP +\fB\-\-elasticsearch\-visitor\fR arg +Use visitor to index additional +data(slows down the replay(false)) +.TP +\fB\-\-elasticsearch\-basic\-auth\fR arg +Pass basic auth to elasticsearch +database('') +.TP +\fB\-\-elasticsearch\-index\-prefix\fR arg +Add a prefix to the index(bitshares\-) +.TP +\fB\-\-elasticsearch\-operation\-object\fR arg +Save operation as object(false) +.TP +\fB\-\-elasticsearch\-start\-es\-after\-block\fR arg +Start doing ES job after block(0) +.TP +\fB\-\-elasticsearch\-operation\-string\fR arg +Save operation as string. Needed to +serve history api calls(true) +.TP +\fB\-\-elasticsearch\-mode\fR arg +Mode of operation: only_save(0), +only_query(1), all(2) \- Default: 0 +.PP +market_history plugin. +Options: +.TP +\fB\-\-bucket\-size\fR arg (=[60,300,900,1800,3600,14400,86400]) +Track market history by grouping orders +into buckets of equal size measured in +seconds specified as a JSON array of +numbers +.TP +\fB\-\-history\-per\-size\fR arg (=1000) +How far back in time to track history +for each bucket size, measured in the +number of buckets (default: 1000) +.TP +\fB\-\-max\-order\-his\-records\-per\-market\fR arg (=1000) +Will only store this amount of matched +orders for each market in order history +for querying, or those meet the other +option, which has more data (default: +1000) +.TP +\fB\-\-max\-order\-his\-seconds\-per\-market\fR arg (=259200) +Will only store matched orders in last +X seconds for each market in order +history for querying, or those meet the +other option, which has more data +(default: 259200 (3 days)) +.PP +delayed_node plugin. +Options: +.TP +\fB\-\-trusted\-node\fR arg +RPC endpoint of a trusted validating +node (required for delayed_node) +.PP +snapshot plugin. Create snapshots at a specified time or block number. +Options: +.TP +\fB\-\-snapshot\-at\-block\fR arg +Block number after which to do a +snapshot +.TP +\fB\-\-snapshot\-at\-time\fR arg +Block time (ISO format) after which to +do a snapshot +.TP +\fB\-\-snapshot\-to\fR arg +Pathname of JSON file where to store +the snapshot +.PP +es_objects plugin. Stores blockchain objects in ES database. Experimental. +Options: +.TP +\fB\-\-es\-objects\-elasticsearch\-url\fR arg +Elasticsearch node url(http://localhost +:9200/) +.TP +\fB\-\-es\-objects\-auth\fR arg +Basic auth username:password('') +.TP +\fB\-\-es\-objects\-bulk\-replay\fR arg +Number of bulk documents to index on +replay(10000) +.TP +\fB\-\-es\-objects\-bulk\-sync\fR arg +Number of bulk documents to index on a +synchronized chain(100) +.TP +\fB\-\-es\-objects\-proposals\fR arg +Store proposal objects(true) +.TP +\fB\-\-es\-objects\-accounts\fR arg +Store account objects(true) +.TP +\fB\-\-es\-objects\-assets\fR arg +Store asset objects(true) +.TP +\fB\-\-es\-objects\-balances\fR arg +Store balances objects(true) +.TP +\fB\-\-es\-objects\-limit\-orders\fR arg +Store limit order objects(true) +.TP +\fB\-\-es\-objects\-asset\-bitasset\fR arg +Store feed data(true) +.TP +\fB\-\-es\-objects\-index\-prefix\fR arg +Add a prefix to the index(objects\-) +.TP +\fB\-\-es\-objects\-keep\-only\-current\fR arg +Keep only current state of the +objects(true) +.HP +\fB\-\-es\-objects\-start\-es\-after\-block\fR arg Start doing ES job after block(0) +.PP +grouped_orders plugin. +Options: +.TP +\fB\-\-tracked\-groups\fR arg (=[10,100]) +Group orders by percentage increase on +price. Specify a JSON array of numbers +here, each number is a group, number 1 +means 0.01%. +.PP +SHA: 991bd756d7db1cf6d790b11bff05f28e625f735a +Timestamp: 34 hours ago +SSL: OpenSSL 1.1.1 11 Sep 2018 +Boost: 1.65.1 +Websocket++: 0.7.0 +.SH AUTHOR +The BitShares Core Team and contributors. +.SH "REPORTING BUGS" +https://github.com/bitshares/bitshares-core/issues/ +.SH COPYRIGHT + +The MIT license. diff --git a/programs/witness_node/witness_node.h2m b/programs/witness_node/witness_node.h2m new file mode 100644 index 0000000000..e45a870859 --- /dev/null +++ b/programs/witness_node/witness_node.h2m @@ -0,0 +1,15 @@ +[NAME] +witness_node - Start the bitshares core program. + +[SYNOPSIS] +\fBwitness_node\fR [OPTIONS]... + +[AUTHOR] +The BitShares Core Team and contributors. + +[REPORTING BUGS] +https://github.com/bitshares/bitshares-core/issues/ + +[COPYRIGHT] + +The MIT license.