diff --git a/README.md b/README.md index 7b4e71f5..9e9ca4c3 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,12 @@ Features -------- Shadowsocks-libev is writen in C and only depends on -[libev](http://software.schmorp.de/pkg/libev.html). When statically linked and -packaged for OpenWRT, the total binary size is 23KB. In normal usage, the memory -consumption is about 600KB and the CPU utilization is no more than 5%, which is tested -in a low-end router (Buffalo WHR-G300N V2 with a 400MHz MIPS CPU, 32MB memory -and 4MB flash). +[libev](http://software.schmorp.de/pkg/libev.html). + +When statically linked and packaged for OpenWRT, the total package size is 23KB. +In normal usage, the memory consumption is about 600KB and the CPU utilization is +no more than 5% on a low-end router (Buffalo WHR-G300N V2 with a 400MHz MIPS CPU, +32MB memory and 4MB flash). Installation ------------ @@ -40,10 +41,16 @@ Usage ----- ``` - usage: ss -s server_host -p server_port -l local_port - -k password [-m encrypt_method] [-f pid_file] +usage: + + ss -s server_host -p server_port -l local_port -k password + [-m encrypt_method] [-f pid_file] [-t timeout] [-c config_file] + +options: + + encrypt_method: table, rc4 + pid_file: valid path to the pid file + timeout: socket timeout in senconds + config_file: json format config file - info: - -m: accept two encrypt methods, "table" or "rc4" - -f: run in backgroud, with a valid path to the pid_file ``` diff --git a/utils.c b/utils.c index f591a1a0..346460b1 100644 --- a/utils.c +++ b/utils.c @@ -10,12 +10,16 @@ void FATAL(const char *msg) { } void usage() { - printf("usage: ss -s server_host -p server_port -l local_port\n"); - printf(" -k password [-m encrypt_method] [-f pid_file]\n"); + printf("usage:\n\n"); + printf(" ss -s server_host -p server_port -l local_port -k password\n"); + printf(" [-m encrypt_method] [-f pid_file] [-t timeout] [-c config_file]\n"); printf("\n"); - printf("options:\n"); - printf(" encrypt_method: table, rc4\n"); - printf(" pid_file: valid path to the pid file\n"); + printf("options:\n\n"); + printf(" encrypt_method: table, rc4\n"); + printf(" pid_file: valid path to the pid file\n"); + printf(" timeout: socket timeout in senconds\n"); + printf(" config_file: json format config file\n"); + printf("\n\n"); } void demonize(const char* path) {