Add the ability to query configuration variables to tincctl.

[tinc] / doc / tinc.texi

diff --git a/doc/tinc.texi b/doc/tinc.texi
index 66300ea..b2236b4 100644 (file)
--- a/doc/tinc.texi
+++ b/doc/tinc.texi
@@ -982,7 +982,7 @@ tinc's efficiency, even stopping the daemon for a few seconds everytime
 it does a lookup if your DNS server is not responding.
 
 This does not affect resolving hostnames to IP addresses from the
 it does a lookup if your DNS server is not responding.
 
 This does not affect resolving hostnames to IP addresses from the

-configuration file.
+configuration file, but whether hostnames should be resolved while logging.

 
 @cindex Interface
 @item Interface = <@var{interface}>
 
 @cindex Interface
 @item Interface = <@var{interface}>


@@ -2044,6 +2044,11 @@ the value of this environment variable is used.
 Create initial configuration files and RSA and ECDSA keypairs with default length.
 If no @var{name} for this node is given, it will be asked for.
 
 Create initial configuration files and RSA and ECDSA keypairs with default length.
 If no @var{name} for this node is given, it will be asked for.
 

+@item config [get] @var{variable}
+Print the current value of configuration variable @var{variable}.
+If more than one variable with the same name exists,
+the value of each of them will be printed on a separate line.
+

 @item config [set] @var{variable} @var{value}
 Set configuration variable @var{variable} to the given @var{value}.
 All previously existing configuration variables with the same name are removed.
 @item config [set] @var{variable} @var{value}
 Set configuration variable @var{variable} to the given @var{value}.
 All previously existing configuration variables with the same name are removed.


@@ -2060,8 +2065,18 @@ If no @var{value} is given, all configuration variables with the same name will
 Start an editor for the given configuration file.
 You do not need to specify the full path to the file.
 
 Start an editor for the given configuration file.
 You do not need to specify the full path to the file.
 

-@item start
-Start @samp{tincd}.
+@item export
+Export the host configuration file of the local node to standard output.
+
+@item export-all
+Export all host configuration files to standard output.
+
+@item import [--force]
+Import host configuration file(s) from standard input.
+Already existing host configuration files are not overwritten unless the option --force is used.
+
+@item start [tincd options]
+Start @samp{tincd}, optionally with the given extra options.

 
 @item stop
 Stop @samp{tincd}.
 
 @item stop
 Stop @samp{tincd}.


@@ -2098,6 +2113,10 @@ Dump a list of all meta connections with ourself.
 @item dump graph
 Dump a graph of the VPN in dotty format.
 
 @item dump graph
 Dump a graph of the VPN in dotty format.
 

+@item info @var{node} | @var{subnet} | @var{address}
+Show information about a particular @var{node}, @var{subnet} or @var{address}.
+If an @var{address} is given, any matching subnet will be shown.
+

 @item purge
 Purges all information remembered about unreachable nodes.
 
 @item purge
 Purges all information remembered about unreachable nodes.
 


@@ -2149,6 +2168,7 @@ tincctl -n vpn init foo
 tincctl -n vpn config Subnet 192.168.1.0/24
 tincctl -n vpn config bar.Address bar.example.com
 tincctl -n vpn config ConnectTo bar
 tincctl -n vpn config Subnet 192.168.1.0/24
 tincctl -n vpn config bar.Address bar.example.com
 tincctl -n vpn config ConnectTo bar

+tincctl -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@@example.com

 @end example
 
 @c ==================================================================
 @end example
 
 @c ==================================================================