Updated documentation.

[tinc] / doc / tinc.texi

diff --git a/doc/tinc.texi b/doc/tinc.texi
index d5ddbff..dba0754 100644 (file)
--- a/doc/tinc.texi
+++ b/doc/tinc.texi
@@ -1,5 +1,5 @@
 \input texinfo   @c -*-texinfo-*-
 \input texinfo   @c -*-texinfo-*-

-@c $Id: tinc.texi,v 1.8.4.21 2002/02/18 16:25:15 guus Exp $
+@c $Id: tinc.texi,v 1.8.4.22 2002/03/01 13:38:02 guus Exp $

 @c %**start of header
 @setfilename tinc.info
 @settitle tinc Manual
 @c %**start of header
 @setfilename tinc.info
 @settitle tinc Manual


@@ -18,7 +18,7 @@ Copyright @copyright{} 1998-2002 Ivo Timmermans
 <itimmermans@@bigfoot.com>, Guus Sliepen <guus@@sliepen.warande.net> and
 Wessel Dankers <wsl@@nl.linux.org>.
 
 <itimmermans@@bigfoot.com>, Guus Sliepen <guus@@sliepen.warande.net> and
 Wessel Dankers <wsl@@nl.linux.org>.
 

-$Id: tinc.texi,v 1.8.4.21 2002/02/18 16:25:15 guus Exp $
+$Id: tinc.texi,v 1.8.4.22 2002/03/01 13:38:02 guus Exp $

 
 Permission is granted to make and distribute verbatim copies of this
 manual provided the copyright notice and this permission notice are
 
 Permission is granted to make and distribute verbatim copies of this
 manual provided the copyright notice and this permission notice are


@@ -43,7 +43,7 @@ Copyright @copyright{} 1998-2002 Ivo Timmermans
 <itimmermans@@bigfoot.com>, Guus Sliepen <guus@@sliepen.warande.net> and
 Wessel Dankers <wsl@@nl.linux.org>.
 
 <itimmermans@@bigfoot.com>, Guus Sliepen <guus@@sliepen.warande.net> and
 Wessel Dankers <wsl@@nl.linux.org>.
 

-$Id: tinc.texi,v 1.8.4.21 2002/02/18 16:25:15 guus Exp $
+$Id: tinc.texi,v 1.8.4.22 2002/03/01 13:38:02 guus Exp $

 
 Permission is granted to make and distribute verbatim copies of this
 manual provided the copyright notice and this permission notice are
 
 Permission is granted to make and distribute verbatim copies of this
 manual provided the copyright notice and this permission notice are


@@ -737,13 +737,17 @@ required directives are given in @strong{bold}.
 
 @table @asis
 @cindex AddressFamily
 
 @table @asis
 @cindex AddressFamily

-@item AddressFamily = <ipv4|ipv6|any> (ipv4)
+@item AddressFamily = <ipv4|ipv6|any> (ipv4) [experimental]

 This option affects the address family of listening and outgoing sockets.
 This option affects the address family of listening and outgoing sockets.

-If "any" is selected, then the listening sockets will be IPv6 sockets,
-but on most platforms those will also accept IPv4 connections.
+If "any" is selected, then depending on the operating system
+both IPv4 and IPv6 or just IPv6 listening sockets will be created.
+
+Mixing IPv4 and IPv6 may not work as desired. 
+It's best to choose one address family
+and use that for all tinc daemons on the VPN.

 
 @cindex BindToInterface
 
 @cindex BindToInterface

-@item BindToInterface = <interface>
+@item BindToInterface = <interface> [experimental]

 If you have more than one network interface in your computer, tinc will
 by default listen on all of them for incoming connections.  It is
 possible to bind tinc to a single interface like eth0 or ppp0 with this
 If you have more than one network interface in your computer, tinc will
 by default listen on all of them for incoming connections.  It is
 possible to bind tinc to a single interface like eth0 or ppp0 with this


@@ -752,7 +756,7 @@ variable.
 This option may not work on all platforms.
 
 @cindex BindToIP
 This option may not work on all platforms.
 
 @cindex BindToIP

-@item BindToIP = <address>
+@item BindToIP = <address> [experimental]

 If your computer has more than one IP address on a single interface (for
 example if you are running virtual hosts), tinc will by default listen
 on all of them for incoming connections.  It is possible to bind tinc to
 If your computer has more than one IP address on a single interface (for
 example if you are running virtual hosts), tinc will by default listen
 on all of them for incoming connections.  It is possible to bind tinc to


@@ -836,6 +840,11 @@ probe to the other end.  If that other end doesn't answer within that
 same amount of seconds, the connection is terminated, and the others
 will be notified of this.
 
 same amount of seconds, the connection is terminated, and the others
 will be notified of this.
 

+@cindex PriorityInheritance
+@item PriorityInheritance = <yes|no> (no) [experimental]
+When this option is enabled the value of the TOS field of tunneled IPv4 packets
+will be inherited by the UDP packets that are sent out.
+

 @cindex PrivateKey
 @item PrivateKey = <key> [obsolete]
 This is the RSA private key for tinc. However, for safety reasons it is
 @cindex PrivateKey
 @item PrivateKey = <key> [obsolete]
 This is the RSA private key for tinc. However, for safety reasons it is