Describe subnet-up/down scripts in documentation.

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

diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in
index 9e2e27083852789a90214f99b5099b2fd7eb2787..0f3cc2fe6d722544667dd3bd37acf5c820a98404 100644 (file)
--- a/doc/tinc.conf.5.in
+++ b/doc/tinc.conf.5.in
@@ -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
@@ -344,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.
@@ -368,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: