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.
75 Export the host configuration file of the local node to standard output.
77 Export all host configuration files to standard output.
78 .It import Op Fl -force
79 Import host configuration file(s) from standard input.
80 Already existing host configuration files are not overwritten unless the option
83 .It start Op tincd options
86 optionally with the given extra options.
94 Partially rereads configuration files. Connections to hosts whose host
95 config files are removed are closed. New outgoing connections specified
100 Shows the PID of the currently running
102 .It generate-keys Op bits
103 Generate both RSA and ECDSA keypairs (see below) and exit.
104 .It generate-ecdsa-keys
105 Generate public/private ECDSA keypair and exit.
106 .It generate-rsa-keys Op bits
107 Generate public/private RSA keypair and exit.
110 is omitted, the default length will be 2048 bits.
111 When saving keys to existing files, tinc will not delete the old keys;
112 you have to remove them manually.
115 Dump a list of all known nodes in the VPN.
117 Dump a list of all known connections in the VPN.
119 Dump a list of all known subnets in the VPN.
121 Dump a list of all meta connections with ourself.
123 Dump a graph of the VPN in
126 .It info Ar node | subnet | address
127 Show information about a particular node, subnet or address.
128 If an address is given, any matching subnet will be shown.
130 Purges all information remembered about unreachable nodes.
135 Capture log messages from a running tinc daemon.
136 An optional debug level can be given that will be applied only for log messages sent to
141 to try to connect to all uplinks immediately.
144 attempts to do this itself,
145 but increases the time it waits between the attempts each time it failed,
148 didn't succeed to connect to an uplink the first time after it started,
149 it defaults to the maximum time of 15 minutes.
150 .It disconnect Ar NODE
151 Closes the meta connection with the given
156 is compiled with libcurses support, this will display live traffic statistics
157 for all the known nodes, similar to the UNIX
160 See below for more information.
162 Dump VPN traffic going through the local tinc node in
164 format to standard output,
165 from where it can be redirected to a file or piped through a program that can parse it directly,
170 Examples of some commands:
171 .Bd -literal -offset indent
172 tincctl -n vpn dump graph | circo -Txlib
173 tincctl -n vpn pcap | tcpdump -r -
177 Example of configuring tinc using
179 .Bd -literal -offset indent
180 tincctl -n vpn init foo
181 tincctl -n vpn config Subnet 192.168.1.0/24
182 tincctl -n vpn config bar.Address bar.example.com
183 tincctl -n vpn config ConnectTo bar
184 tincctl -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@example.com
186 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
187 It displays a list of all the known nodes in the left-most column,
188 and the amount of bytes and packets read from and sent to each node in the other columns.
189 By default, the information is updated every second.
190 The behaviour of the top command can be changed using the following keys:
193 Change the interval between updates.
196 key, enter the desired interval in seconds, followed by enter.
197 Fractional seconds are honored.
198 Intervals lower than 0.1 seconds are not allowed.
200 Toggle between displaying current traffic rates (in packets and bytes per second)
201 and cummulative traffic (total packets and bytes since the tinc daemon started).
203 Sort the list of nodes by name.
205 Sort the list of nodes by incoming amount of bytes.
207 Sort the list of nodes by incoming amount of packets.
209 Sort the list of nodes by outgoing amount of bytes.
211 Sort the list of nodes by outgoing amount of packets.
213 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
215 Sort the list of nodes by sum of incoming and outgoing amount of packets.
217 Show amount of traffic in bytes.
219 Show amount of traffic in kilobytes.
221 Show amount of traffic in megabytes.
223 Show amount of traffic in gigabytes.
228 If you find any bugs, report them to tinc@tinc-vpn.org.
233 .Xr pcap-savefile 7 ,
236 .Pa http://www.tinc-vpn.org/ ,
237 .Pa http://www.cabal.org/ .
239 The full documentation for tinc is maintained as a Texinfo manual.
240 If the info and tinc programs are properly installed at your site,
243 should give you access to the complete manual.
245 tinc comes with ABSOLUTELY NO WARRANTY.
246 This is free software, and you are welcome to redistribute it under certain conditions;
247 see the file COPYING for details.
250 .An "Guus Sliepen" Aq guus@tinc-vpn.org
252 And thanks to many others for their contributions to tinc!