X-Git-Url: https://www.tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=doc%2Ftinc.texi;h=0ce939a2d23ad63842dc3437d9c4edab5c53085d;hp=726655d337be8e6d6c105debfcbcb361a407542d;hb=627f7c22b447bd464b536cd016278545674df93d;hpb=efd29fde85481e080a676f2ba780a528a90a9925 diff --git a/doc/tinc.texi b/doc/tinc.texi index 726655d3..0ce939a2 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -1,5 +1,5 @@ \input texinfo @c -*-texinfo-*- -@c $Id: tinc.texi,v 1.8.4.27 2002/03/27 15:26:29 guus Exp $ +@c $Id: tinc.texi,v 1.8.4.30 2002/06/21 10:11:10 guus Exp $ @c %**start of header @setfilename tinc.info @settitle tinc Manual @@ -15,10 +15,10 @@ This is the info manual for tinc, a Virtual Private Network daemon. Copyright @copyright{} 1998-2002 Ivo Timmermans -, Guus Sliepen and +, Guus Sliepen and Wessel Dankers . -$Id: tinc.texi,v 1.8.4.27 2002/03/27 15:26:29 guus Exp $ +$Id: tinc.texi,v 1.8.4.30 2002/06/21 10:11:10 guus Exp $ Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -40,10 +40,10 @@ permission notice identical to this one. @vskip 0pt plus 1filll @cindex copyright Copyright @copyright{} 1998-2002 Ivo Timmermans -, Guus Sliepen and +, Guus Sliepen and Wessel Dankers . -$Id: tinc.texi,v 1.8.4.27 2002/03/27 15:26:29 guus Exp $ +$Id: tinc.texi,v 1.8.4.30 2002/06/21 10:11:10 guus Exp $ Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -224,6 +224,19 @@ acquisition from the kernel. It has been verified to work under at least OpenBSD Tunneling IPv6 packets may not work on OpenBSD. +@c ================================================================== +@subsection Solaris + +@c ================================================================== +@subsection NetBSD + +@cindex NetBSD +tinc on NetBSD relies on the tun driver for its data +acquisition from the kernel. It has been verified to work under at least NetBSD 1.5.2. + +Tunneling IPv6 does not work on OpenBSD. + + @c ================================================================== @subsection Solaris @@ -234,6 +247,17 @@ as this driver. These are: Solaris 8 (SunOS 5.8). IPv6 packets cannot be tunneled on Solaris. +@c ================================================================== +@subsection Darwin (MacOS/X) + +@cindex Darwin +@cindex MacOS/X +tinc on Darwin relies on the tunnel driver for its data +acquisition from the kernel. This driver is not part of Darwin but can be +downloaded from @uref{http://chrisp.de/en/projects/tunnel.html}. + +IPv6 packets cannot be tunneled on Darwin. + @c @c @@ -290,7 +314,9 @@ you should read the @uref{http://howto.linuxberg.com/LDP/HOWTO/Kernel-HOWTO.html * Configuration of Linux kernels 2.4.0 and higher:: * Configuration of FreeBSD kernels:: * Configuration of OpenBSD kernels:: +* Configuration of NetBSD kernels:: * Configuration of Solaris kernels:: +* Configuration of Darwin (MacOS/X) kernels:: @end menu @@ -374,7 +400,7 @@ Unfortunately somebody still has to write the text. @c ================================================================== -@node Configuration of OpenBSD kernels, Configuration of Solaris kernels, Configuration of FreeBSD kernels, Configuring the kernel +@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 @@ -385,7 +411,18 @@ Unfortunately somebody still has to write the text. @c ================================================================== -@node Configuration of Solaris kernels, , Configuration of OpenBSD kernels, Configuring the kernel +@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. + + +@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 @@ -395,6 +432,23 @@ this is included in the default kernel configuration. Unfortunately somebody still has to write the text. +@c ================================================================== +@node Configuration of Darwin (MacOS/X) kernels, , 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 +@uref{http://chrisp.de/en/projects/tunnel.html}. If compiling the source fails, +try the binary module. The tunnel driver must be loaded before starting tinc +with the following command: + +@example +kmodload tunnel +@end example + +Once loaded, the tunnel driver will automatically create @file{/dev/tun0}..@file{/dev/tun3} +and the corresponding network interfaces. + + @c ================================================================== @node Libraries, , Configuring the kernel, Preparations @section Libraries @@ -533,6 +587,22 @@ If you happen to have a binary package for tinc for your distribution, you can use the package management tools of that distribution to install tinc. The documentation that comes along with your distribution will tell you how to do that. +@menu +* Darwin (MacOS/X) build environment:: +@end menu + + +@c ================================================================== +@node Darwin (MacOS/X) 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 +from @uref{http://developer.apple.com/tools/macosxtools.html} and +a recent version of Fink from @uref{http://fink.sourceforge.net/}. + +After installation use fink to download and install the following packages: +autoconf25, automake, dlcompat, m4, openssl and zlib. + @c ================================================================== @node System files, , Building and installing tinc, Installation @@ -614,7 +684,7 @@ number 655 is registered with the IANA. @example tinc 655/tcp TINC tinc 655/udp TINC -# Ivo Timmermans +# Ivo Timmermans @end example @@ -951,7 +1021,7 @@ in each host configuration file, if you want to be able to establish a connection with that host. @cindex Subnet -@item Subnet = +@item Subnet = The subnet which this tinc daemon will serve. tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet. If the packet matches a subnet, @@ -960,7 +1030,7 @@ Multiple subnet lines can be specified for each daemon. Subnets can either be single MAC, IPv4 or IPv6 addresses, in which case a subnet consisting of only that single address is assumed, -or they can be a IPv4 or IPv6 network address with a masklength. +or they can be a IPv4 or IPv6 network address with a prefixlength. Shorthand notations are not supported. For example, IPv4 subnets must be in a form like 192.168.1.0/24, where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask. @@ -970,7 +1040,7 @@ IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64. MAC addresses are notated like 0:1a:2b:3c:4d:5e. @cindex CIDR notation -masklength is the number of bits set to 1 in the netmask part; for +prefixlength is the number of bits set to 1 in the netmask part; for example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes /22. This conforms to standard CIDR notation as described in @uref{ftp://ftp.isi.edu/in-notes/rfc1519.txt, RFC1519} @@ -1403,8 +1473,8 @@ only, so keep an eye on it! @item Something is not configured right. Packets are being sent out to the virtual network device, but according to the Subnet directives in your host configuration file, those packets should go to your own host. Most common mistake is that -you have a Subnet line in your host configuration file with a netmask which is -just as large as the netmask of the virtual network interface. The latter should in almost all +you have a Subnet line in your host configuration file with a prefix length which is +just as large as the prefix of the virtual network interface. The latter should in almost all cases be larger. Rethink your configuration. Note that you will only see this message if you specified a debug level of 5 or higher! @@ -1424,7 +1494,7 @@ Jan 1 12:00:00 host tinc.net[1234]: Trying to look up 0.0.192.168 in connection @item Add the `ifconfig $INTERFACE -arp' to tinc-up. @end itemize -@item Network address and subnet mask do not match! +@item Network address and prefix length do not match! @itemize @item The Subnet field must contain a @emph{network} address. @@ -1594,7 +1664,7 @@ origin ADD_EDGE node1 12.23.34.45 655 node2 21.32.43.54 655 222 0 +------------------> name of node on one side of the edge origin ADD_SUBNET node 192.168.1.0/24 - | | +--> masklength + | | +--> prefixlength | +--------> IPv4 network address +------------------> owner of this subnet -------------------------------------------------------------------------- @@ -1862,10 +1932,10 @@ and join channel #tinc. @section Authors @table @asis -@item Ivo Timmermans (zarq) (@email{itimmermans@@bigfoot.com}) +@item Ivo Timmermans (zarq) (@email{ivo@@o2w.nl}) Main coder/hacker and maintainer of the package. -@item Guus Sliepen (guus) (@email{guus@@sliepen.warande.net}) +@item Guus Sliepen (guus) (@email{guus@@sliepen.eu.org}) Originator of it all, co-author. @item Wessel Dankers (Ubiq) (@email{wsl@@nl.linux.org})