\input texinfo @c -*-texinfo-*-
-@c $Id: tinc.texi,v 1.8.4.36 2003/06/11 20:18:48 guus Exp $
+@c $Id: tinc.texi,v 1.8.4.42 2003/08/02 22:01:50 guus Exp $
@c %**start of header
@setfilename tinc.info
@settitle tinc Manual
This is the info manual for tinc, a Virtual Private Network daemon.
-Copyright @copyright{} 1998-2002 Ivo Timmermans
+Copyright @copyright{} 1998-2003 Ivo Timmermans
<ivo@@o2w.nl>, Guus Sliepen <guus@@sliepen.eu.org> and
Wessel Dankers <wsl@@nl.linux.org>.
-$Id: tinc.texi,v 1.8.4.36 2003/06/11 20:18:48 guus Exp $
+$Id: tinc.texi,v 1.8.4.42 2003/08/02 22:01:50 guus Exp $
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
@page
@vskip 0pt plus 1filll
@cindex copyright
-Copyright @copyright{} 1998-2002 Ivo Timmermans
+Copyright @copyright{} 1998-2003 Ivo Timmermans
<ivo@@o2w.nl>, Guus Sliepen <guus@@sliepen.eu.org> and
Wessel Dankers <wsl@@nl.linux.org>.
-$Id: tinc.texi,v 1.8.4.36 2003/06/11 20:18:48 guus Exp $
+$Id: tinc.texi,v 1.8.4.42 2003/08/02 22:01:50 guus Exp $
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
@section Supported platforms
@cindex platforms
-tinc has been verified to work under Linux, FreeBSD, OpenBSD and Solaris, with
-various hardware architectures. These are some of the platforms
+tinc has been verified to work under Linux, FreeBSD, OpenBSD, NetBSD, MacOS/X (Darwin), Solaris, and Windows (in a Cygwin environment),
+with various hardware architectures. These are some of the platforms
that are supported by the universal tun/tap device driver or other virtual network device drivers.
Without such a driver, tinc will most
likely compile and run, but it will not be able to send or receive data
IPv6 packets cannot be tunneled on Darwin.
+@c ==================================================================
+@subsection Cygwin (Windows)
+
+@cindex Cygwin
+@cindex Windows
+tinc on Windows, in a Cygwin environment, relies on the CIPE driver for its data
+acquisition from the kernel. This driver is not part of Windows but can be
+downloaded from @uref{http://cipe-win32.sourceforge.net/}.
+
+@c ==================================================================
+@subsection MinGW (Windows)
+
+@cindex MinGW
+@cindex Windows
+tinc on Windows (native), compiled using MinGW, relies on the CIPE driver for its data
+acquisition from the kernel. This driver is not part of Windows but can be
+downloaded from @uref{http://cipe-win32.sourceforge.net/}.
+
@c
@c
* Configuration of NetBSD kernels::
* Configuration of Solaris kernels::
* Configuration of Darwin (MacOS/X) kernels::
+* Configuration of Cygwin (Windows)::
+* Configuration of MinGW (Windows)::
@end menu
@node Configuration of FreeBSD kernels, Configuration of OpenBSD kernels, Configuration of Linux kernels 2.4.0 and higher, Configuring the kernel
@subsection Configuration of FreeBSD kernels
-This section will contain information on how to configure your FreeBSD
-kernel to support the universal tun/tap device. For 4.1 and higher
-versions, this is included in the default kernel configuration, for earlier
+For FreeBSD version 4.1 and higher, the tap driver is included in the default kernel configuration, for earlier
systems (4.0 and earlier), you need to install the universal tun/tap driver
yourself.
-Unfortunately somebody still has to write the text.
-
@c ==================================================================
@node Configuration of OpenBSD kernels, Configuration of NetBSD kernels, Configuration of FreeBSD kernels, Configuring the kernel
@subsection Configuration of OpenBSD kernels
-This section will contain information on how to configure your OpenBSD
-kernel to support the tun device. For 2.9 and 3.0 systems,
-this is included in the default kernel configuration.
-
-Unfortunately somebody still has to write the text.
+For OpenBSD version 2.9 and higher,
+the tun driver is included in the default kernel configuration.
@c ==================================================================
@node Configuration of NetBSD kernels, Configuration of Solaris kernels, Configuration of OpenBSD kernels, Configuring the kernel
@subsection Configuration of NetBSD kernels
-This section will contain information on how to configure your NetBSD
-kernel to support the tun device. For 1.5.2 systems,
-this is included in the default kernel configuration.
-
-Unfortunately somebody still has to write the text.
+For NetBSD version 1.5.2 and higher,
+the tun driver is included in the default kernel configuration.
@c ==================================================================
@node Configuration of Solaris kernels, Configuration of Darwin (MacOS/X) kernels, Configuration of NetBSD kernels, Configuring the kernel
@subsection Configuration of Solaris kernels
-This section will contain information on how to configure your Solaris
-kernel to support the universal tun/tap device. For Solaris 8 (SunOS 5.8),
-this is included in the default kernel configuration.
-
-Unfortunately somebody still has to write the text.
+For Solaris 8 (SunOS 5.8) and higher,
+the tun driver is included in the default kernel configuration.
@c ==================================================================
-@node Configuration of Darwin (MacOS/X) kernels, , Configuration of Solaris kernels, Configuring the kernel
+@node Configuration of Darwin (MacOS/X) kernels, Configuration of Cygwin (Windows), Configuration of Solaris kernels, Configuring the kernel
@subsection Configuration of Darwin (MacOS/X) kernels
Darwin does not come with a tunnel driver. You must download it at
and the corresponding network interfaces.
+@c ==================================================================
+@node Configuration of Cygwin (Windows), Configuration of MinGW (Windows), Configuration of Darwin (MacOS/X) kernels, Configuring the kernel
+@subsection Configuration of Cygwin (Windows)
+
+You will need to install the CIPE driver, you can download it from
+@uref{http://cipe-win32.sourceforge.net}. Configure the CIPE network device in
+the same way as you would do from the tinc-up script.
+
+
+@c ==================================================================
+@node Configuration of MinGW (Windows), , Configuration of Cygwin (Windows), Configuring the kernel
+@subsection Configuration of MinGW (Windows)
+
+You will need to install the CIPE driver, you can download it from
+@uref{http://cipe-win32.sourceforge.net}. Configure the CIPE network device in
+the same way as you would do from the tinc-up script.
+
+
@c ==================================================================
@node Libraries, , Configuring the kernel, Preparations
@section Libraries
@menu
* Darwin (MacOS/X) build environment::
+* Cygwin (Windows) build environment::
+* MinGW (Windows) build environment::
@end menu
@c ==================================================================
-@node Darwin (MacOS/X) build environment, , , Building and installing tinc
+@node Darwin (MacOS/X) build environment, Cygwin (Windows) build environment, , Building and installing tinc
@subsection Darwin (MacOS/X) build environment
In order to build tinc on Darwin, you need to install the MacOS/X Developer Tools
After installation use fink to download and install the following packages:
autoconf25, automake, dlcompat, m4, openssl, zlib and lzo.
+@c ==================================================================
+@node Cygwin (Windows) build environment, MinGW (Windows) build environment, Darwin (MacOS/X) build environment, Building and installing tinc
+@subsection Cygwin (Windows) build environment
+
+If Cygwin hasn't already been installed, install it directly from
+@uref{http://www.cygwin.com/}.
+
+When tinc is compiled in a Cygwin environment, it can only be run in this environment,
+but all programs, including those started outside the Cygwin environment, will be able to use the VPN.
+It will also support all features.
+
+@c ==================================================================
+@node MinGW (Windows) build environment, , Cygwin (Windows) build environment, Building and installing tinc
+@subsection MinGW (Windows) build environment
+
+You will need to install the MinGW environment from @uref{http://www.mingw.org}.
+
+When tinc is compiled using MinGW it runs natively under Windows,
+it is not necessary to keep MinGW installed.
+
+When running natively, tinc is not able to start scripts,
+nor is tinc able to receive signals.
+When detaching, tinc will install itself as a service,
+which will be restarted automatically after reboots.
+
@c ==================================================================
@node System files, , Building and installing tinc, Installation
What is the network mask of the entire VPN?
Do you need special firewall rules?
Do you have to set up masquerading or forwarding rules?
+Do you want to run tinc in router mode or switch mode?
These questions can only be answered by yourself,
you will not find the answers in this documentation.
Make sure you have an adequate understanding of networks in general.
@cindex Interface
@item Interface = <interface>
Defines the name of the interface corresponding to the virtual network device.
-Depending on the operating system and the type of device this may or may not actually set the name.
-Currently this option only affects the Linux tun/tap device.
+Depending on the operating system and the type of device this may or may not actually set the name of the interface
+or choose the device corresponding to this interface.
@cindex Mode
@item Mode = <router|switch|hub> (router)
variables in the host configuration files will be used to form a routing table.
Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
+This is the default mode, and unless you really know you need another mode, don't change it.
+
@cindex switch
@item switch
In this mode the MAC addresses of the packets on the VPN will be used to
Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
at the cost of frequent broadcast ARP requests and routing table updates.
+This mode is primarily useful if you want to bridge Ethernet segments.
+
@cindex hub
@item hub
This mode is almost the same as the switch mode, but instead
@item Compression = <level> (0)
This option sets the level of compression used for UDP packets.
Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
-and 10 (lzo).
+10 (fast lzo) and 11 (best lzo).
@cindex Digest
@item Digest = <digest> (sha1)
@cindex options
@c from the manpage
@table @samp
-@item --bypass-security
-Disables encryption and authentication.
-Only useful for debugging.
-
@item -c, --config=PATH
Read configuration options from the directory PATH. The default is
@file{/etc/tinc/netname/}.
+@item -D, --no-detach
+Don't fork and detach.
+This will also disable the automatic restart mechanism for fatal errors.
+
@cindex debug level
@item -d, --debug=LEVEL
Set debug level to LEVEL. The higher the debug level, the more gets
logged. Everything goes via syslog.
-@item -K, --generate-keys[=BITS]
-Generate public/private keypair of BITS length. If BITS is not specified,
-1024 is the default. tinc will ask where you want to store the files,
-but will default to the configuration directory (you can use the -c or -n option
-in combination with -K). After that, tinc will quit.
-
-@item --help
-Display a short reminder of these runtime options and terminate.
-
@item -k, --kill[=SIGNAL]
Attempt to kill a running tincd (optionally with the specified SIGNAL instead of SIGTERM) and exit.
Use it in conjunction with the -n option to make sure you kill the right tinc daemon.
+Under native Windows the optional argument is ignored,
+the service will always be stopped and removed.
@item -n, --net=NETNAME
Connect to net NETNAME. @xref{Multiple networks}.
-@item -D, --no-detach
-Don't fork and detach.
-This will also disable the automatic restart mechanism for fatal errors.
+@item -K, --generate-keys[=BITS]
+Generate public/private keypair of BITS length. If BITS is not specified,
+1024 is the default. tinc will ask where you want to store the files,
+but will default to the configuration directory (you can use the -c or -n option
+in combination with -K). After that, tinc will quit.
@item -L, --mlock
Lock tinc into main memory.
This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
+@item --logfile[=FILE]
+Write log entries to a file instead of to the system logging facility.
+If FILE is omitted, the default is /var/log/tinc.NETNAME.log.
+
+@item --pidfile=FILE
+Write PID to FILE instead of /var/run/tinc.NETNAME.pid.
+
+@item --bypass-security
+Disables encryption and authentication.
+Only useful for debugging.
+
+@item --help
+Display a short reminder of these runtime options and terminate.
+
@item --version
Output version information and exit.
decrypted correctly, and that can only be done with knowledge of the private
key.
-Fourth: the first thing that is send via the symmetric cipher encrypted
+Fourth: the first thing that is sent via the symmetric cipher encrypted
connection is a totally random string, so that there is no known plaintext (for
an attacker) in the beginning of the encrypted stream.
this server is located in the Netherlands.
@cindex IRC
-We have an IRC channel on the FreeNode IRC network. Connect to
+We have an IRC channel on the FreeNode and OFTC IRC networks. Connect to
@uref{http://www.freenode.net/, irc.freenode.net}
+or
+@uref{http://www.oftc.net/, irc.oftc.net}
and join channel #tinc.
projects / tinc / blobdiff