[tinc] / doc / tincd.8
1 .Dd 2002-03-25
2 .Dt TINCD 8
3 .\" Manual page created by:
4 .\" Ivo Timmermans <>
5 .\" Guus Sliepen <>
6 .Sh NAME
7 .Nm tincd
8 .Nd tinc VPN daemon
10 .Nm
11 .Op Fl cdDkKnL
12 .Op Fl -config Ns = Ns Ar DIR
13 .Op Fl -no-detach
14 .Op Fl -debug Ns Op = Ns Ar LEVEL
15 .Op Fl -kill Ns Op = Ns Ar SIGNAL
16 .Op Fl -net Ns = Ns Ar NETNAME
17 .Op Fl -generate-keys Ns Op = Ns Ar BITS
18 .Op Fl -mlock
19 .Op Fl -logfile Ns Op = Ns Ar FILE
20 .Op Fl -pidfile Ns = Ns Ar FILE
21 .Op Fl -bypass-security
22 .Op Fl -help
23 .Op Fl -version
25 This is the daemon of tinc, a secure virtual private network (VPN) project.
26 When started,
27 .Nm
28 will read it's configuration file to determine what virtual subnets it has to serve
29 and to what other tinc daemons it should connect.
30 It will connect to the ethertap or tun/tap device
31 and set up a socket for incoming connections.
32 Optionally a script will be executed to further configure the virtual device.
33 If that succeeds,
34 it will detach from the controlling terminal and continue in the background,
35 accepting and setting up connections to other tinc daemons
36 that are part of the virtual private network.
38 .Bl -tag -width indent
39 .It Fl c, -config Ns = Ns Ar DIR
40 Read configuration options from
41 .Ar DIR .
42 .It Fl D, -no-detach
43 Don't fork and detach.
44 This will also disable the automatic restart mechanism for fatal errors.
45 .It Fl d, -debug Ns Op = Ns Ar LEVEL
46 Increase debug level or set it to
47 .Ar LEVEL
48 (see below).
49 .It Fl k, -kill Ns Op = Ns Ar SIGNAL
50 Attempt to kill a running
51 .Nm
52 (optionally with the specified
54 instead of SIGTERM) and exit.
55 .It Fl n, -net Ns = Ns Ar NETNAME
56 Connect to net
57 .Ar NETNAME .
58 .It Fl K, -generate-keys Ns Op = Ns Ar BITS
59 Generate public/private RSA keypair and exit.
60 If
61 .Ar BITS
62 is omitted, the default length will be 1024 bits.
63 .It Fl L, -mlock
64 Lock tinc into main memory.
65 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
66 .It Fl -logfile Ns Op = Ns Ar FILE
67 Write log entries to a file instead of to the system logging facility.
68 If
69 .Ar FILE
70 is omitted, the default is
71 .Pa /var/log/tinc. Ns Ar NETNAME Ns Pa .log.
72 .It Fl -pidfile Ns = Ns Ar FILE
73 Write PID to
74 .Ar FILE
75 instead of
76 .Pa /var/run/tinc. Ns Ar NETNAME Ns Pa .pid.
77 .It Fl -bypass-security
78 Disables encryption and authentication of the meta protocol.
79 Only useful for debugging.
80 .It Fl -help
81 Display short list of options.
82 .It Fl -version
83 Output version information and exit.
84 .El
86 .Bl -tag -width indent
87 .It ALRM
88 Forces
89 .Nm
90 to try to connect to all uplinks immediately.
91 Usually
92 .Nm
93 attempts to do this itself,
94 but increases the time it waits between the attempts each time it failed,
95 and if
96 .Nm
97 didn't succeed to connect to an uplink the first time after it started,
98 it defaults to the maximum time of 15 minutes.
99 .It HUP
100 Partially rereads configuration files.
101 Connections to hosts whose host config file are removed are closed.
102 New outgoing connections specified in
103 .Pa tinc.conf
104 will be made.
105 .It INT
106 Temporarily increases debug level to 5.
107 Send this signal again to revert to the original level.
108 .It USR1
109 Dumps the connection list to syslog.
110 .It USR2
111 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
112 .It WINCH
113 Purges all information remembered about unreachable nodes.
114 .El
116 The tinc daemon can send a lot of messages to the syslog.
117 The higher the debug level,
118 the more messages it will log.
119 Each level inherits all messages of the previous level:
120 .Bl -tag -width indent
121 .It 0
122 This will log a message indicating
123 .Nm
124 has started along with a version number.
125 It will also any serious error.
126 .It 1
127 This will log all connections that are made with other tinc daemons.
128 .It 2
129 This will log status and error messages from other tinc daemons.
130 .It 3
131 This will log all requests that are exchanged with other tinc daemons. These include
132 authentication, key exchange and connection list updates.
133 .It 4
134 This will log a copy of everything received on the meta socket.
135 .It 5
136 This will log all network traffic over the virtual private network.
137 .El
138 .Sh FILES
139 .Bl -tag -width indent
140 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
141 The configuration file for
142 .Nm .
143 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
144 Script which is executed as soon as the virtual network device has been allocated.
145 Purpose is to further configure that device.
146 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
147 Script which is executed when
148 .Nm
149 exits.
150 Purpose is to cleanly shut down the virtual network device before it will be deallocated.
151 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/*
152 The directory containing the host configuration files
153 used to authenticate other tinc daemons.
154 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -up
155 Script which is executed as soon as host
156 .Ar NAME
157 becomes reachable.
158 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -down
159 Script which is executed as soon as host
160 .Ar NAME
161 becomes unreachable.
162 .It Pa /var/run/tinc. Ns Ar NETNAME Ns Pa .pid
163 The PID of the currently running
164 .Nm
165 is stored in this file.
166 .El
167 .Sh BUGS
168 The
169 .Va BindToInterface
170 option may not work correctly.
171 .Pp
172 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
173 .Pp
174 If you find any bugs, report them to
175 .Sh TODO
176 A lot, especially security auditing.
177 .Sh SEE ALSO
178 .Xr tinc.conf 5 ,
179 .Pa ,
180 .Pa .
181 .Pp
182 The full documentation for tinc is maintained as a Texinfo manual.
183 If the info and tinc programs are properly installed at your site,
184 the command
185 .Ic info tinc
186 should give you access to the complete manual.
187 .Pp
188 tinc comes with ABSOLUTELY NO WARRANTY.
189 This is free software, and you are welcome to redistribute it under certain conditions;
190 see the file COPYING for details.
192 .An "Ivo Timmermans" Aq
193 .An "Guus Sliepen" Aq
194 .Pp
195 And thanks to many others for their contributions to tinc!