Browse Source

Update docs

pull/2259/head
Simon Shi 6 years ago
parent
commit
e5d8476afe
4 changed files with 25 additions and 16 deletions
  1. 27
      README.md
  2. 10
      doc/ss-manager.asciidoc
  3. 2
      src/manager.c
  4. 2
      src/utils.c

27
README.md

@ -383,7 +383,7 @@ you may refer to the man pages of the applications, respectively.
-k <password> Password of your remote server. -k <password> Password of your remote server.
-m <encrypt_method> Encrypt method: rc4-md5,
-m <encrypt_method> Encrypt method: rc4-md5,
aes-128-gcm, aes-192-gcm, aes-256-gcm, aes-128-gcm, aes-192-gcm, aes-256-gcm,
aes-128-cfb, aes-192-cfb, aes-256-cfb, aes-128-cfb, aes-192-cfb, aes-256-cfb,
aes-128-ctr, aes-192-ctr, aes-256-ctr, aes-128-ctr, aes-192-ctr, aes-256-ctr,
@ -395,13 +395,13 @@ you may refer to the man pages of the applications, respectively.
The default cipher is chacha20-ietf-poly1305. The default cipher is chacha20-ietf-poly1305.
[-a <user>] Run as another user. [-a <user>] Run as another user.
[-f <pid_file>] The file path to store pid. [-f <pid_file>] The file path to store pid.
[-t <timeout>] Socket timeout in seconds. [-t <timeout>] Socket timeout in seconds.
[-c <config_file>] The path to config file. [-c <config_file>] The path to config file.
[-n <number>] Max number of open files. [-n <number>] Max number of open files.
[-i <interface>] Network interface to bind. [-i <interface>] Network interface to bind.
@ -423,32 +423,35 @@ you may refer to the man pages of the applications, respectively.
[-d <addr>] Name servers for internal DNS resolver. [-d <addr>] Name servers for internal DNS resolver.
(only available in server mode) (only available in server mode)
[--reuse-port] Enable port reuse. [--reuse-port] Enable port reuse.
[--fast-open] Enable TCP fast open. [--fast-open] Enable TCP fast open.
with Linux kernel > 3.7.0. with Linux kernel > 3.7.0.
(only available in local and server mode) (only available in local and server mode)
[--acl <acl_file>] Path to ACL (Access Control List). [--acl <acl_file>] Path to ACL (Access Control List).
(only available in local and server mode) (only available in local and server mode)
[--manager-address <addr>] UNIX domain socket address. [--manager-address <addr>] UNIX domain socket address.
(only available in server and manager mode) (only available in server and manager mode)
[--mtu <MTU>] MTU of your network interface. [--mtu <MTU>] MTU of your network interface.
[--mptcp] Enable Multipath TCP on MPTCP Kernel. [--mptcp] Enable Multipath TCP on MPTCP Kernel.
[--no-delay] Enable TCP_NODELAY. [--no-delay] Enable TCP_NODELAY.
[--executable <path>] Path to the executable of ss-server. [--executable <path>] Path to the executable of ss-server.
(only available in manager mode) (only available in manager mode)
[-D <path>] Path to the working directory of ss-manager.
(only available in manager mode)
[--key <key_in_base64>] Key of your remote server. [--key <key_in_base64>] Key of your remote server.
[--plugin <name>] Enable SIP003 plugin. (Experimental) [--plugin <name>] Enable SIP003 plugin. (Experimental)
[--plugin-opts <options>] Set SIP003 plugin options. (Experimental) [--plugin-opts <options>] Set SIP003 plugin options. (Experimental)
[-v] Verbose mode. [-v] Verbose mode.

10
doc/ss-manager.asciidoc

@ -12,7 +12,7 @@ SYNOPSIS
[-s <server_host>] [-p <server_port>] [-l <local_port>] [-s <server_host>] [-p <server_port>] [-l <local_port>]
[-k <password>] [-m <encrypt_method>] [-f <pid_file>] [-k <password>] [-m <encrypt_method>] [-f <pid_file>]
[-t <timeout>] [-c <config_file>] [-i <interface>] [-t <timeout>] [-c <config_file>] [-i <interface>]
[-b <local_addr>] [-a <user_name>]
[-b <local_addr>] [-a <user_name>] [-D <path>]
[--manager-address <path_to_unix_domain>] [--manager-address <path_to_unix_domain>]
[--executable <path_to_server_executable>] [--executable <path_to_server_executable>]
[--fast-open] [--reuse-port] [--fast-open] [--reuse-port]
@ -116,6 +116,11 @@ Specify the executable path of ss-server.
+ +
Only available in manager mode. Only available in manager mode.
--executable <path_to_server_executable>::
Specify the working directory of ss-manager.
+
Only available in manager mode.
--plugin <plugin_name>:: --plugin <plugin_name>::
Enable SIP003 plugin. (Experimental) Enable SIP003 plugin. (Experimental)
@ -148,7 +153,7 @@ The format of the traffic statistics: ::::
stat: {"8001":11370} stat: {"8001":11370}
There is no way to reset the traffic statistics, unless you remove the port and add it again There is no way to reset the traffic statistics, unless you remove the port and add it again
EXAMPLE EXAMPLE
------- -------
To use `ss-manager`(1), First start it and specify necessary information. To use `ss-manager`(1), First start it and specify necessary information.
@ -178,4 +183,3 @@ SEE ALSO
`shadowsocks-libev`(8), `shadowsocks-libev`(8),
`iptables`(8), `iptables`(8),
/etc/shadowsocks-libev/config.json /etc/shadowsocks-libev/config.json

2
src/manager.c

@ -1161,7 +1161,7 @@ main(int argc, char **argv)
if (strstr(homedir, "nologin") || strstr(homedir, "nonexistent") || homedir == NULL || strlen(homedir) == 0) { if (strstr(homedir, "nologin") || strstr(homedir, "nonexistent") || homedir == NULL || strlen(homedir) == 0) {
homedir = "/tmp"; homedir = "/tmp";
} }
LOGI("File path changed to %s", homedir);
LOGI("working directory points to %s", homedir);
} }
working_dir_size = strlen(homedir) + 15; working_dir_size = strlen(homedir) + 15;
working_dir = ss_malloc(working_dir_size); working_dir = ss_malloc(working_dir_size);

2
src/utils.c

@ -388,6 +388,8 @@ usage()
#ifdef MODULE_MANAGER #ifdef MODULE_MANAGER
printf( printf(
" [--executable <path>] Path to the executable of ss-server.\n"); " [--executable <path>] Path to the executable of ss-server.\n");
printf(
" [-D <path>] Path to the working directory of ss-manager.\n");
#endif #endif
printf( printf(
" [--mtu <MTU>] MTU of your network interface.\n"); " [--mtu <MTU>] MTU of your network interface.\n");

Loading…
Cancel
Save