Update README.md

wind775 · Aug 15, 2016 · 51bdedb · 51bdedb
1 parent 8ea071f
commit 51bdedb
Showing 1 changed file with 61 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -38,9 +38,68 @@
 
 ### *使用方法* :lollipop:
 在Mac OS X El Capitan下的帮助输出: 
+```
+$ ./client_darwin_amd64 -h
+NAME:
+   kcptun - kcptun client
+
+USAGE:
+   client_darwin_amd64 [global options] command [command options] [arguments...]
+
+VERSION:
+   20160811
+
+COMMANDS:
+     help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --localaddr value, -l value   local listen address (default: ":12948")
+   --remoteaddr value, -r value  kcp server address (default: "vps:29900")
+   --key value                   key for communcation, must be the same as kcptun server (default: "it's a secrect") [$KCPTUN_KEY]
+   --crypt value                 methods for encryption: aes, tea, xor, none (default: "aes")
+   --mode value                  mode for communication: fast3, fast2, fast, normal (default: "fast")
+   --conn value                  establish N physical connections as specified by 'conn' to server (default: 1)
+   --mtu value                   set MTU of UDP packets, suggest 'tracepath' to discover path mtu (default: 1350)
+   --sndwnd value                set send window size(num of packets) (default: 128)
+   --rcvwnd value                set receive window size(num of packets) (default: 1024)
+   --nocomp                      disable compression
+   --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)
+   --help, -h                    show help
+   --version, -v                 print the version
+```
 
-![client](client.png)
-![server](server.png)
+```
+$ ./server_darwin_amd64 -h
+NAME:
+   kcptun - kcptun server
+
+USAGE:
+   server_darwin_amd64 [global options] command [command options] [arguments...]
+
+VERSION:
+   20160811
+
+COMMANDS:
+     help, h  Shows a list of commands or help for one command
+
+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               key for communcation, must be the same as kcptun client (default: "it's a secrect") [$KCPTUN_KEY]
+   --crypt value             methods for encryption: aes, tea, xor, none (default: "aes")
+   --mode value              mode for communication: fast3, fast2, fast, normal (default: "fast")
+   --mtu value               set MTU of UDP packets, suggest 'tracepath' to discover path mtu (default: 1350)
+   --sndwnd value            set send window size(num of packets) (default: 1024)
+   --rcvwnd value            set receive window size(num of packets) (default: 1024)
+   --nocomp                  disable compression
+   --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)
+   --help, -h                show help
+   --version, -v             print the version
+```
 
 ### *参数调整* :lollipop: 
 ***两端参数必须一致的有:***