3 .\" Manual page created by:
4 .\" Ivo Timmermans <ivo@o2w.nl>
5 .\" Guus Sliepen <guus@sliepen.eu.org>
12 .Op Fl -bypass-security
13 .Op Fl -config Ns = Ns Ar DIR
14 .Op Fl -debug Ns = Ns Ar LEVEL
15 .Op Fl -generate-keys Ns Op = Ns Ar BITS
17 .Op Fl -kill Ns = Ns Ar SIGNAL
18 .Op Fl -net Ns = Ns Ar NETNAME
22 This is the daemon of tinc, a secure virtual private network (VPN) project.
25 will read it's configuration file to determine what virtual subnets it has to serve
26 and to what other tinc daemons it should connect.
27 It will connect to the ethertap or tun/tap device
28 and set up a socket for incoming connections.
29 Optionally a script will be executed to further configure the virtual device.
31 it will detach from the controlling terminal and continue in the background,
32 accepting and setting up connections to other tinc daemons
33 that are part of the virtual private network.
35 .Bl -tag -width indent
36 .It Fl -bypass-security
37 Disables encryption and authentication.
38 Only useful for debugging.
39 .It Fl c, -config Ns = Ns Ar DIR
40 Read configuration options from
42 .It Fl d, -debug Ns Op = Ns Ar LEVEL
43 Increase debug level or set it to
46 .It Fl K, -generate-keys Ns Op = Ns Ar BITS
47 Generate public/private RSA keypair and exit.
50 is omitted, the default length will be 1024 bits.
52 Display short list of options.
53 .It Fl k, -kill Ns Op = Ns Ar SIGNAL
54 Attempt to kill a running
56 (optionally with the specified
58 instead of SIGTERM) and exit.
59 .It Fl n, -net Ns = Ns Ar NETNAME
63 Don't fork and detach.
64 This will also disable the automatic restart mechanism for fatal errors.
66 Lock tinc into main memory.
67 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
69 Output version information and exit.
72 .Bl -tag -width indent
76 to try to connect to all uplinks immediately.
79 attempts to do this itself,
80 but increases the time it waits between the attempts each time it failed,
83 didn't succeed to connect to an uplink the first time after it started,
84 it defaults to the maximum time of 15 minutes.
86 Closes all connections, rereads the configuration file and restarts the daemon.
88 Temporarily increases debug level to 5.
89 Send this signal again to revert to the original level.
91 Dumps the connection list to syslog.
93 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
95 Purges all information remembered about unreachable nodes.
98 The tinc daemon can send a lot of messages to the syslog.
99 The higher the debug level,
100 the more messages it will log.
101 Each level inherits all messages of the previous level:
102 .Bl -tag -width indent
104 This will log a message indicating
106 has started along with a version number.
107 It will also any serious error.
109 This will log all connections that are made with other tinc daemons.
111 This will log status and error messages from other tinc daemons.
113 This will log all requests that are exchanged with other tinc daemons. These include
114 authentication, key exchange and connection list updates.
116 This will log a copy of everything received on the meta socket.
118 This will log all network traffic over the virtual private network.
121 .Bl -tag -width indent
122 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
123 The configuration file for
125 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
126 Script which is executed as soon as the virtual network device has been allocated.
127 Purpose is to further configure that device.
128 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
129 Script which is executed when
132 Purpose is to cleanly shut down the virtual network device before it will be deallocated.
133 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/*
134 The directory containing the host configuration files
135 used to authenticate other tinc daemons.
136 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -up
137 Script which is executed as soon as host
140 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -down
141 Script which is executed as soon as host
144 .It Pa /var/run/tinc. Ns Ar NETNAME Ns Pa .pid
145 The PID of the currently running
147 is stored in this file.
152 option may not work correctly.
154 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
156 If you find any bugs, report them to tinc@nl.linux.org.
158 A lot, especially security auditing.
161 .Pa http://tinc.nl.linux.org/ ,
162 .Pa http://www.cabal.org/ .
164 The full documentation for tinc is maintained as a Texinfo manual.
165 If the info and tinc programs are properly installed at your site,
168 should give you access to the complete manual.
170 tinc comes with ABSOLUTELY NO WARRANTY.
171 This is free software, and you are welcome to redistribute it under certain conditions;
172 see the file COPYING for details.
174 .An "Ivo Timmermans" Aq ivo@o2w.nl
175 .An "Guus Sliepen" Aq guus@sliepen.eu.org
177 And thanks to many others for their contributions to tinc!