3 .\" Manual page created by:
11 .Op Fl -config Ns = Ns Ar DIR
12 .Op Fl -net Ns = Ns Ar NETNAME
13 .Op Fl -controlcookie Ns = Ns Ar FILENAME
18 This is the control program of tinc, a secure virtual private network (VPN)
23 to alter and inspect the running VPN's state.
25 .Bl -tag -width indent
26 .It Fl n, -net Ns = Ns Ar NETNAME
27 Communicate with tincd(8) connected with
29 .It Fl -controlcookie Ns = Ns Ar FILENAME
32 to authenticate with a running tinc daemon.
33 If unspecified, the default is
34 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .cookie.
36 Display short list of options.
38 Output version information and exit.
42 .Bl -tag -width indent
53 Partially rereads configuration files. Connections to hosts whose host
54 config files are removed are closed. New outgoing connections specified
59 Shows the PID of the currently running
61 .It generate-keys Op bits
62 Generate public/private RSA keypair and exit.
65 is omitted, the default length will be 1024 bits.
66 When saving keys to existing files, tinc will not delete the old keys;
67 you have to remove them manually.
69 Dump a list of all known nodes in the VPN.
71 Dump a list of all known connections in the VPN.
73 Dump a list of all known subnets in the VPN.
75 Dump a list of all meta connections with ourself.
77 Dump a graph of the VPN in
81 Purges all information remembered about unreachable nodes.
88 to try to connect to all uplinks immediately.
91 attempts to do this itself,
92 but increases the time it waits between the attempts each time it failed,
95 didn't succeed to connect to an uplink the first time after it started,
96 it defaults to the maximum time of 15 minutes.
97 .It disconnect Ar NODE
98 Closes the meta connection with the given
103 is compiled with libcurses support, this will display live traffic statistics
104 for all the known nodes, similar to the UNIX
107 See below for more information.
109 Dump VPN traffic going through the local tinc node in
111 format to standard output,
112 from where it can be redirected to a file or piped through a program that can parse it directly,
117 Examples of some commands:
118 .Bd -literal -offset indent
119 tincctl -n vpn dump graph | circo -Txlib
120 tincctl -n vpn pcap | tcpdump -r -
124 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
125 It displays a list of all the known nodes in the left-most column,
126 and the amount of bytes and packets read from and sent to each node in the other columns.
127 By default, the information is updated every second.
128 The behaviour of the top command can be changed using the following keys:
131 Change the interval between updates.
134 key, enter the desired interval in seconds, followed by enter.
135 Fractional seconds are honored.
136 Intervals lower than 0.1 seconds are not allowed.
138 Toggle between displaying current traffic rates (in packets and bytes per second)
139 and cummulative traffic (total packets and bytes since the tinc daemon started).
141 Sort the list of nodes by name.
143 Sort the list of nodes by incoming amount of bytes.
145 Sort the list of nodes by incoming amount of packets.
147 Sort the list of nodes by outgoing amount of bytes.
149 Sort the list of nodes by outgoing amount of packets.
151 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
153 Sort the list of nodes by sum of incoming and outgoing amount of packets.
155 Show amount of traffic in bytes.
157 Show amount of traffic in kilobytes.
159 Show amount of traffic in megabytes.
161 Show amount of traffic in gigabytes.
166 If you find any bugs, report them to tinc@tinc-vpn.org.
171 .Xr pcap-savefile 7 ,
174 .Pa http://www.tinc-vpn.org/ ,
175 .Pa http://www.cabal.org/ .
177 The full documentation for tinc is maintained as a Texinfo manual.
178 If the info and tinc programs are properly installed at your site,
181 should give you access to the complete manual.
183 tinc comes with ABSOLUTELY NO WARRANTY.
184 This is free software, and you are welcome to redistribute it under certain conditions;
185 see the file COPYING for details.
188 .An "Guus Sliepen" Aq guus@tinc-vpn.org
190 And thanks to many others for their contributions to tinc!