add newly arranged man pages

This commit contains rearranged man pages for shadowsocks-libev and the
five executables.

Makefile.am

@@ -1,7 +1,8 @@
 SUBDIRS = libsodium libcork libipset libudns libev src
 
 ACLOCAL_AMFLAGS = -I m4
-man_MANS = shadowsocks-libev.8
+man_MANS = shadowsocks-libev.8 ss-server.1 ss-local.1 ss-redir.1\
+	   ss-manager.1 ss-tunnel.1
 
 pkgconfiglibdir = $(libdir)/pkgconfig
 pkgconfiglib_DATA = shadowsocks-libev.pc

shadowsocks-libev.8

@@ -2,7 +2,7 @@
 . manual page for shadowsocks-libev
 .
 . Copyright (c) 2012-2015, by: Max Lv
-. All rights reserved.      
+. All rights reserved.
 .
 . Permission is granted to copy, distribute and/or modify this document
 . under the terms of the GNU Free Documentation License, Version 1.1 or
@@ -17,41 +17,40 @@
 . entitled "GNU Free Documentation License".
 .
 ..
-
 \#                          - these two are for chuckles, makes great grammar
 .ds Lo  \fBss-local\fR
 .ds Re  \fBss-redir\fR
 .ds Se  \fBss-server\fR
 .ds Tu  \fBss-tunnel\fR
 .ds Ma  \fBss-manager\fR
