Add the ability to query configuration variables to tincctl.
[tinc] / doc / tincd.8.in
1 .Dd 2011-06-25
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 cdDKnoLRU
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 -net Ns = Ns Ar NETNAME
16 .Op Fl -option Ns = Ns Ar [HOST.]KEY=VALUE
17 .Op Fl -mlock
18 .Op Fl -logfile Ns Op = Ns Ar FILE
19 .Op Fl -bypass-security
20 .Op Fl -chroot
21 .Op Fl -user Ns = Ns Ar USER
22 .Op Fl -help
23 .Op Fl -version
24 .Sh DESCRIPTION
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 (not Cygwin) tinc will install itself as a service,
38 which will be restarted automatically after reboots.
39 .Sh OPTIONS
40 .Bl -tag -width indent
41 .It Fl c, -config Ns = Ns Ar DIR
42 Read configuration files from
43 .Ar DIR
44 instead of
45 .Pa @sysconfdir@/tinc/ .
46 .It Fl D, -no-detach
47 Don't fork and detach.
48 This will also disable the automatic restart mechanism for fatal errors.
49 If not mentioned otherwise, this will show log messages on the standard error output.
50 .It Fl d, -debug Ns Op = Ns Ar LEVEL
51 Increase debug level or set it to
52 .Ar LEVEL
53 (see below).
54 .It Fl n, -net Ns = Ns Ar NETNAME
55 Connect to net
56 .Ar NETNAME .
57 This will let tinc read all configuration files from
58 .Pa @sysconfdir@/tinc/ Ar NETNAME .
59 Specifying
60 .Li .
61 for
62 .Ar NETNAME
63 is the same as not specifying any
64 .Ar NETNAME .
65 .It Fl o, -option Ns = Ns Ar [HOST.]KEY=VALUE
66 Without specifying a
67 .Ar HOST ,
68 this will set server configuration variable
69 .Ar KEY 
70 to
71 .Ar VALUE .
72 If specified as
73 .Ar HOST.KEY=VALUE ,
74 this will set the host configuration variable 
75 .Ar KEY
76 of the host named
77 .Ar HOST
78 to
79 .Ar VALUE .
80 This option can be used more than once to specify multiple configuration variables.
81 .It Fl L, -mlock
82 Lock tinc into main memory.
83 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
84 .It Fl -logfile Ns Op = Ns Ar FILE
85 Write log entries to a file instead of to the system logging facility.
86 If
87 .Ar FILE
88 is omitted, the default is
89 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
90 .It Fl -pidfile Ns = Ns Ar FILENAME
91 Store a cookie in
92 .Ar FILENAME
93 which allows
94 .Xr tincctl 8
95 to authenticate.
96 If
97 .Ar FILE
98 is omitted, the default is
99 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
100 .It Fl -bypass-security
101 Disables encryption and authentication of the meta protocol.
102 Only useful for debugging.
103 .It Fl R, -chroot
104 With this option tinc chroots into the directory where network
105 config is located (@sysconfdir@/tinc/NETNAME if -n option is used,
106 or to the directory specified with -c option) after initialization.
107 .It Fl U, -user Ns = Ns Ar USER
108 setuid to the specified
109 .Ar USER
110 after initialization.
111 .It Fl -help
112 Display short list of options.
113 .It Fl -version
114 Output version information and exit.
115 .El
116 .Sh SIGNALS
117 .Bl -tag -width indent
118 .It ALRM
119 Forces
120 .Nm
121 to try to connect to all uplinks immediately.
122 Usually
123 .Nm
124 attempts to do this itself,
125 but increases the time it waits between the attempts each time it failed,
126 and if
127 .Nm
128 didn't succeed to connect to an uplink the first time after it started,
129 it defaults to the maximum time of 15 minutes.
130 .It HUP
131 Partially rereads configuration files.
132 Connections to hosts whose host config file are removed are closed.
133 New outgoing connections specified in
134 .Pa tinc.conf
135 will be made.
136 If the
137 .Fl -logfile
138 option is used, this will also close and reopen the log file,
139 useful when log rotation is used.
140 .El
141 .Sh DEBUG LEVELS
142 The tinc daemon can send a lot of messages to the syslog.
143 The higher the debug level,
144 the more messages it will log.
145 Each level inherits all messages of the previous level:
146 .Bl -tag -width indent
147 .It 0
148 This will log a message indicating
149 .Nm
150 has started along with a version number.
151 It will also log any serious error.
152 .It 1
153 This will log all connections that are made with other tinc daemons.
154 .It 2
155 This will log status and error messages from scripts and other tinc daemons.
156 .It 3
157 This will log all requests that are exchanged with other tinc daemons. These include
158 authentication, key exchange and connection list updates.
159 .It 4
160 This will log a copy of everything received on the meta socket.
161 .It 5
162 This will log all network traffic over the virtual private network.
163 .El
164 .Sh FILES
165 .Bl -tag -width indent
166 .It Pa @sysconfdir@/tinc/
167 Directory containing the configuration files tinc uses.
168 For more information, see
169 .Xr tinc.conf 5 .
170 .It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid
171 The PID of the currently running
172 .Nm
173 is stored in this file.
174 .El
175 .Sh BUGS
176 The
177 .Va BindToInterface
178 option may not work correctly.
179 .Pp
180 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
181 .Pp
182 If you find any bugs, report them to tinc@tinc-vpn.org.
183 .Sh TODO
184 A lot, especially security auditing.
185 .Sh SEE ALSO
186 .Xr tincctl 8 ,
187 .Xr tinc.conf 5 ,
188 .Pa http://www.tinc-vpn.org/ ,
189 .Pa http://www.cabal.org/ .
190 .Pp
191 The full documentation for tinc is maintained as a Texinfo manual.
192 If the info and tinc programs are properly installed at your site,
193 the command
194 .Ic info tinc
195 should give you access to the complete manual.
196 .Pp
197 tinc comes with ABSOLUTELY NO WARRANTY.
198 This is free software, and you are welcome to redistribute it under certain conditions;
199 see the file COPYING for details.
200 .Sh AUTHORS
201 .An "Ivo Timmermans"
202 .An "Guus Sliepen" Aq guus@tinc-vpn.org
203 .Pp
204 And thanks to many others for their contributions to tinc!