Update documentation.
[tinc] / doc / tinc.conf.5
index 4de7c6d..94b83ce 100644 (file)
@@ -1,8 +1,8 @@
-.Dd 2002-02-06
+.Dd 2002-04-09
 .Dt TINC.CONF 5
 .\" Manual page created by:
-.\" Ivo Timmermans <itimmermans@bigfoot.com>
-.\" Guus Sliepen <guus@sliepen.warande.net>
+.\" Ivo Timmermans <ivo@o2w.nl>
+.\" Guus Sliepen <guus@sliepen.eu.org>
 .Sh NAME
 .Nm tinc.conf
 .Nd tinc daemon configuration
@@ -106,9 +106,6 @@ If
 .Qq any
 is selected, then depending on the operating system both IPv4 and IPv6 or just
 IPv6 listening sockets will be created.
-.Pp
-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.
 .It Va BindToInterface Li = Ar interface Bq experimental
 If your computer has more than one network interface,
 .Nm tinc
@@ -116,16 +113,6 @@ will by default listen on all of them for incoming connections.
 It is possible to bind only to a single interface with this variable.
 .Pp
 This option may not work on all platforms.
-.It Va BindToIP Li = Ar address Bq experimental
-If your computer has more than one IP address on a single interface
-(for example if you are running virtual hosts),
-.Nm tinc
-will by default listen on all of them for incoming connections.
-It is possible to bind only to a single IP address with this variable.
-It is still possible to listen on several interfaces at the same time though,
-if they share the same IP address.
-.Pp
-This option may not work on all platforms.
 .It Va ConnectTo Li = Ar name
 Specifies which other tinc daemon to connect to on startup.
 Multiple
@@ -142,7 +129,7 @@ If you don't specify a host with
 .Nm tinc
 won't try to connect to other daemons at all,
 and will instead just listen for incoming connections.
-.It Va Device Li = Ar device Po /dev/tap0 or /dev/misc/net/tun Pc
+.It Va Device Li = Ar device Po /dev/tap0 or /dev/net/tun Pc
 The virtual network device to use.
 .Nm tinc
 will automatically detect what kind of device it is.
@@ -250,7 +237,7 @@ Any digest supported by OpenSSL is recognised.
 Furthermore, specifying
 .Qq none
 will turn off packet authentication.
-.It Va IndirectData Li = yes | no Po no Pc Bq experimental
+.It Va IndirectData Li = yes | no Pq no
 This option specifies whether other tinc daemons besides the one you specified with
 .Va ConnectTo
 can make a direct connection to you.
@@ -277,7 +264,7 @@ the above two options then are not necessary.
 Either the PEM format is used, or exactly one of the above two options must be specified
 in each host configuration file,
 if you want to be able to establish a connection with that host.
-.It Va Subnet Li = Ar address Ns Op Li / Ns Ar masklength
+.It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength
 The subnet which this tinc daemon will serve.
 .Nm tinc
 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
@@ -289,7 +276,7 @@ variables can be specified.
 .Pp
 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.
@@ -297,14 +284,12 @@ Note that subnets like 192.168.1.1/24 are invalid!
 Read a networking HOWTO/FAQ/guide if you don't understand this.
 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.
-.It Va TCPOnly Li = yes | no Po no Pc Bq experimental
+.It Va TCPOnly Li = yes | no Pq no
 If this variable is set to yes,
 then the packets are tunnelled over the TCP connection instead of a UDP connection.
 This is especially useful for those who want to run a tinc daemon
 from behind a masquerading firewall,
 or if UDP packet routing is disabled somehow.
-This is experimental code, try this at your own risk.
-It may not work at all.
 Setting this options also implicitly sets IndirectData.
 .El
 .Sh FILES