From 38a2daa67c723ac372e1d38f230098be87c25267 Mon Sep 17 00:00:00 2001 From: Jason Lyu Date: Thu, 11 Feb 2021 19:05:15 +0800 Subject: [PATCH] Updated Home (markdown) --- Home.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 24570d9..9c674f2 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,37 @@ -Welcome to the tun2socks wiki! +# Welcome + +Welcome to the official Wiki page for [xjasonlyu/tun2socks](https://github.com/xjasonlyu/tun2socks). + +# QuickStart + +```sh +tun2socks -device tun://tun0 -proxy socks5://1.2.3.4:1080 +``` + +## Usage + +```text +Usage of tun2socks: + -device string + Use this device [driver://]name + -fwmark int + Set firewall MARK (Linux only) + -interface string + Use network INTERFACE (Linux/MacOS only) + -loglevel string + Log level [debug|info|warn|error|silent] (default "info") + -mtu int + Set device maximum transmission unit (MTU) + -proxy string + Use this proxy [protocol://]host[:port] + -stats string + HTTP statistic server listen address + -token string + HTTP statistic server auth token + -version + Show version information and quit +``` + +# License + +This software is released under the [GPL-3.0](https://github.com/xjasonlyu/tun2socks/blob/main/LICENSE) open-source license.