From 315ef3e42bf16e03cfbea763442a52389a16b832 Mon Sep 17 00:00:00 2001 From: Guus Sliepen Date: Sat, 11 Nov 2006 20:37:58 +0000 Subject: [PATCH] Document GraphDumpFile option. --- doc/tinc.conf.5.in | 14 +++++++++++++- doc/tinc.texi | 10 ++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in index 750e0cf2..978bdc17 100644 --- a/doc/tinc.conf.5.in +++ b/doc/tinc.conf.5.in @@ -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 diff --git a/doc/tinc.texi b/doc/tinc.texi index 82a0be46..35b5e69e 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -862,6 +862,16 @@ Under Windows, use @var{Interface} instead of @var{Device}. Note that you can only use one device per daemon. See also @ref{Device files}. +@cindex GraphDumpFile +@item GraphDumpFile = <@var{filename}> [experimental] +If this option is present, +tinc will dump the current network graph to the file @var{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 @var{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. + @cindex Hostnames @item Hostnames = (no) This option selects whether IP addresses (both real and on the VPN) -- 2.39.5