X-Git-Url: https://tinc-vpn.org/git/browse?a=blobdiff_plain;f=doc%2Ftincctl.8.in;h=8fdd27273de0dcd372b68c20bfd84886e4799085;hb=a717b9bcfbe811787fd6718fb3f8fb3f272bcfb9;hp=04a1ddb5dcadf3ff997a8d5e0b8f08aa1390d645;hpb=2e09986a1fd6dc5b6313f10e5d86aaaf4a531235;p=tinc diff --git a/doc/tincctl.8.in b/doc/tincctl.8.in index 04a1ddb5..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,7 +45,6 @@ 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. @@ -115,9 +114,9 @@ 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 @@ -128,6 +127,9 @@ Dump a list of all meta connections with ourself. 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. @@ -187,6 +189,7 @@ 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,