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