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.
48 .Bl -tag -width indent
50 Create initial configuration files and RSA and ECDSA keypairs with default length.
53 for this node is given, it will be asked for.
54 .It config Oo get Oc Ar variable
55 Print the current value of configuration variable
57 If more than one variable with the same name exists,
58 the value of each of them will be printed on a separate line.
59 .It config Oo set Oc Ar variable Ar value
60 Set configuration variable
64 All previously existing configuration variables with the same name are removed.
65 To set a variable for a specific host, use the notation
66 .Ar host Ns Li . Ns Ar variable .
67 .It config add Ar variable Ar value
68 As above, but without removing any previously existing configuration variables.
69 .It config del Ar variable Op Ar value
70 Remove configuration variables with the same name and
74 is given, all configuration variables with the same name will be removed.
76 Start an editor for the given configuration file.
77 You do not need to specify the full path to the file.
79 Export the host configuration file of the local node to standard output.
81 Export all host configuration files to standard output.
82 .It import Op Fl -force
83 Import host configuration file(s) from standard input.
84 Already existing host configuration files are not overwritten unless the option
87 .It start Op tincd options
90 optionally with the given extra options.
98 Partially rereads configuration files. Connections to hosts whose host
99 config files are removed are closed. New outgoing connections specified
104 Shows the PID of the currently running
106 .It generate-keys Op bits
107 Generate both RSA and ECDSA keypairs (see below) and exit.
108 .It generate-ecdsa-keys
109 Generate public/private ECDSA keypair and exit.
110 .It generate-rsa-keys Op bits
111 Generate public/private RSA keypair and exit.
114 is omitted, the default length will be 2048 bits.
115 When saving keys to existing files, tinc will not delete the old keys;
116 you have to remove them manually.
117 .It dump [reachable] nodes
118 Dump a list of all known nodes in the VPN.
119 If the keyword reachable is used, only lists reachable nodes.
121 Dump a list of all known connections in the VPN.
123 Dump a list of all known subnets in the VPN.
125 Dump a list of all meta connections with ourself.
126 .It dump graph | digraph
127 Dump a graph of the VPN in
130 Nodes are colored according to their reachability:
131 red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable.
132 Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet.
133 .It info Ar node | subnet | address
134 Show information about a particular node, subnet or address.
135 If an address is given, any matching subnet will be shown.
137 Purges all information remembered about unreachable nodes.
142 Capture log messages from a running tinc daemon.
143 An optional debug level can be given that will be applied only for log messages sent to
148 to try to connect to all uplinks immediately.
151 attempts to do this itself,
152 but increases the time it waits between the attempts each time it failed,
155 didn't succeed to connect to an uplink the first time after it started,
156 it defaults to the maximum time of 15 minutes.
157 .It disconnect Ar NODE
158 Closes the meta connection with the given
163 is compiled with libcurses support, this will display live traffic statistics
164 for all the known nodes, similar to the UNIX
167 See below for more information.
169 Dump VPN traffic going through the local tinc node in
171 format to standard output,
172 from where it can be redirected to a file or piped through a program that can parse it directly,
177 Examples of some commands:
178 .Bd -literal -offset indent
179 tincctl -n vpn dump graph | circo -Txlib
180 tincctl -n vpn pcap | tcpdump -r -
184 Example of configuring tinc using
186 .Bd -literal -offset indent
187 tincctl -n vpn init foo
188 tincctl -n vpn config Subnet 192.168.1.0/24
189 tincctl -n vpn config bar.Address bar.example.com
190 tincctl -n vpn config ConnectTo bar
191 tincctl -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@example.com
194 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
195 It displays a list of all the known nodes in the left-most column,
196 and the amount of bytes and packets read from and sent to each node in the other columns.
197 By default, the information is updated every second.
198 The behaviour of the top command can be changed using the following keys:
201 Change the interval between updates.
204 key, enter the desired interval in seconds, followed by enter.
205 Fractional seconds are honored.
206 Intervals lower than 0.1 seconds are not allowed.
208 Toggle between displaying current traffic rates (in packets and bytes per second)
209 and cummulative traffic (total packets and bytes since the tinc daemon started).
211 Sort the list of nodes by name.
213 Sort the list of nodes by incoming amount of bytes.
215 Sort the list of nodes by incoming amount of packets.
217 Sort the list of nodes by outgoing amount of bytes.
219 Sort the list of nodes by outgoing amount of packets.
221 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
223 Sort the list of nodes by sum of incoming and outgoing amount of packets.
225 Show amount of traffic in bytes.
227 Show amount of traffic in kilobytes.
229 Show amount of traffic in megabytes.
231 Show amount of traffic in gigabytes.
236 If you find any bugs, report them to tinc@tinc-vpn.org.
241 .Xr pcap-savefile 5 ,
244 .Pa http://www.tinc-vpn.org/ ,
245 .Pa http://www.cabal.org/ .
247 The full documentation for tinc is maintained as a Texinfo manual.
248 If the info and tinc programs are properly installed at your site,
251 should give you access to the complete manual.
253 tinc comes with ABSOLUTELY NO WARRANTY.
254 This is free software, and you are welcome to redistribute it under certain conditions;
255 see the file COPYING for details.
258 .An "Guus Sliepen" Aq guus@tinc-vpn.org
260 And thanks to many others for their contributions to tinc!