'\" t
.\"     Title: ss-tunnel
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 11/23/2017
.\"    Manual: Shadowsocks-libev Manual
.\"    Source: Shadowsocks-libev 3.1.1
.\"  Language: English
.\"
.TH "SS\-TUNNEL" "1" "11/23/2017" "Shadowsocks\-libev 3\&.1\&.1" "Shadowsocks\-libev Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ss-tunnel \- shadowsocks tools for local port forwarding, libev port
.SH "SYNOPSIS"
.sp
\fBss\-tunnel\fR [\-uUv6] [\-h|\-\-help] [\-s \fI<server_host>\fR] [\-p \fI<server_port>\fR] [\-l \fI<local_port>\fR] [\-k \fI<password>\fR] [\-m \fI<encrypt_method>\fR] [\-f \fI<pid_file>\fR] [\-t \fI<timeout>\fR] [\-c \fI<config_file>\fR] [\-i \fI<interface>\fR] [\-b \fI<local_address>\fR] [\-a \fI<user_name>\fR] [\-n \fI<nofile>\fR] [\-L addr:port] [\-\-mtu \fI<MTU>\fR] [\-\-mptcp] [\-\-reuse\-port] [\-\-no\-delay] [\-\-plugin \fI<plugin_name>\fR] [\-\-plugin\-opts \fI<plugin_options>\fR] [\-\-key \fI<key_in_base64>\fR]
.SH "DESCRIPTION"
.sp
\fBShadowsocks\-libev\fR is a lightweight and secure socks5 proxy\&. It is a port of the original shadowsocks created by clowwindy\&. \fBShadowsocks\-libev\fR is written in pure C and takes advantage of libev to achieve both high performance and low resource consumption\&.
.sp
\fBShadowsocks\-libev\fR consists of five components\&. \fBss\-tunnel\fR(1) is a tool for local port forwarding\&. See \fIOPTIONS\fR section for special option needed by \fBss\-tunnel\fR(1)\&. For more information, check out \fBshadowsocks\-libev\fR(8)\&.
.SH "OPTIONS"
.PP
\-s \fI<server_host>\fR
.RS 4
Set the server\(cqs hostname or IP\&.
.RE
.PP
\-p \fI<server_port>\fR
.RS 4
Set the server\(cqs port number\&.
.RE
.PP
\-l \fI<local_port>\fR
.RS 4
Set the local port number\&.
.RE
.PP
\-k \fI<password>\fR, \-\-password \fI<password>\fR
.RS 4
Set the password\&. The server and the client should use the same password\&.
.RE
.PP
\-\-key \fI<key_in_base64>\fR
.RS 4
Set the key directly\&. The key should be encoded with URL\-safe Base64\&.
.RE
.PP
\-m \fI<encrypt_method>\fR
.RS 4
Set the cipher\&.
.sp
\fBShadowsocks\-libev\fR
accepts 18 different ciphers:
.sp
aes\-128\-gcm, aes\-192\-gcm, aes\-256\-gcm, rc4\-md5, aes\-128\-cfb, aes\-192\-cfb, aes\-256\-cfb, aes\-128\-ctr, aes\-192\-ctr, aes\-256\-ctr, bf\-cfb, camellia\-128\-cfb, camellia\-192\-cfb, camellia\-256\-cfb, chacha20\-ietf\-poly1305, salsa20, chacha20 and chacha20\-ietf\&.
.sp
The default cipher is
\fIrc4\-md5\fR\&.
.sp
If built with PolarSSL or custom OpenSSL libraries, some of these ciphers may not work\&.
.RE
.PP
\-a \fI<user_name>\fR
.RS 4
Run as a specific user\&.
.RE
.PP
\-f \fI<pid_file>\fR
.RS 4
Start shadowsocks as a daemon with specific pid file\&.
.RE
.PP
\-t \fI<timeout>\fR
.RS 4
Set the socket timeout in seconds\&. The default value is 60\&.
.RE
.PP
\-c \fI<config_file>\fR
.RS 4
Use a configuration file\&.
.sp
Refer to
\fBshadowsocks\-libev\fR(8)
\fICONFIG FILE\fR
section for more details\&.
.RE
.PP
\-n \fI<number>\fR
.RS 4
Specify max number of open files\&.
.sp
Only available on Linux\&.
.RE
.PP
\-i \fI<interface>\fR
.RS 4
Send traffic through specific network interface\&.
.sp
For example, there are three interfaces in your device, which is lo (127\&.0\&.0\&.1), eth0 (192\&.168\&.0\&.1) and eth1 (192\&.168\&.0\&.2)\&. Meanwhile, you configure
\fBss\-tunnel\fR
to listen on 0\&.0\&.0\&.0:8388 and bind to eth1\&. That results the traffic go out through eth1, but not lo nor eth0\&. This option is useful to control traffic in multi\-interface environment\&.
.RE
.PP
\-b \fI<local_address>\fR
.RS 4
Specify local address to bind\&.
.RE
.PP
\-u
.RS 4
Enable UDP relay\&.
.RE
.PP
\-U
.RS 4
Enable UDP relay and disable TCP relay\&.
.RE
.PP
\-6
.RS 4
Resovle hostname to IPv6 address first\&.
.RE
.PP
\-L \fI<addr:port>\fR
.RS 4
Specify destination server address and port for local port forwarding\&.
.sp
Only used and available in tunnel mode\&.
.RE
.PP
\-\-mtu \fI<MTU>\fR
.RS 4
Specify the MTU of your network interface\&.
.RE
.PP
\-\-mptcp
.RS 4
Enable Multipath TCP\&.
.sp
Only available with MPTCP enabled Linux kernel\&.
.RE
.PP
\-\-reuse\-port
.RS 4
Enable port reuse\&.
.sp
Only available with Linux kernel > 3\&.9\&.0\&.
.RE
.PP
\-\-no\-delay
.RS 4
Enable TCP_NODELAY\&.
.RE
.PP
\-\-plugin \fI<plugin_name>\fR
.RS 4
Enable SIP003 plugin\&. (Experimental)
.RE
.PP
\-\-plugin\-opts \fI<plugin_options>\fR
.RS 4
Set SIP003 plugin options\&. (Experimental)
.RE
.PP
\-v
.RS 4
Enable verbose mode\&.
.RE
.PP
\-h|\-\-help
.RS 4
Print help message\&.
.RE
.SH "SEE ALSO"
.sp
\fBss\-local\fR(1), \fBss\-server\fR(1), \fBss\-redir\fR(1), \fBss\-manager\fR(1), \fBshadowsocks\-libev\fR(8), \fBiptables\fR(8), /etc/shadowsocks\-libev/config\&.json