X-Git-Url: https://www.tinc-vpn.org/git/browse?a=blobdiff_plain;f=doc%2Ftinc.texi;h=40a297a3e9531034224d746232c5e2ea39eda1e9;hb=248d300f1be0d5f2aae39202041699ab2b46c56b;hp=b595aec1741f0b6ffaac91519065238513e97ab0;hpb=19be9cf7150858311f7898fa3fb525d692d02f64;p=tinc diff --git a/doc/tinc.texi b/doc/tinc.texi index b595aec1..40a297a3 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -262,7 +262,7 @@ alias char-major-10-200 tun @subsection Configuration of FreeBSD kernels For FreeBSD version 4.1 and higher, tun and tap drivers are included in the default kernel configuration. -Using tap devices is recommended. +The tap driver can be loaded with @code{kldload if_tap}, or by adding @code{if_tap_load="YES"} to @file{/boot/loader.conf}. @c ================================================================== @@ -276,6 +276,7 @@ which adds a tap device to OpenBSD which should work with tinc, but with recent versions of OpenBSD, a tun device can act as a tap device by setting the link0 option with ifconfig. + @c ================================================================== @node Configuration of NetBSD kernels @subsection Configuration of NetBSD kernels @@ -981,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 -configuration file. +configuration file, but whether hostnames should be resolved while logging. @cindex Interface @item Interface = <@var{interface}> @@ -2039,8 +2040,38 @@ the value of this environment variable is used. @c from the manpage @table @code -@item start -Start @samp{tincd}. +@item init [@var{name}] +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 [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. +To set a variable for a specific host, use the notation @var{host}.@var{variable}. + +@item config add @var{variable} @var{value} +As above, but without removing any previously existing configuration variables. + +@item config del @var{variable} [@var{value}] +Remove configuration variables with the same name and @var{value}. +If no @var{value} is given, all configuration variables with the same name will be removed. + +@item edit @var{filename} +Start an editor for the given configuration file. +You do not need to specify the full path to the file. + +@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}. @@ -2077,6 +2108,10 @@ Dump a list of all meta connections with ourself. @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. @@ -2121,6 +2156,16 @@ tincctl -n vpn pcap | tcpdump -r - tincctl -n vpn top @end example +Example of configuring tinc using tincctl: + +@example +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 export | gpg --clearsign | mail -s "My config" vpnmaster@@example.com +@end example + @c ================================================================== @node tincctl top @section tincctl top