From f5993db9df64def2dd6fab316650c8932680c0f9 Mon Sep 17 00:00:00 2001 From: qiluge <19525062+qiluge@users.noreply.github.com> Date: Thu, 22 Nov 2018 13:06:39 +0800 Subject: [PATCH] fix cli argument typos mistake at docs (#695) --- docs/specifications/candidate_node_install_zh.md | 4 ++-- docs/specifications/cli_user_guide.md | 12 ++++++------ docs/specifications/cli_user_guide_CN.md | 14 +++++++------- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/specifications/candidate_node_install_zh.md b/docs/specifications/candidate_node_install_zh.md index 822b9b58d8..59322fea5e 100644 --- a/docs/specifications/candidate_node_install_zh.md +++ b/docs/specifications/candidate_node_install_zh.md @@ -16,14 +16,14 @@ curl    | sh` 3、把生成的钱包文件 wallet.dat拷贝到ontology二进制目录下，执行命令 ./ontology account list -v  确认Public key和之前提交的保持一致。注意：不能用同一个钱包开启2条链。 -4、后台运行 `./ontology --rest --enableconsensus` +4、后台运行 `./ontology --rest --enable-consensus` ※如果希望指定rest端口可以通过 `--restport 20334`指定，默认为20334端口) 对应的防火墙策略：20334、20338 面向all。如果是基于云服务，同时还要确保云服务的网络安全配置上打开了20338,20334端口。 如果后台运行,可以构建如下的shell脚本，命名为start.sh： ``` #! /bin/bash -./ontology --rest --enableconsensus<log & ``` diff --git a/docs/specifications/cli_user_guide.md b/docs/specifications/cli_user_guide.md index 2e73db744b..8371a1fb92 100644 --- a/docs/specifications/cli_user_guide.md +++ b/docs/specifications/cli_user_guide.md @@ -129,7 +129,7 @@ The networkid parameter is used to specify the network ID. Different networkids The nodeport parameter is used to specify the P2P network port number. The default value is 20338. --consensusport -The consensusport parameter specifies the consensus network port number. By default, the consensus network reuses the P2P network, so it is not necessary to specify a consensus network port. After the dual network is enabled with the --dualport parameter, the consensus network port number must be set separately. The default is 20339. +The consensusport parameter specifies the consensus network port number. By default, the consensus network reuses the P2P network, so it is not necessary to specify a consensus network port. After the dual network is enabled with the --dual-port parameter, the consensus network port number must be set separately. The default is 20339. --dual-port The dual-port parameter initiates a dual network, i.e. a P2P network for processing transaction messages and a consensus network for consensus messages. The parameter disables by default. @@ -188,7 +188,7 @@ The disable-broadcast-net-tx is used to disable broadcast a transaction from net #### 1.2.1 MainNet Bookkeeping Node Deployment -According to different roles of nodes, they can be divided into bookkeeping nodes and synchronization nodes. Bookkeeping nodes participate in the network consensus, and synchronization nodes only synchronize the blocks generated by the bookkeeping nodes. Since Ontology node won't start consensus by default, consensus must be turned on by the --enableconsensus parameter. The Ontology node will start the RPC server by default and output the event log of the smart contract. Therefore, if there is no special requirement, you can use the --disablerpc and --disableeventlog command line parameters to turn off the RPC and eventlog modules. +According to different roles of nodes, they can be divided into bookkeeping nodes and synchronization nodes. Bookkeeping nodes participate in the network consensus, and synchronization nodes only synchronize the blocks generated by the bookkeeping nodes. Since Ontology node won't start consensus by default, consensus must be turned on by the --enable-consensus parameter. The Ontology node will start the RPC server by default and output the event log of the smart contract. Therefore, if there is no special requirement, you can use the --disable-rpc and --disable-event-log command line parameters to turn off the RPC and eventlog modules. Recommended bookkeeping node startup parameters: @@ -784,8 +784,8 @@ Block export #### 6.2.1 Importing Block Parameters ---datadir -The datadir parameter specifies the storage path of the block data. The default value is "./Chain". +--data-dir +The data-dir parameter specifies the storage path of the block data. The default value is "./Chain". --networkid The networkid parameter is used to specify the network ID. Default value is 1, means MainNet network ID. @@ -793,8 +793,8 @@ The networkid parameter is used to specify the network ID. Default value is 1, m --config The config parameter specifies the file path of the genesis block for the current Ontolgy node. Default value is main net config. ---disableeventlog -The disableeventlog parameter is used to disable the event log output when the smart contract is executed to improve the node transaction execution performance. The Ontology node enables the event log output function by default. +--disable-event-log +The disable-event-log parameter is used to disable the event log output when the smart contract is executed to improve the node transaction execution performance. The Ontology node enables the event log output function by default. --endheight The endheight parameter specifies the end height of the imported block. If the block height specified by --endheight is less than the maximum height of the block file, it will only be imported to the height specified by --endheight and the rest blocks will stop importing. The default value is 0, which means import all the blocks. diff --git a/docs/specifications/cli_user_guide_CN.md b/docs/specifications/cli_user_guide_CN.md index f401a5fdce..21cf458309 100644 --- a/docs/specifications/cli_user_guide_CN.md +++ b/docs/specifications/cli_user_guide_CN.md @@ -135,7 +135,7 @@ networkid 参数用于指定网络ID，networkid不同将无法连接到区块 nodeport 参数用于指定P2P网络端口号，默认值为20338。 --consensus-port -consensus-port 参数用于指定共识网络端口号。默认情况下，共识网络复用P2P网络，因此不需要指定共识网络端口，在通过--dualport参数启动双网络后，则需要单独设置共识网络端口号。默认值为20339。 +consensus-port 参数用于指定共识网络端口号。默认情况下，共识网络复用P2P网络，因此不需要指定共识网络端口，在通过--dual-port参数启动双网络后，则需要单独设置共识网络端口号。默认值为20339。 --dual-port dual-port 参数启动双网络，即用于处理交易消息的P2P网络，和用于共识消息的共识网络。默认不开启。 @@ -143,7 +143,7 @@ dual-port 参数启动双网络，即用于处理交易消息的P2P网络，和 #### 1.1.5 RPC 服务器参数 --disable-rpc -disablerpc 参数用于关闭rpc服务器。Ontology节点在启动时会默认启动rpc服务器。 +disable-rpc 参数用于关闭rpc服务器。Ontology节点在启动时会默认启动rpc服务器。 --rpcport rpcport 参数用指定rpc服务器绑定的端口号。默认值为20336。 @@ -193,7 +193,7 @@ disable-broadcast-net-tx 参数用于关闭交易池广播来自网络的交易 #### 1.2.1 主网记账节点部署 -按照角色不同，节点可以分为记账节点和同步节点，记账节点参与网络共识，而同步节点只同步记账节点生成的区块。由于Ontology默认是不启动共识模块的，因此部署记账节点需要通过--enableconsensus命令行参数开启共。此外，Ontology节点默认会启动Rpc服务器，同时会输出智能合约输出的Event Log，因此如果没有特殊要求，可以使用--disablerpc和--disableeventlog命令行参数关闭rpc和eventlog模块。 +按照角色不同，节点可以分为记账节点和同步节点，记账节点参与网络共识，而同步节点只同步记账节点生成的区块。由于Ontology默认是不启动共识模块的，因此部署记账节点需要通过--enable-consensus命令行参数开启共识。此外，Ontology节点默认会启动Rpc服务器，同时会输出智能合约输出的Event Log，因此如果没有特殊要求，可以使用--disable-rpc和--disable-event-log命令行参数关闭rpc和eventlog模块。 推荐记账节点启动参数： @@ -782,14 +782,14 @@ speed 参数指定导出速度。分别用h表示high，m表示middle，l表示l #### 6.2.1 导入区块参数 ---datadir -datadir 参数用于指定区块数据存储目录 +--data-dir +data-dir 参数用于指定区块数据存储目录 --config config 参数用于指定当前Ontology节点创世区块配置文件的路径。如果不指定，将使用Ontolog主网的创世块配置。 ---disableeventlog -disableeventlog 参数用于关闭导入区块时生成合约日志功能。 +--disable-event-log +disable-event-log 参数用于关闭导入区块时生成合约日志功能。 --networkid networkid 参数用于指定需要导入的网路ID。默认值为主网networkid。