Alawn/shadowsocks-libev
1
0
Fork 0
mirror of https://github.com/shadowsocks/shadowsocks-libev.git synced 2026-11-04 17:36:57 +00:00
Code Releases Activity

update documents

Browse Source
This commit is contained in:
Max Lv
2015-01-07 10:05:44 +08:00
parent 6dac73f63a
commit cf222a9b4e
3 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -2
View File
@@ -217,8 +217,8 @@ usage:
[-m <encrypt_method>] encrypt method: table, rc4, rc4-md5
aes-128-cfb, aes-192-cfb, aes-256-cfb,
bf-cfb, camellia-128-cfb, camellia-192-cfb,
camellia-256-cfb, cast5-cfb, des-cfb,
idea-cfb, rc2-cfb and seed-cfb
camellia-256-cfb, cast5-cfb, des-cfb, idea-cfb,
rc2-cfb, seed-cfb, salsa20 and chacha20
[-f <pid_file>] file to store the pid
[-t <timeout>] socket timeout in seconds
[-c <config_file>] config file in json
shadowsocks-libev.8
+24 -24
View File
@@ -1,7 +1,7 @@
.ig
. manual page for shadowsocks-libev
.
. Copyright (c) 2012-2013, by: Max Lv
. Copyright (c) 2012-2015, by: Max Lv
. All rights reserved.
.
. Permission is granted to copy, distribute and/or modify this document
@@ -22,11 +22,12 @@
.ds Lo \fBss-local\fR
.ds Re \fBss-redir\fR
.ds Se \fBss-server\fR
.ds Me \fBshadowsocks\fR
.ds Tu \fBss-tunnel\fR
.ds Me \fBShadowsocks\fR
.TH SHADOWSOCKS-LIBEV 8 "August 18, 2014"
.TH SHADOWSOCKS-LIBEV 8 "January 7, 2015"
.SH NAME
shadowsocks-libev \- a lightweight secured scoks5 proxy
shadowsocks-libev \- a lightweight and secure scoks5 proxy
.SH SYNOPSIS
\*(Lo|\*(Re|\*(Se
@@ -36,43 +37,42 @@ shadowsocks-libev \- a lightweight secured scoks5 proxy
\-t timeout \-c config_file
.SH DESCRIPTION
\*(Me is a lightweight secured socks5 proxy. It is a port of
the original shadowsocks created by clowwindy. \*(Me is written in pure
C and takes advantage of \fBlibev\fP to provide a socks5 proxy with both high
performance and low resource consumption.
\*(Me is a lightweight and secure socks5 proxy. It is a port of the original
shadowsocks created by clowwindy. \*(Me is written in pure C and takes advantage
of \fBlibev\fP to achieve both high performance and low resource consumption.
.PP
\*(Me consists of three components. One is \*(Se that runs on a remote server
to provide secured tunnel service. \*(Lo and \*(Re are clients that run on your
local machines for proxying all your TCP traffic.
\*(Me consists of four components. One is \*(Se that runs on a remote server
to provide secured tunnel service. \*(Lo and \*(Re are clients on your local
machines to proxy TCP traffic. \*(Tu is a tool for local port forwarding.
.PP
While \*(Lo is a standard socks5 proxy, \*(Re works as a transparent proxy and
requires netfilter's NAT function. For more information, check out the example
While \*(Lo works as a standard socks5 proxy, \*(Re works as a transparent proxy
and requires netfilter's NAT module. For more information, check out the example
section.
.SH OPTIONS
.TP
.B \-s \fIserver_host\fP
Set the shadowsocks server host.
Set the server's hostname or IP.
.TP
.B \-p \fIserver_port\fP
Set the shadowsocks server port.
Set the server's port number.
.TP
.B \-l \fIlocal_port\fP
Listen on the local port.
Set the local port number.
.TP
.B \-k \fIpassword\fP
Set the shadowsocks password. The server and the client should use the same
password.
Set the password. The server and the client should use the same password.
.TP
.B \-m \fIencrypt_method\fP
Set the cipher. Shadowsocks accepts 14 different ciphers: table, rc4,
rc4-md5, aes-128-cfb, aes-192-cfb, aes-256-cfb, bf-cfb, camellia-128-cfb,
camellia-192-cfb, camellia-256-cfb, cast5-cfb, des-cfb, idea-cfb, rc2-cfb
and seed-cfb. The default method is \fItable\fP. If compiled with PolarSSL
or custom OpenSSL builds, some of these ciphers may not work.
Set the cipher. Shadowsocks accepts 16 different ciphers: table, rc4, rc4-md5,
aes-128-cfb, aes-192-cfb, aes-256-cfb, bf-cfb, camellia-128-cfb,
camellia-192-cfb, camellia-256-cfb, cast5-cfb, des-cfb, idea-cfb, rc2-cfb,
seed-cfb, salsa20 and chacha20. The default cipher is \fItable\fP. If
built with PolarSSL or custom OpenSSL libraries, some of these ciphers may
not work.
.TP
.B \-f \fIpid_file\fP
Start shadowsocks as a daemon with a specific pid file.
Start shadowsocks as a daemon with specific pid file.
.TP
.B \-t \fItimeout\fP
Set the socket timeout in secondes. The default value is 10.
src/utils.c
+2 -2
View File
@@ -214,9 +214,9 @@ void usage()
printf(
" bf-cfb, camellia-128-cfb, camellia-192-cfb,\n");
printf(
" camellia-256-cfb, cast5-cfb, des-cfb,\n");
" camellia-256-cfb, cast5-cfb, des-cfb, idea-cfb,\n");
printf(
" idea-cfb, rc2-cfb and seed-cfb\n");
" rc2-cfb, seed-cfb, salsa20 and chacha20\n");
printf(" [-f <pid_file>] file to store the pid\n");
printf(" [-t <timeout>] socket timeout in seconds\n");
printf(" [-c <config_file>] config file in json\n");