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