vtund.8

.\" Manual page for vtund
.\" $Id$
.\" SH section heading
.\" SS subsection heading
.\" LP paragraph
.\" IP indented paragraph
.\" TP hanging label
.TH VTUND 8
.SH NAME
vtund \- VTun(Virtual Tunnel) daemon.
.SH SYNOPSIS
.B vtund 
<
.I -s  
>
[ 
.I -i 
] 
[ 
.I -n 
] 
[ 
.I -f file 
] 
[ 
.I -P port 
]
.LP
.B vtund 
[ 
.I -f file 
] 
[ 
.I -P port 
]
[ 
.I -p 
]
[ 
.I -q 
]
[ 
.I -m 
]
[ 
.I -t timeout 
]
[ 
.I -n 
] 
<
.I session 
>
<
.I server address 
>

.SH DESCRIPTION
.LP
VTun provides the method for creating Virtual Tunnels over TCP/IP networks
and allows to shape, compress, encrypt traffic in that tunnels. 
.LP
Supported type of tunnels are: PPP, IP, Ethernet and most of other serial 
protocols and programs.
.LP
VTun is easily and highly configurable, it can be used for various network
task like VPN, Mobile IP, Shaped Internet access, IP address saving, etc.
.LP
It is completely user space implementation and does not require modification
to any kernel parts. 

.SH OPTIONS
.TP
.I -f file 
Read config information from the
.I file
(full path required). By default vtund uses /etc/vtund.conf
.TP
.I -n 
Do not become daemon.
.SS Server mode: 
.TP
.I -s
Run as the server.
.TP
.I -i
Run as the inetd server.
.TP
.I -P port
Listen for connection on the specified
.I port
By default vtund listens on TCP port 5000. This options is equivalent to 
the 'port' option of config file.
.SS Client mode:
.TP
.I -P port
Connect to the server on the specified
.I port
By default vtund connects to TCP port 5000. This options is equivalent to 
the 'port' option of config file.
.TP
.I -p
Reconnect to the server after connection termination. By default vtund will
exit if connection has been terminated. This options is equivalent to 
the 'persist' option of config file.
.TP
.I -q
Inhibit the printing of connection messages.
.TP
.I -m
Force memory pages to be locked memory-resident to prevent potential VM deadlock.  Useful with NFS traffic.  This option has no config file equivalent.
.TP
.I -t timeout
Connect 
.I timeout
Default is 30 seconds. This options is equivalent to the 'timeout' option of
config file.
.TP
.I session 
Session name from the config file.
.TP
.I server 
Address of the server to connect to. Either IP address or domain name can be 
specified.
.SH FILES
.TP
.B /etc/vtund.conf
Main configuration file with sessions and other information. 
See vtund.conf example provided with distribution and vtund.conf(5) 
for more information.
.TP
.B /var/lock/vtund/
Session lock files. 
.TP
.B /var/log/vtund/
Connection statistic log files.
.br
Format:
   Date Uncomp_In Uncomp_Out Comp_In Comp_Out
.SH SIGNALS
.TP
.B SIGHUP
Server mode: Causes vtund to reread the config file.
.br
Client mode: Causes vtund to reestablish the connection.
.TP
.B SIGUSR1
This signal causes vtund to reset statistic counters. 
.SH SEE ALSO
.TP
vtund.conf(5)
.SH NOTES 
.LP
This product includes software developed by the OpenSSL Project
for use in the OpenSSL Toolkit. (http://www.openssl.org/)
.SH AUTHORS
Maxim Krasnyansky <max_mk@yahoo.com>