From 54a30e30ad41d7c0e73fcc4e6ff23c3e85af75c4 Mon Sep 17 00:00:00 2001 From: Guus Sliepen Date: Wed, 4 May 2005 16:53:11 +0000 Subject: [PATCH] Describe subnet-up/down scripts in documentation. --- doc/tinc.conf.5.in | 8 ++++++++ doc/tinc.texi | 13 +++++++++++++ 2 files changed, 21 insertions(+) diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in index 1797aa7c..0f3cc2fe 100644 --- a/doc/tinc.conf.5.in +++ b/doc/tinc.conf.5.in @@ -351,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. @@ -375,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: diff --git a/doc/tinc.texi b/doc/tinc.texi index 7bea5ebc..5bd4c6c2 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -1100,6 +1100,13 @@ This script is started when the tinc daemon with name @var{host} becomes reachab @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down This script is started when the tinc daemon with name @var{host} becomes unreachable. + +@item @value{sysconfdir}/tinc/@var{netname}/subnet-up +This script is started when a Subnet becomes reachable. +The Subnet and the node it belongs to are passed in environment variables. + +@item @value{sysconfdir}/tinc/@var{netname}/subnet-down +This script is started when a Subnet becomes unreachable. @end table @cindex environment variables @@ -1129,6 +1136,7 @@ This should be used for commands like ifconfig. @cindex NODE @item 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. @cindex REMOTEADDRESS @item REMOTEADDRESS @@ -1138,6 +1146,11 @@ When a host becomes (un)reachable, this is set to its real address. @item REMOTEPORT When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons. + +@cindex SUBNET +@item SUBNET +When a subnet becomes (un)reachable, this is set to the subnet. + @end table -- 2.39.5