'\" t
.\"     Title: obfs-local
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 08/17/2019
.\"    Manual: Shadowsocks-libev Manual
.\"    Source: Shadowsocks-libev 0.0.5
.\"  Language: English
.\"
.TH "OBFS\-LOCAL" "1" "08/17/2019" "Shadowsocks\-libev 0\&.0\&.5" "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"
obfs-local \- simple\-obfs client
.SH "SYNOPSIS"
.sp
\fBobfs\-local\fR [\-6] [\-h|\-\-help] [\-s \fI<server_host>\fR] [\-p \fI<server_port>\fR] [\-l \fI<local_port>\fR] [\-f \fI<pid_file>\fR] [\-t \fI<timeout>\fR] [\-c \fI<config_file>\fR] [\-i \fI<interface>\fR] [\-a \fI<user_name>\fR] [\-b \fI<local_address] [\-n <nofile>\fR] [\-\-fast\-open] [\-\-obfs \fI<http|tls>\fR] [\-\-obfs\-host \fI<hostname>\fR]
.SH "DESCRIPTION"
.sp
\fBObfs\-simple\fR is a very simple obfuscating tunnel tool\&.
.sp
\fBObfs\-simple\fR is written in pure C and takes advantage of libev to achieve both high performance and low resource consumption\&.
.sp
\fBObfs\-simple\fR consists of two components\&. \fBobfs\-local\fR(1) works as a standard tunnel on local machines to obfuscate TCP traffic\&.
.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
\-a \fI<user_name>\fR
.RS 4
Run as a specific user\&.
.RE
.PP
\-f \fI<pid_file>\fR
.RS 4
Start obfs\-simple 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\&.
.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
\fBobfs\-local\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
\-6
.RS 4
Resovle hostname to IPv6 address first\&.
.RE
.PP
\-\-fast\-open
.RS 4
Enable TCP fast open\&.
.sp
Only available with Linux kernel > 3\&.7\&.0\&.
.RE
.PP
\-\-mptcp
.RS 4
Enable Multipath TCP\&.
.sp
Only available with MPTCP enabled Linux kernel\&.
.RE
.PP
\-\-obfs \fI<http|tls>\fR
.RS 4
Enable HTTP or TLS obfuscating\&. (Experimental)
.RE
.PP
\-\-obfs\-host \fI<hostname>\fR
.RS 4
Specify the hostname for obfuscating\&. (Experimental)
.RE
.PP
\-v
.RS 4
Enable verbose mode\&.
.RE
.PP
\-h|\-\-help
.RS 4
Print help message\&.
.RE
.SH "EXAMPLE"
.sp
\fBobfs\-local\fR(1) can be started from command line and run in foreground\&. Here is an example:
.sp
.if n \{\
.RS 4
.\}
.nf
# Start obfs\-local with given parameters
obfs\-local \-s example\&.com \-p 12345 \-l 1080 \-\-obfs http \-\-obfs\-host www\&.baidu\&.com
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fBobfs\-server\fR(1), /etc/simple\-obfs/config\&.json