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.
81 Partially rereads configuration files. Connections to hosts whose host
82 config files are removed are closed. New outgoing connections specified
87 Shows the PID of the currently running
89 .It generate-keys Op bits
90 Generate both RSA and ECDSA keypairs (see below) and exit.
91 .It generate-ecdsa-keys
92 Generate public/private ECDSA keypair and exit.
93 .It generate-rsa-keys Op bits
94 Generate public/private RSA keypair and exit.
97 is omitted, the default length will be 2048 bits.
98 When saving keys to existing files, tinc will not delete the old keys;
99 you have to remove them manually.
101 Dump a list of all known nodes in the VPN.
103 Dump a list of all known connections in the VPN.
105 Dump a list of all known subnets in the VPN.
107 Dump a list of all meta connections with ourself.
109 Dump a graph of the VPN in
113 Purges all information remembered about unreachable nodes.
118 Capture log messages from a running tinc daemon.
119 An optional debug level can be given that will be applied only for log messages sent to
124 to try to connect to all uplinks immediately.
127 attempts to do this itself,
128 but increases the time it waits between the attempts each time it failed,
131 didn't succeed to connect to an uplink the first time after it started,
132 it defaults to the maximum time of 15 minutes.
133 .It disconnect Ar NODE
134 Closes the meta connection with the given
139 is compiled with libcurses support, this will display live traffic statistics
140 for all the known nodes, similar to the UNIX
143 See below for more information.
145 Dump VPN traffic going through the local tinc node in
147 format to standard output,
148 from where it can be redirected to a file or piped through a program that can parse it directly,
153 Examples of some commands:
154 .Bd -literal -offset indent
155 tincctl -n vpn dump graph | circo -Txlib
156 tincctl -n vpn pcap | tcpdump -r -
160 Example of configuring tinc using
162 .Bd -literal -offset indent
163 tincctl -n vpn init foo
164 tincctl -n vpn config Subnet 192.168.1.0/24
165 tincctl -n vpn config bar.Address bar.example.com
166 tincctl -n vpn config ConnectTo bar
168 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
169 It displays a list of all the known nodes in the left-most column,
170 and the amount of bytes and packets read from and sent to each node in the other columns.
171 By default, the information is updated every second.
172 The behaviour of the top command can be changed using the following keys:
175 Change the interval between updates.
178 key, enter the desired interval in seconds, followed by enter.
179 Fractional seconds are honored.
180 Intervals lower than 0.1 seconds are not allowed.
182 Toggle between displaying current traffic rates (in packets and bytes per second)
183 and cummulative traffic (total packets and bytes since the tinc daemon started).
185 Sort the list of nodes by name.
187 Sort the list of nodes by incoming amount of bytes.
189 Sort the list of nodes by incoming amount of packets.
191 Sort the list of nodes by outgoing amount of bytes.
193 Sort the list of nodes by outgoing amount of packets.
195 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
197 Sort the list of nodes by sum of incoming and outgoing amount of packets.
199 Show amount of traffic in bytes.
201 Show amount of traffic in kilobytes.
203 Show amount of traffic in megabytes.
205 Show amount of traffic in gigabytes.
210 If you find any bugs, report them to tinc@tinc-vpn.org.
215 .Xr pcap-savefile 7 ,
218 .Pa http://www.tinc-vpn.org/ ,
219 .Pa http://www.cabal.org/ .
221 The full documentation for tinc is maintained as a Texinfo manual.
222 If the info and tinc programs are properly installed at your site,
225 should give you access to the complete manual.
227 tinc comes with ABSOLUTELY NO WARRANTY.
228 This is free software, and you are welcome to redistribute it under certain conditions;
229 see the file COPYING for details.
232 .An "Guus Sliepen" Aq guus@tinc-vpn.org
234 And thanks to many others for their contributions to tinc!