Version 0.7 - client : fixed config.port memleak; config path changed to /etc/tunnel6...
[tunnel6.git] / client / INSTALL-linux
blob1f988dddb4ca783d0613d199809802164caabfce
1  _                          _  ____ 
2 | |                        | |/ ___|
3 | |_ _   _ _ __  _ __   ___| / /___ 
4 | __| | | | '_ \| '_ \ / _ \ | ___ \
5 | |_| |_| | | | | | | |  __/ | \_/ |
6  \__|\__,_|_| |_|_| |_|\___|_\_____/
8 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
10 Tunnel6 client require TUN/TAP support in Linux kernel,
11 iproute2, gcc and make package.
12 All dependencies are mostly included in distributions by default.
14 Tested distros:
15                 * Ubuntu 10.04 (works out of the box)
16                 * Gentoo 10.1 (need iproute2 package)
18 Installation process:
20         1. Open terminal (console)
21         2. Login as root with command "su" or use "sudo " at start of each line.
22         3. Go to directory 'src' in client package: cd src
23         4. Compile source code: make
24         5. Install tunnel6 client: make install
25         6. Edit name, password and server in file /etc/tunnel6.conf: nano /etc/tunnel6.conf
26         7. Start client with command: t6_client
28 Alternatively you could start t6_client without your config file
29 Usage:
30         -h : help
31         -v : version
32         -d : start as daemon
33         -f : specify pid file
34         -p : specify port
35         -P : specify password
36         -n : specify login name
37         -s : specify server
38         -l : remap stdout to specified file
40 Example:
41         t6_client -n username -P password -s server
43 Notice:
44         Port is used by default 6060 and is not required in config or parameter.
45         Default PID file is by default in /var/run/tunnel6.pid file
46         Editor nano is used here as example, you can use your preffered app for editing config files