X-Git-Url: https://tinc-vpn.org/git/browse?a=blobdiff_plain;f=doc%2Ftincctl.8.in;h=4b6d4263261516009df847930b21a085e97d1cde;hb=c52c46f8717aac6904f32766d774fa3fdf9611d8;hp=751e16fb5ebe4fd288d2f90edfe3964a4f0dbb76;hpb=a444ec396456a25546a4ab3d185c7fb5e4bb7ae3;p=tinc diff --git a/doc/tincctl.8.in b/doc/tincctl.8.in index 751e16fb..4b6d4263 100644 --- a/doc/tincctl.8.in +++ b/doc/tincctl.8.in @@ -52,9 +52,38 @@ 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 start +.It config Oo set Oc Ar variable Ar value +Set configuration variable +.Ar variable +to the given +.Ar value . +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 +As above, but without removing any previously existing configuration variables. +.It config del Ar variable Op Ar value +Remove configuration variables with the same name and +.Ar value . +If no +.Ar value +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 . +.Xr tincd 8 , +optionally with the given extra options. .It stop Stop .Xr tincd 8 . @@ -81,6 +110,7 @@ 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 Dump a list of all known nodes in the VPN. .It dump edges @@ -93,6 +123,9 @@ Dump a list of all meta connections with ourself. Dump a graph of the VPN in .Xr dotty 1 format. +.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 purge Purges all information remembered about unreachable nodes. .It debug Ar N @@ -139,7 +172,16 @@ Examples of some commands: tincctl -n vpn dump graph | circo -Txlib tincctl -n vpn pcap | tcpdump -r - tincctl -n vpn top +.Pp .Ed +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 export | gpg --clearsign | mail -s "My config" vpnmaster@example.com .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,