Add option to dump only a list of reachable nodes.

[tinc] / doc / tincctl.8.in

diff --git a/doc/tincctl.8.in b/doc/tincctl.8.in
index 3ca6753..8fdd272 100644 (file)
--- 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
 .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
 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.
 .Bl -tag -width indent
 .It init Op Ar name
 Create initial configuration files and RSA and ECDSA keypairs with default length.


@@ -115,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.
 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.
 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 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.
 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.
 .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
 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,
 .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,


@@ -235,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 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/ ,
 .Xr tcpdump 8 ,
 .Xr top 1 ,
 .Pa http://www.tinc-vpn.org/ ,