Allow changing configuration with tincctl without the "config" keyword.
[tinc] / doc / tincctl.8.in
index 821803a..335b3e1 100644 (file)
@@ -1,4 +1,4 @@
-.Dd 2012-10-14
+.Dd 2013-01-15
 .Dt TINCCTL 8
 .\" Manual page created by:
 .\" Scott Lamb
@@ -51,12 +51,12 @@ Create initial configuration files and RSA and ECDSA keypairs with default lengt
 If no
 .Ar name
 for this node is given, it will be asked for.
-.It config Oo get Oc Ar variable
+.It get 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
+.It set Ar variable Ar value
 Set configuration variable
 .Ar variable
 to the given
@@ -64,9 +64,9 @@ to the given
 All previously existing configuration variables with the same name are removed.
 To set a variable for a specific host, use the notation
 .Ar host Ns Li . Ns Ar variable .
-.It config add Ar variable Ar value
+.It add Ar variable Ar value
 As above, but without removing any previously existing configuration variables.
-.It config del Ar variable Op Ar value
+.It del Ar variable Op Ar value
 Remove configuration variables with the same name and
 .Ar value .
 If no
@@ -80,10 +80,16 @@ 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.
+Import host configuration data generated by the
+.Nm
+export command from standard input.
 Already existing host configuration files are not overwritten unless the option
 .Fl -force
 is used.
+.It exchange Op Fl -force
+The same as export followed by import.
+.It exchange-all Op Fl -force
+The same as export-all followed by import.
 .It start Op tincd options
 Start
 .Xr tincd 8 ,
@@ -114,8 +120,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
@@ -184,9 +191,9 @@ Example of configuring tinc using
 .Nm :
 .Bd -literal -offset indent
 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 add Subnet 192.168.1.0/24
+tincctl -n vpn add bar.Address bar.example.com
+tincctl -n vpn add ConnectTo bar
 tincctl -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@example.com
 .Ed
 .Sh TOP
@@ -205,7 +212,7 @@ Fractional seconds are honored.
 Intervals lower than 0.1 seconds are not allowed.
 .It Ic c
 Toggle between displaying current traffic rates (in packets and bytes per second)
-and cummulative traffic (total packets and bytes since the tinc daemon started).
+and cumulative traffic (total packets and bytes since the tinc daemon started).
 .It Ic n
 Sort the list of nodes by name.
 .It Ic i