Document GraphDumpFile option.
[tinc] / doc / tinc.conf.5.in
index a071269..978bdc1 100644 (file)
@@ -1,7 +1,7 @@
 .Dd 2002-04-09
 .Dt TINC.CONF 5
 .\" Manual page created by:
-.\" Ivo Timmermans <ivo@tinc-vpn.org>
+.\" Ivo Timmermans
 .\" Guus Sliepen <guus@tinc-vpn.org>
 .Sh NAME
 .Nm tinc.conf
@@ -147,6 +147,18 @@ instead of
 .Va Device .
 The info pages of the tinc package contain more information
 about configuring the virtual network device.
+.It Va GraphDumpFile Li = Ar filename Bq experimental
+If this option is present,
+.Nm tinc
+will dump the current network graph to the file
+.Ar filename
+every minute, unless there were no changes to the graph.
+The file is in a format that can be read by graphviz tools.
+If
+.Ar filename
+starts with a pipe symbol |,
+then the rest of the filename is interpreted as a shell command
+that is executed, the graph is then sent to stdin.
 .It Va Hostnames Li = yes | no Pq no
 This option selects whether IP addresses (both real and on the VPN) should
 be resolved. Since DNS lookups are blocking, it might affect tinc's
@@ -242,7 +254,7 @@ no secrets are revealed by sending out this information.
 .Bl -tag -width indent
 .It Va Address Li = Ar address Bq recommended
 The IP address or hostname of this tinc daemon on the real network.
-This wil only be used when trying to make an outgoing connection to this tinc daemon.
+This will only be used when trying to make an outgoing connection to this tinc daemon.
 Multiple
 .Va Address
 variables can be specified, in which case each address will be tried until a working
@@ -346,6 +358,10 @@ 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 /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.