Describe subnet-up/down scripts in documentation.

[tinc] / doc / tinc.conf.5.in

diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in
index 14bc633..0f3cc2f 100644 (file)
--- a/doc/tinc.conf.5.in
+++ b/doc/tinc.conf.5.in
@@ -1,8 +1,8 @@
 .Dd 2002-04-09
 .Dt TINC.CONF 5
 .\" Manual page created by:
-.\" Ivo Timmermans <ivo@o2w.nl>
-.\" Guus Sliepen <guus@sliepen.eu.org>
+.\" Ivo Timmermans <ivo@tinc-vpn.org>
+.\" Guus Sliepen <guus@tinc-vpn.org>
 .Sh NAME
 .Nm tinc.conf
 .Nd tinc daemon configuration
@@ -120,6 +120,13 @@ 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 BlockingTCP Li = yes | no Po no Pc Bq experimental
+This options selects whether TCP connections, when established, should use blocking writes.
+When turned off, tinc will never block when a TCP connection becomes congested, but will have to terminate that connection instead.
+If turned on, tinc will not terminate connections but will block, thereby unable to process data to/from other connections.
+Turn this option on if you also use
+.Va TCPOnly
+and tinc terminates connections frequently.
 .It Va ConnectTo Li = Ar name
 Specifies which other tinc daemon to connect to on startup.
 Multiple
@@ -222,7 +229,7 @@ specified in the configuration file.
 .It Va TunnelServer Li = yes | no Po no Pc Bq experimental
 When this option is enabled tinc will no longer forward information between other tinc daemons,
 and will only allow nodes and subnets on the VPN which are present in the
-Pa hosts/
+.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
 directory.
 .El
 .Sh HOST CONFIGURATION FILES
@@ -274,9 +281,11 @@ The length of the message authentication code used to authenticate UDP packets.
 Can be anything from
 .Qq 0
 up to the length of the digest produced by the digest algorithm.
+.It Va PMTU Li = Ar mtu Po 1514 Pc Bq experimental
+This option controls the initial path MTU to this node.
 .It Va PMTUDiscovery Li = yes | no Po no Pc Bq experimental
-When this option is enabled, tinc will try to discover the PMTU to other nodes.
-After the PMTU has been discovered, it will be enforced on the VPN.
+When this option is enabled, tinc will try to discover the path MTU to this node.
+After the path MTU has been discovered, it will be enforced on the VPN.
 .It Va Port Li = Ar port Pq 655
 The port number on which this tinc daemon is listening for incoming connections.
 .It Va PublicKey Li = Ar key Bq obsolete
@@ -342,6 +351,11 @@ becomes reachable.
 This script is started when the tinc daemon with name
 .Ar HOST
 becomes unreachable.
+.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up
+This script is started when a Subnet becomes reachable.
+The Subnet and the node it belongs to are passed in environment variables.
+.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down
+This script is started when a Subnet becomes unreachable.
 .El
 .Pp
 The scripts are started without command line arguments, but can make use of certain environment variables.
@@ -366,10 +380,13 @@ This should be used for commands like
 .Pa ifconfig .
 .It Ev NODE
 When a host becomes (un)reachable, this is set to its name.
+If a subnet becomes (un)reachable, this is set to the owner of that subnet.
 .It Ev REMOTEADDRESS
 When a host becomes (un)reachable, this is set to its real address.
 .It Ev REMOTEPORT
 When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
+.It Ev SUBNET
+When a subnet becomes (un)reachable, this is set to the subnet.
 .El
 .Sh FILES
 The most important files are:
@@ -392,7 +409,7 @@ its connection to the virtual network device.
 .El
 .Sh SEE ALSO
 .Xr tincd 8 ,
-.Pa http://tinc.nl.linux.org/ ,
+.Pa http://www.tinc-vpn.org/ ,
 .Pa http://www.linuxdoc.org/LDP/nag2/ .
 .Pp
 The full documentation for