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 data generated by the
85 export command from standard input.
86 Already existing host configuration files are not overwritten unless the option
89 .It start Op tincd options
92 optionally with the given extra options.
100 Partially rereads configuration files. Connections to hosts whose host
101 config files are removed are closed. New outgoing connections specified
106 Shows the PID of the currently running
108 .It generate-keys Op bits
109 Generate both RSA and ECDSA keypairs (see below) and exit.
110 .It generate-ecdsa-keys
111 Generate public/private ECDSA keypair and exit.
112 .It generate-rsa-keys Op bits
113 Generate public/private RSA keypair and exit.
116 is omitted, the default length will be 2048 bits.
117 When saving keys to existing files, tinc will not delete the old keys;
118 you have to remove them manually.
119 .It dump [reachable] nodes
120 Dump a list of all known nodes in the VPN.
121 If the keyword reachable is used, only lists reachable nodes.
123 Dump a list of all known connections in the VPN.
125 Dump a list of all known subnets in the VPN.
127 Dump a list of all meta connections with ourself.
128 .It dump graph | digraph
129 Dump a graph of the VPN in
132 Nodes are colored according to their reachability:
133 red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable.
134 Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet.
135 .It info Ar node | subnet | address
136 Show information about a particular node, subnet or address.
137 If an address is given, any matching subnet will be shown.
139 Purges all information remembered about unreachable nodes.
144 Capture log messages from a running tinc daemon.
145 An optional debug level can be given that will be applied only for log messages sent to
150 to try to connect to all uplinks immediately.
153 attempts to do this itself,
154 but increases the time it waits between the attempts each time it failed,
157 didn't succeed to connect to an uplink the first time after it started,
158 it defaults to the maximum time of 15 minutes.
159 .It disconnect Ar NODE
160 Closes the meta connection with the given
165 is compiled with libcurses support, this will display live traffic statistics
166 for all the known nodes, similar to the UNIX
169 See below for more information.
171 Dump VPN traffic going through the local tinc node in
173 format to standard output,
174 from where it can be redirected to a file or piped through a program that can parse it directly,
179 Examples of some commands:
180 .Bd -literal -offset indent
181 tincctl -n vpn dump graph | circo -Txlib
182 tincctl -n vpn pcap | tcpdump -r -
186 Example of configuring tinc using
188 .Bd -literal -offset indent
189 tincctl -n vpn init foo
190 tincctl -n vpn config Subnet 192.168.1.0/24
191 tincctl -n vpn config bar.Address bar.example.com
192 tincctl -n vpn config ConnectTo bar
193 tincctl -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@example.com
196 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
197 It displays a list of all the known nodes in the left-most column,
198 and the amount of bytes and packets read from and sent to each node in the other columns.
199 By default, the information is updated every second.
200 The behaviour of the top command can be changed using the following keys:
203 Change the interval between updates.
206 key, enter the desired interval in seconds, followed by enter.
207 Fractional seconds are honored.
208 Intervals lower than 0.1 seconds are not allowed.
210 Toggle between displaying current traffic rates (in packets and bytes per second)
211 and cumulative traffic (total packets and bytes since the tinc daemon started).
213 Sort the list of nodes by name.
215 Sort the list of nodes by incoming amount of bytes.
217 Sort the list of nodes by incoming amount of packets.
219 Sort the list of nodes by outgoing amount of bytes.
221 Sort the list of nodes by outgoing amount of packets.
223 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
225 Sort the list of nodes by sum of incoming and outgoing amount of packets.
227 Show amount of traffic in bytes.
229 Show amount of traffic in kilobytes.
231 Show amount of traffic in megabytes.
233 Show amount of traffic in gigabytes.
238 If you find any bugs, report them to tinc@tinc-vpn.org.
243 .Xr pcap-savefile 5 ,
246 .Pa http://www.tinc-vpn.org/ ,
247 .Pa http://www.cabal.org/ .
249 The full documentation for tinc is maintained as a Texinfo manual.
250 If the info and tinc programs are properly installed at your site,
253 should give you access to the complete manual.
255 tinc comes with ABSOLUTELY NO WARRANTY.
256 This is free software, and you are welcome to redistribute it under certain conditions;
257 see the file COPYING for details.
260 .An "Guus Sliepen" Aq guus@tinc-vpn.org
262 And thanks to many others for their contributions to tinc!