[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
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
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.
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
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 .It Fl K, -generate-keys Ns Op = Ns Ar BITS
68 Generate public/private RSA keypair and exit.
69 If
70 .Ar BITS
71 is omitted, the default length will be 2048 bits.
72 When saving keys to existing files, tinc will not delete the old keys,
73 you have to remove them manually.
74 .It Fl L, -mlock
75 Lock tinc into main memory.
76 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
77 .It Fl -logfile Ns Op = Ns Ar FILE
78 Write log entries to a file instead of to the system logging facility.
79 If
80 .Ar FILE
81 is omitted, the default is
82 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
83 .It Fl -pidfile Ns = Ns Ar FILE
84 Write PID to
85 .Ar FILE
86 instead of
87 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
88 Under Windows this option will be ignored.
89 .It Fl -bypass-security
90 Disables encryption and authentication of the meta protocol.
91 Only useful for debugging.
92 .It Fl -chroot
93 With this option tinc chroots into the directory where network
94 config is located (@sysconfdir@/tinc/NETNAME if -n option is used,
95 or to the directory specified with -c option) after initialization.
96 .It Fl -user Ns = Ns Ar USER
97 setuid to the specified
98 .Ar USER
99 after initialization.
100 .It Fl -help
101 Display short list of options.
102 .It Fl -version
103 Output version information and exit.
104 .El
106 .Bl -tag -width indent
107 .It ALRM
108 Forces
109 .Nm
110 to try to connect to all uplinks immediately.
111 Usually
112 .Nm
113 attempts to do this itself,
114 but increases the time it waits between the attempts each time it failed,
115 and if
116 .Nm
117 didn't succeed to connect to an uplink the first time after it started,
118 it defaults to the maximum time of 15 minutes.
119 .It HUP
120 Partially rereads configuration files.
121 Connections to hosts whose host config file are removed are closed.
122 New outgoing connections specified in
123 .Pa tinc.conf
124 will be made.
125 .It INT
126 Temporarily increases debug level to 5.
127 Send this signal again to revert to the original level.
128 .It USR1
129 Dumps the connection list to syslog.
130 .It USR2
131 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
132 .It WINCH
133 Purges all information remembered about unreachable nodes.
134 .El
136 The tinc daemon can send a lot of messages to the syslog.
137 The higher the debug level,
138 the more messages it will log.
139 Each level inherits all messages of the previous level:
140 .Bl -tag -width indent
141 .It 0
142 This will log a message indicating
143 .Nm
144 has started along with a version number.
145 It will also log any serious error.
146 .It 1
147 This will log all connections that are made with other tinc daemons.
148 .It 2
149 This will log status and error messages from scripts and other tinc daemons.
150 .It 3
151 This will log all requests that are exchanged with other tinc daemons. These include
152 authentication, key exchange and connection list updates.
153 .It 4
154 This will log a copy of everything received on the meta socket.
155 .It 5
156 This will log all network traffic over the virtual private network.
157 .El
158 .Sh FILES
159 .Bl -tag -width indent
160 .It Pa @sysconfdir@/tinc/
161 Directory containing the configuration files tinc uses.
162 For more information, see
163 .Xr tinc.conf 5 .
164 .It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid
165 The PID of the currently running
166 .Nm
167 is stored in this file.
168 .El
169 .Sh BUGS
170 The
171 .Va BindToInterface
172 option may not work correctly.
173 .Pp
174 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
175 .Pp
176 If you find any bugs, report them to tinc@tinc-vpn.org.
177 .Sh TODO
178 A lot, especially security auditing.
179 .Sh SEE ALSO
180 .Xr tinc.conf 5 ,
181 .Pa http://www.tinc-vpn.org/ ,
182 .Pa http://www.cabal.org/ .
183 .Pp
184 The full documentation for tinc is maintained as a Texinfo manual.
185 If the info and tinc programs are properly installed at your site,
186 the command
187 .Ic info tinc
188 should give you access to the complete manual.
189 .Pp
190 tinc comes with ABSOLUTELY NO WARRANTY.
191 This is free software, and you are welcome to redistribute it under certain conditions;
192 see the file COPYING for details.
194 .An "Ivo Timmermans"
195 .An "Guus Sliepen" Aq guus@tinc-vpn.org
196 .Pp
197 And thanks to many others for their contributions to tinc!