-.ds Me  \fBShadowsocks\fR
-
-.TH SHADOWSOCKS-LIBEV 8 "January 7, 2015"
+.ds Me  \fBShadowsocks-libev\fR
+.
+.TH "SHADOWSOCKS-LIBEV" "8" "September 10, 2015" "SHADOWSOCKS-LIBEV"
 .SH NAME
 shadowsocks-libev \- a lightweight and secure socks5 proxy
 
 .SH SYNOPSIS
 \*(Lo|\*(Re|\*(Se|\*(Tu|\*(Ma
-    \-s server_host     \-p server_port    
-    \-l local_port      \-k password    
-    \-m encrypt_method  \-f pid_file
-    \-t timeout         \-c config_file
+    [\fB\-s\fR \fIserver_host\fR]     [\fB\-p\fR \fIserver_port\fR]
+    [\fB\-l\fR \fIlocal_port\fR]      [\fB\-k\fR \fIpassword\fR]
+    [\fB\-m\fR \fIencrypt_method\fR]  [\fB\-f\fR \fIpid_file\fR]
+    [\fB\-t\fR \fItimeout\fR]         [\fB\-c\fR \fIconfig_file\fR]
 
 .SH DESCRIPTION
 \*(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 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.
+\*(Me consists of five components. One is \*(Se(1) that runs on a remote server
+to provide secured tunnel service. \*(Lo(1) and \*(Re(1) are clients on your local
+machines to proxy TCP traffic. \*(Tu(1) is a tool for local port forwarding.
 .PP
-While \*(Lo works as a standard socks5 proxy, \*(Re works as a transparent proxy
+While \*(Lo(1) works as a standard socks5 proxy, \*(Re(1) works as a transparent proxy
 and requires netfilter's NAT module. For more information, check out the example
 section.
 .PP
-\*(Ma is a controller for multi-user management and traffic statistics, using UNIX
-domain socket to talk with \*(Se. Also, it provides a UNIX domain socket or IP based
+\*(Ma(1) is a controller for multi-user management and traffic statistics, using UNIX
+domain socket to talk with \*(Se(1). Also, it provides a UNIX domain socket or IP based
 API for other software. About the details of this API, please refer to the protocol
 section.
 
@@ -70,11 +69,14 @@ Set the local port number.
 Set the password. The server and the client should use the same password.
 .TP
 .B \-m \fIencrypt_method\fP
-Set the cipher. Shadowsocks accepts 16 different ciphers: table, rc4, rc4-md5,
+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
+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
@@ -86,33 +88,60 @@ Set the socket timeout in seconds. The default value is 10.
 .B \-c \fIconfig_file\fP
 Use a configuration file.
 .TP
+.B \-i \fIinterface\fP
+Specify network interface to bind.
+
+Not available in redir mode.
+.TP
+.B \-b \fIlocal_address\fP
+Specify local address to bind.
+
+Not available in server mode.
+.TP
 .B \-a \fIuser_name\fP
 Run as a specific user.
 .TP
-.B \-d \fIaddr\fP
-Setup the name servers for libudns. The default server is fetched from
-/etc/resolv.conf.
-.TP
 .B \-u
 Enable UDP relay.
+TPROXY is required in redir mode.
+.TP
+.B \-U
+Enable UDP relay and disable TCP relay.
+Not available in local mode.
 .TP
 .B \-A
 Enable onetime authentication.
 .TP
-.B \-v
-Enable verbose mode.
+.B \-L \fIaddr\fR:\fIport\fP
+Specify destination server address and port for local port forwarding.
+
+Only available in tunnel mode.
+.TP
+.B \-d \fIaddr\fP
+Setup name servers for internal DNS resolver (libudns). The default server
+is fetched from /etc/resolv.conf.
+
+Only available in server mode.
 .TP
 .B \--fast-open
 Enable TCP fast open.
+
+Only available in local and server mode, with Linux kernel > 3.7.0.
 .TP
 .B \--acl \fIacl_config\fP
-Enable ACL (Access Control List).
+Enable ACL (Access Control List) and specify config file.
+Only available in local and server mode.
 .TP
 .B \--manager-address \fIpath_to_unix_domain\fP
-Enable manager mode.
+Specify UNIX domain socket address.
+Only available in server and manager mode.
 .TP
 .B \--executable \fIpath_to_server_executable\fP
-Specify the executable path of ss-server for manager mode.
+Specify the executable path of ss-server.
+Only available in manager mode.
+.TP
+.B \-v
+Enable verbose mode.
 
 .SH EXAMPLE
 \*(Re requires netfilter's NAT function. Here is an example:
@@ -152,29 +181,34 @@ Specify the executable path of ss-server for manager mode.
     root@Wrt:~# ss-redir -u -c /etc/config/shadowsocks.json -f /var/run/shadowsocks.pid
 
 .SH PROTOCOL
-\*(Ma provides several APIs through UDP protocol:
+\*(Ma(1) provides several APIs through UDP protocol:
 
-    Send UDP commands in the following format to the manager-address provided to \*(Ma.
+    Send UDP commands in the following format to the manager-address provided to \*(Ma(1).
 
         command: [JSON data]
 
     To add a port:
 
         add: {"server_port": 8001, "password":"7cd308cc059"}
-    
+
     To remove a port:
 
         remove: {"server_port": 8001}
-    
+
     To receive a pong:
 
         ping
-    
-    Then \*(Ma will send back the traffic statistics:
+
+    Then \*(Ma(1) will send back the traffic statistics:
 
         stat: {"8001":11370}
 
 .SH SEE ALSO
+.BR \*(Lo (1),
+.BR \*(Se (1),
+.BR \*(Tu (1),
+.BR \*(Re (1),
+.BR \*(Ma (1),
 .BR iptables (8),
 /etc/shadowsocks-libev/config.json
 .br
@@ -184,3 +218,5 @@ shadowsocks-libev was maintained by Max Lv <[email protected]> and Linus Yang
 <[email protected]>.
 .PP
 This manual page was written by Max Lv <[email protected]>.
+.PP
+The manual pages were rearranged by hosiet <[email protected]>.

ss-local.1

@@ -0,0 +1,130 @@
+.ig
+. manual page for shadowsocks-libev
+.
+. Copyright (c) 2012-2015, by: Max Lv
+. All rights reserved.
+.
+. Permission is granted to copy, distribute and/or modify this document
+. under the terms of the GNU Free Documentation License, Version 1.1 or
+. any later version published by the Free Software Foundation;
+. with no Front-Cover Texts, no Back-Cover Texts, and with the following
+. Invariant Sections (and any sub-sections therein):
+.   all .ig sections, including this one
+.   STUPID TRICKS Sampler
+.   AUTHOR
+.
+. A copy of the Free Documentation License is included in the section
+. entitled "GNU Free Documentation License".
+.
+..
+\#                          - these two are for chuckles, makes great grammar
+.ds Lo  \fBss-local\fR
+.ds Re  \fBss-redir\fR
+.ds Se  \fBss-server\fR
+.ds Tu  \fBss-tunnel\fR
+.ds Ma  \fBss-manager\fR
+.ds Me  \fBShadowsocks-libev\fR
+.
+.TH "SS-LOCAL" "1" "September 10, 2015" "SHADOWSOCKS-LIBEV"
+.SH NAME
+ss-local \- shadowsocks client as socks5 proxy, libev port
+
+.SH SYNOPSIS
+\*(Lo
+    [\fB\-Auhv\fR]
+    [\fB\-s\fR \fIserver_host\fR] [\fB\-p\fR \fIserver_port\fR]    [\fB\-l\fR \fIlocal_port\fR]
+    [\fB\-k\fR \fIpassword\fR]    [\fB\-m\fR \fIencrypt_method\fR] [\fB\-f\fR \fIpid_file\fR]   [\fB\-t\fR \fItimeout\fR]
+    [\fB\-c\fR \fIconfig_file\fR] [\fB\-b\fR \fIinterface\fR]      [\fB\-a\fR \fIuser_name\fR]
+    [\fB\-\-fast\-open\fR]    [\fB\-\-acl\fR \fIacl_config\fR]
+
+.SH DESCRIPTION
+\*(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 five components. \*(Lo(1) works as a standard socks5 proxy
+on local machines to proxy TCP traffic. For more information, check out \fBshadowsocks-libev\fR(8).
+
+.SH OPTIONS
+.TP
+.B \-s \fIserver_host\fP
+Set the server's hostname or IP.
+.TP
+.B \-p \fIserver_port\fP
+Set the server's port number.
+.TP
+.B \-l \fIlocal_port\fP
+Set the local port number.
+.TP
+.B \-k \fIpassword\fP
+Set the password. The server and the client should use the same password.
+.TP
+.B \-m \fIencrypt_method\fP
+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 specific pid file.
+.TP
+.B \-t \fItimeout\fP
+Set the socket timeout in seconds. The default value is 10.
+.TP
+.B \-c \fIconfig_file\fP
+Use a configuration file.
+.TP
+.B \-i \fIinterface\fP
+Specify network interface to bind.
+.TP
+.B \-b \fIlocal_address\fP
+Specify local address to bind.
+.TP
+.B \-a \fIuser_name\fP
+Run as a specific user.
+.TP
+.B \-u
+Enable UDP relay.
+.TP
+.B \-A
+Enable onetime authentication.
+.TP
+.B \--fast-open
+Enable TCP fast open.
+
+Only available with Linux kernel > 3.7.0.
+.TP
+.B \--acl \fIacl_config\fP
+Enable ACL (Access Control List) and specify config file.
+.TP
+.B \-v
+Enable verbose mode.
+
+.SH EXAMPLE
+\*(Lo(1) can be started from command line and run in foreground. Here is an example:
+
+    # Start ss-local with given parameters
+    ss-local -s example.com -p 12345 -l 1080 -k foobar -m aes-256-cfb
+
+.SH SEE ALSO
+.BR \*(Se (1),
+.BR \*(Tu (1),
+.BR \*(Re (1),
+.BR \*(Ma (1),
+.BR shadowsocks-libev (8),
+.BR iptables (8),
+/etc/shadowsocks-libev/config.json
+.br
+.SH AUTHOR
+shadowsocks was created by clowwindy <[email protected]> and
+shadowsocks-libev was maintained by Max Lv <[email protected]> and Linus Yang
+<[email protected]>.
+.PP
+This manual page was written by Max Lv <[email protected]>.
+.PP
+The manual pages were rearranged by hosiet <[email protected]>.