3 .\" Manual page created by:
11 .Op Fl -config Ns = Ns Ar DIR
12 .Op Fl -net Ns = Ns Ar NETNAME
13 .Op Fl -pidfile 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 -pidfile 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 .pid.
36 Display short list of options.
38 Output version information and exit.
40 .Sh ENVIRONMENT VARIABLES
41 .Bl -tag -width indent
43 If no netname is specified on the command line with the
45 option, the value of this environment variable is used.
49 .Bl -tag -width indent
51 Create initial configuration files and RSA and ECDSA keypairs with default length.
54 for this node is given, it will be asked for.
55 .It config Oo set Oc Ar variable Ar value
56 Set configuration variable
60 All previously existing configuration variables with the same name are removed.
61 To set a variable for a specific host, use the notation
62 .Ar host Ns Li . Ns Ar variable .
63 .It config add Ar variable Ar value
64 As above, but without removing any previously existing configuration variables.
65 .It config del Ar variable Op Ar value
66 Remove configuration variables with the same name and
70 is given, all configuration variables with the same name will be removed.
72 Start an editor for the given configuration file.
73 You do not need to specify the full path to the file.
84 Partially rereads configuration files. Connections to hosts whose host
85 config files are removed are closed. New outgoing connections specified
90 Shows the PID of the currently running
92 .It generate-keys Op bits
93 Generate both RSA and ECDSA keypairs (see below) and exit.
94 .It generate-ecdsa-keys
95 Generate public/private ECDSA keypair and exit.
96 .It generate-rsa-keys Op bits
97 Generate public/private RSA keypair and exit.
100 is omitted, the default length will be 2048 bits.
101 When saving keys to existing files, tinc will not delete the old keys;
102 you have to remove them manually.
104 Dump a list of all known nodes in the VPN.
106 Dump a list of all known connections in the VPN.
108 Dump a list of all known subnets in the VPN.
110 Dump a list of all meta connections with ourself.
112 Dump a graph of the VPN in
116 Purges all information remembered about unreachable nodes.
121 Capture log messages from a running tinc daemon.
122 An optional debug level can be given that will be applied only for log messages sent to
127 to try to connect to all uplinks immediately.
130 attempts to do this itself,
131 but increases the time it waits between the attempts each time it failed,
134 didn't succeed to connect to an uplink the first time after it started,
135 it defaults to the maximum time of 15 minutes.
136 .It disconnect Ar NODE
137 Closes the meta connection with the given
142 is compiled with libcurses support, this will display live traffic statistics
143 for all the known nodes, similar to the UNIX
146 See below for more information.
148 Dump VPN traffic going through the local tinc node in
150 format to standard output,
151 from where it can be redirected to a file or piped through a program that can parse it directly,
156 Examples of some commands:
157 .Bd -literal -offset indent
158 tincctl -n vpn dump graph | circo -Txlib
159 tincctl -n vpn pcap | tcpdump -r -
163 Example of configuring tinc using
165 .Bd -literal -offset indent
166 tincctl -n vpn init foo
167 tincctl -n vpn config Subnet 192.168.1.0/24
168 tincctl -n vpn config bar.Address bar.example.com
169 tincctl -n vpn config ConnectTo bar
171 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
172 It displays a list of all the known nodes in the left-most column,
173 and the amount of bytes and packets read from and sent to each node in the other columns.
174 By default, the information is updated every second.
175 The behaviour of the top command can be changed using the following keys:
178 Change the interval between updates.
181 key, enter the desired interval in seconds, followed by enter.
182 Fractional seconds are honored.
183 Intervals lower than 0.1 seconds are not allowed.
185 Toggle between displaying current traffic rates (in packets and bytes per second)
186 and cummulative traffic (total packets and bytes since the tinc daemon started).
188 Sort the list of nodes by name.
190 Sort the list of nodes by incoming amount of bytes.
192 Sort the list of nodes by incoming amount of packets.
194 Sort the list of nodes by outgoing amount of bytes.
196 Sort the list of nodes by outgoing amount of packets.
198 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
200 Sort the list of nodes by sum of incoming and outgoing amount of packets.
202 Show amount of traffic in bytes.
204 Show amount of traffic in kilobytes.
206 Show amount of traffic in megabytes.
208 Show amount of traffic in gigabytes.
213 If you find any bugs, report them to tinc@tinc-vpn.org.
218 .Xr pcap-savefile 7 ,
221 .Pa http://www.tinc-vpn.org/ ,
222 .Pa http://www.cabal.org/ .
224 The full documentation for tinc is maintained as a Texinfo manual.
225 If the info and tinc programs are properly installed at your site,
228 should give you access to the complete manual.
230 tinc comes with ABSOLUTELY NO WARRANTY.
231 This is free software, and you are welcome to redistribute it under certain conditions;
232 see the file COPYING for details.
235 .An "Guus Sliepen" Aq guus@tinc-vpn.org
237 And thanks to many others for their contributions to tinc!