j3d1/tinc
1
0
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

Describe subnet-up/down scripts in documentation.

Browse source
This commit is contained in:
Guus Sliepen 2005-05-04 16:53:11 +00:00
parent bded1b74cc
commit 54a30e30ad
2 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/tinc.conf.5.in
View file

@ -351,6 +351,11 @@ becomes reachable.
This script is started when the tinc daemon with name This script is started when the tinc daemon with name
.Ar HOST .Ar HOST
becomes unreachable. 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 .El
.Pp .Pp
The scripts are started without command line arguments, but can make use of certain environment variables. 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 . .Pa ifconfig .
.It Ev NODE .It Ev NODE
When a host becomes (un)reachable, this is set to its name. 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 .It Ev REMOTEADDRESS
When a host becomes (un)reachable, this is set to its real address. When a host becomes (un)reachable, this is set to its real address.
.It Ev REMOTEPORT .It Ev REMOTEPORT
When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons. 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 .El
.Sh FILES .Sh FILES
The most important files are: The most important files are:

13
doc/tinc.texi
View file

@ -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 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down
This script is started when the tinc daemon with name @var{host} becomes unreachable. 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 @end table
@cindex environment variables @cindex environment variables
@ -1129,6 +1136,7 @@ This should be used for commands like ifconfig.
@cindex NODE @cindex NODE
@item NODE @item NODE
When a host becomes (un)reachable, this is set to its name. 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 @cindex REMOTEADDRESS
@item REMOTEADDRESS @item REMOTEADDRESS
@ -1138,6 +1146,11 @@ When a host becomes (un)reachable, this is set to its real address.
@item REMOTEPORT @item REMOTEPORT
When a host becomes (un)reachable, When a host becomes (un)reachable,
this is set to the port number it uses for communication with other tinc daemons. 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 @end table