diff --git a/README.en.md b/README.en.md index ced87a3..25cb826 100644 --- a/README.en.md +++ b/README.en.md @@ -44,13 +44,13 @@ Help output under MacOS X: ``` $ ./client_darwin_amd64 -h NAME: - kcptun - kcptun client + kcptun - client(with SMUX) USAGE: client_darwin_amd64 [global options] command [command options] [arguments...] VERSION: - 20160820 + 20160922 COMMANDS: help, h Shows a list of commands or help for one command @@ -58,30 +58,32 @@ COMMANDS: GLOBAL OPTIONS: --localaddr value, -l value local listen address (default: ":12948") --remoteaddr value, -r value kcp server address (default: "vps:29900") - --key value pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY] + --key value pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY] --crypt value aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes") --mode value profiles: fast3, fast2, fast, normal (default: "fast") --conn value set num of UDP connections to server (default: 1) - --mtu value set maximum transmission unit of UDP packets (default: 1350) + --autoexpire value set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0) + --mtu value set maximum transmission unit for UDP packets (default: 1350) --sndwnd value set send window size(num of packets) (default: 128) --rcvwnd value set receive window size(num of packets) (default: 1024) --datashard value set reed-solomon erasure coding - datashard (default: 10) --parityshard value set reed-solomon erasure coding - parityshard (default: 3) --dscp value set DSCP(6bit) (default: 0) --nocomp disable compression + --log value specify a log file to output, default goes to stderr + -c value config from json file, which will override the command from shell --help, -h show help --version, -v print the version - $ ./server_darwin_amd64 -h NAME: - kcptun - kcptun server + kcptun - server(with SMUX) USAGE: server_darwin_amd64 [global options] command [command options] [arguments...] VERSION: - 20160820 + 20160922 COMMANDS: help, h Shows a list of commands or help for one command @@ -89,16 +91,18 @@ COMMANDS: GLOBAL OPTIONS: --listen value, -l value kcp server listen address (default: ":29900") --target value, -t value target server address (default: "127.0.0.1:12948") - --key value pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY] + --key value pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY] --crypt value aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes") --mode value profiles: fast3, fast2, fast, normal (default: "fast") - --mtu value set maximum transmission unit of UDP packets (default: 1350) + --mtu value set maximum transmission unit for UDP packets (default: 1350) --sndwnd value set send window size(num of packets) (default: 1024) --rcvwnd value set receive window size(num of packets) (default: 1024) --datashard value set reed-solomon erasure coding - datashard (default: 10) --parityshard value set reed-solomon erasure coding - parityshard (default: 3) --dscp value set DSCP(6bit) (default: 0) --nocomp disable compression + --log value specify a log file to output, default goes to stderr + -c value config from json file, which will override the command from shell --help, -h show help --version, -v print the version ``` diff --git a/README.md b/README.md index c9acc0a..b09c3b7 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,13 @@ ``` $ ./client_darwin_amd64 -h NAME: - kcptun - kcptun client + kcptun - client(with SMUX) USAGE: client_darwin_amd64 [global options] command [command options] [arguments...] VERSION: - 20160820 + 20160922 COMMANDS: help, h Shows a list of commands or help for one command @@ -55,30 +55,32 @@ COMMANDS: GLOBAL OPTIONS: --localaddr value, -l value local listen address (default: ":12948") --remoteaddr value, -r value kcp server address (default: "vps:29900") - --key value pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY] + --key value pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY] --crypt value aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes") --mode value profiles: fast3, fast2, fast, normal (default: "fast") --conn value set num of UDP connections to server (default: 1) - --mtu value set maximum transmission unit of UDP packets (default: 1350) + --autoexpire value set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0) + --mtu value set maximum transmission unit for UDP packets (default: 1350) --sndwnd value set send window size(num of packets) (default: 128) --rcvwnd value set receive window size(num of packets) (default: 1024) --datashard value set reed-solomon erasure coding - datashard (default: 10) --parityshard value set reed-solomon erasure coding - parityshard (default: 3) --dscp value set DSCP(6bit) (default: 0) --nocomp disable compression + --log value specify a log file to output, default goes to stderr + -c value config from json file, which will override the command from shell --help, -h show help --version, -v print the version - $ ./server_darwin_amd64 -h NAME: - kcptun - kcptun server + kcptun - server(with SMUX) USAGE: server_darwin_amd64 [global options] command [command options] [arguments...] VERSION: - 20160820 + 20160922 COMMANDS: help, h Shows a list of commands or help for one command @@ -86,16 +88,18 @@ COMMANDS: GLOBAL OPTIONS: --listen value, -l value kcp server listen address (default: ":29900") --target value, -t value target server address (default: "127.0.0.1:12948") - --key value pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY] + --key value pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY] --crypt value aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes") --mode value profiles: fast3, fast2, fast, normal (default: "fast") - --mtu value set maximum transmission unit of UDP packets (default: 1350) + --mtu value set maximum transmission unit for UDP packets (default: 1350) --sndwnd value set send window size(num of packets) (default: 1024) --rcvwnd value set receive window size(num of packets) (default: 1024) --datashard value set reed-solomon erasure coding - datashard (default: 10) --parityshard value set reed-solomon erasure coding - parityshard (default: 3) --dscp value set DSCP(6bit) (default: 0) --nocomp disable compression + --log value specify a log file to output, default goes to stderr + -c value config from json file, which will override the command from shell --help, -h show help --version, -v print the version ``` @@ -256,7 +260,7 @@ type Snmp struct { 对该项目的捐款将用于[gonet/2](http://gonet2.github.io/)游戏服务器框架的研发。 -```特别感谢: 郑H立, 南D风, Li, 七q, 凌J,昶,Les*ables, Ky*n, 噼**啦, *斌, 小苍** 等,名字已做特殊处理。``` +```特别感谢: 郑H立, 南D风, Li, 七q, 凌J,昶,Les*ables, Ky*n, 噼**啦, *斌, 小苍**, Ken 等,名字已做特殊处理。``` ### *参考资料* :paperclip: 1. https://github.com/skywind3000/kcp -- KCP - A Fast and Reliable ARQ Protocol.