From cda5126689f2acc97987ab6bb5f640157058cf32 Mon Sep 17 00:00:00 2001 From: xuminready Date: Thu, 19 Jul 2018 00:47:24 -0700 Subject: [PATCH] Update README.md update Usage. encrypt methods are outdated. --- README.md | 85 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 47 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 2dc8cf06..c235f527 100644 --- a/README.md +++ b/README.md @@ -375,74 +375,83 @@ you may refer to the man pages of the applications, respectively. ss-[local|redir|server|tunnel|manager] - -s host name or ip address of your remote server + -s Host name or IP address of your remote server. - -p port number of your remote server + -p Port number of your remote server. - -l port number of your local server + -l Port number of your local server. - -k password of your remote server + -k Password of your remote server. - -m Encrypt method: rc4-md5, + -m Encrypt method: rc4-md5, aes-128-gcm, aes-192-gcm, aes-256-gcm, aes-128-cfb, aes-192-cfb, aes-256-cfb, aes-128-ctr, aes-192-ctr, aes-256-ctr, camellia-128-cfb, camellia-192-cfb, camellia-256-cfb, bf-cfb, - chacha20-poly1305, chacha20-ietf-poly1305 + chacha20-ietf-poly1305, + xchacha20-ietf-poly1305, salsa20, chacha20 and chacha20-ietf. + The default cipher is chacha20-ietf-poly1305. - [-f ] the file path to store pid + [-a ] Run as another user. + + [-f ] The file path to store pid. - [-t ] socket timeout in seconds + [-t ] Socket timeout in seconds. - [-c ] the path to config file + [-c ] The path to config file. + + [-n ] Max number of open files. - [-i ] network interface to bind, - not available in redir mode + [-i ] Network interface to bind. + (not available in redir mode) - [-b ] local address to bind + [-b ] Local address to bind. - [-u] enable udprelay mode, - TPROXY is required in redir mode + [-u] Enable UDP relay. + (TPROXY is required in redir mode) - [-U] enable UDP relay and disable TCP relay, - not available in local mode + [-U] Enable UDP relay and disable TCP relay. + (not available in local mode) - [-L :] specify destination server address and port - for local port forwarding, - only available in tunnel mode + [-L :] Destination server address and port + for local port forwarding. + (only available in tunnel mode) [-6] Resovle hostname to IPv6 address first. - [-d ] setup name servers for internal DNS resolver, - only available in server mode - + [-d ] Name servers for internal DNS resolver. + (only available in server mode) + [--reuse-port] Enable port reuse. - - [--fast-open] enable TCP fast open, - only available in local and server mode, - with Linux kernel > 3.7.0 - - [--acl ] config file of ACL (Access Control List) - only available in local and server mode - - [--manager-address ] UNIX domain socket address - only available in server and manager mode + + [--fast-open] Enable TCP fast open. + with Linux kernel > 3.7.0. + (only available in local and server mode) + + [--acl ] Path to ACL (Access Control List). + (only available in local and server mode) + + [--manager-address ] UNIX domain socket address. + (only available in server and manager mode) [--mtu ] MTU of your network interface. - + [--mptcp] Enable Multipath TCP on MPTCP Kernel. - + [--no-delay] Enable TCP_NODELAY. - [--executable ] path to the executable of ss-server - only available in manager mode - + [--executable ] Path to the executable of ss-server. + (only available in manager mode) + + [--key ] Key of your remote server. + [--plugin ] Enable SIP003 plugin. (Experimental) + [--plugin-opts ] Set SIP003 plugin options. (Experimental) - [-v] verbose mode + [-v] Verbose mode. ## Transparent proxy