Add generic host-up and host-down scripts.

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

diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in
index 87106a0..750e0cf 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:
 .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
+.\" Guus Sliepen <guus@tinc-vpn.org>

 .Sh NAME
 .Nm tinc.conf
 .Nd tinc daemon configuration
 .Sh NAME
 .Nm tinc.conf
 .Nd tinc daemon configuration


@@ -199,11 +199,13 @@ while no routing table is managed.
 .It Va Name Li = Ar name Bq required
 This is the name which identifies this tinc daemon.
 It must be unique for the virtual private network this daemon will connect to.
 .It Va Name Li = Ar name Bq required
 This is the name which identifies this tinc daemon.
 It must be unique for the virtual private network this daemon will connect to.

-.It Va PingTimeout Li = Ar seconds Pq 60
+.It Va PingInterval Li = Ar seconds Pq 60

 The number of seconds of inactivity that
 .Nm tinc
 will wait before sending a probe to the other end.
 The number of seconds of inactivity that
 .Nm tinc
 will wait before sending a probe to the other end.

-If that other end doesn't answer within that same amount of time,
+.It Va PingTimeout Li = Ar seconds Pq 5
+The number of seconds to wait for a response to pings or to allow meta
+connections to block. If the other end doesn't respond within this time,

 the connection is terminated,
 and the others will be notified of this.
 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
 the connection is terminated,
 and the others will be notified of this.
 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental


@@ -344,6 +346,15 @@ becomes reachable.
 This script is started when the tinc daemon with name
 .Ar HOST
 becomes unreachable.
 This script is started when the tinc daemon with name
 .Ar HOST
 becomes unreachable.

+.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up
+This script is started when any host becomes reachable.
+.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down
+This script is started when any 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.
 .El
 .Pp
 The scripts are started without command line arguments, but can make use of certain environment variables.


@@ -368,10 +379,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.
 .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 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:
 .El
 .Sh FILES
 The most important files are:


@@ -394,7 +408,7 @@ its connection to the virtual network device.
 .El
 .Sh SEE ALSO
 .Xr tincd 8 ,
 .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
 .Pa http://www.linuxdoc.org/LDP/nag2/ .
 .Pp
 The full documentation for