X-Git-Url: https://tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=doc%2Ftincctl.8.in;h=8fdd27273de0dcd372b68c20bfd84886e4799085;hp=8693dc0925d4fc3f00fa6995e5339214333895a1;hb=a717b9bcfbe811787fd6718fb3f8fb3f272bcfb9;hpb=53735a9d964579829d089f4b7572aef50c4e1468 diff --git a/doc/tincctl.8.in b/doc/tincctl.8.in index 8693dc09..8fdd2727 100644 --- a/doc/tincctl.8.in +++ b/doc/tincctl.8.in @@ -1,4 +1,4 @@ -.Dd 2011-06-25 +.Dd 2012-10-14 .Dt TINCCTL 8 .\" Manual page created by: .\" Scott Lamb @@ -45,13 +45,17 @@ If no netname is specified on the command line with the option, the value of this environment variable is used. .El .Sh COMMANDS -.zZ .Bl -tag -width indent .It init Op Ar name Create initial configuration files and RSA and ECDSA keypairs with default length. If no .Ar name for this node is given, it will be asked for. +.It config Oo get Oc Ar variable +Print the current value of configuration variable +.Ar variable . +If more than one variable with the same name exists, +the value of each of them will be printed on a separate line. .It config Oo set Oc Ar variable Ar value Set configuration variable .Ar variable @@ -71,6 +75,15 @@ is given, all configuration variables with the same name will be removed. .It edit Ar filename Start an editor for the given configuration file. You do not need to specify the full path to the file. +.It export +Export the host configuration file of the local node to standard output. +.It export-all +Export all host configuration files to standard output. +.It import Op Fl -force +Import host configuration file(s) from standard input. +Already existing host configuration files are not overwritten unless the option +.Fl -force +is used. .It start Op tincd options Start .Xr tincd 8 , @@ -101,19 +114,22 @@ If is omitted, the default length will be 2048 bits. When saving keys to existing files, tinc will not delete the old keys; you have to remove them manually. - -.It dump nodes +.It dump [reachable] nodes Dump a list of all known nodes in the VPN. +If the keyword reachable is used, only lists reachable nodes. .It dump edges Dump a list of all known connections in the VPN. .It dump subnets Dump a list of all known subnets in the VPN. .It dump connections Dump a list of all meta connections with ourself. -.It dump graph +.It dump graph | digraph Dump a graph of the VPN in .Xr dotty 1 format. +Nodes are colored according to their reachability: +red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable. +Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet. .It info Ar node | subnet | address Show information about a particular node, subnet or address. If an address is given, any matching subnet will be shown. @@ -172,6 +188,8 @@ 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 +.Ed .Sh TOP The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters. It displays a list of all the known nodes in the left-most column, @@ -220,7 +238,7 @@ If you find any bugs, report them to tinc@tinc-vpn.org. .Xr tincd 8 , .Xr tinc.conf 5 , .Xr dotty 1 , -.Xr pcap-savefile 7 , +.Xr pcap-savefile 5 , .Xr tcpdump 8 , .Xr top 1 , .Pa http://www.tinc-vpn.org/ ,