Move all process-related functions into process.c.
[tinc] / doc / tincd.8
1 .TH TINCD 8 "June 2000" "tinc version 1.0pre3" "FSF"
3 tincd \- tinc VPN daemon
5 .B tincd
6 [\fIoption\fR]...
8 .PP
10 This is the daemon of tinc, a secure virtual private
11 network (VPN) project. When started, tincd will read
12 it's configuration file to determine what virtual subnets
13 it has to serve and to what other tinc daemons it should connect.
14 It will connect to the ethertap or tun/tap device and set up a socket
15 for incoming connections.
16 If that succeeds, it will detach from the controlling terminal and
17 continue in the background, accepting and setting up connections to other
18 tinc daemons that are part of the virtual private network.
21 .TP
22 \fB\-c\fR, \fB\-\-config\fR=\fIDIR\fR
23 Read configuration options from DIR.
24 .TP
25 \fB\-D\fR, \fB\-\-no\-detach\fR
26 Don't fork and detach. This will also disable the automatic
27 restart mechanism for fatal errors.
28 .TP
29 \fB\-d\fR
30 Increase debug level (see below).
31 .TP
32 \fB\-k\fR, \fB\-\-kill\fR
33 Attempt to kill a running tincd and exit.
34 .TP
35 \fB\-n\fR, \fB\-\-net\fR=\fINETNAME\fR
36 Connect to net NETNAME.
37 .TP
38 \fB\-K\fR, \fB\-\-generate-keys\fR[=\fIBITS]\fR
39 Generate public/private RSA keypair and exit. If BITS is omitted,
40 the default length will be 1024 bits.
41 .TP
42 \fB\-\-help\fR
43 Display short list of options.
44 .TP
45 \fB\-\-version\fR
46 Output version information and exit.
47 .PP
49 .TP
50 \fBHUP\fR
51 Closes all connections, rereads the configuration file and restarts the daemon.
52 .TP
53 \fBINT\fR
54 Closes all connections and quits.
55 .TP
56 \fBUSR1\fR
57 Dumps the connection list to syslog.
58 .TP
59 \fBUSR2\fR
60 Dumps the subnet list to syslog.
61 .TP
62 \fBALRM\fR
63 Forces tincd to try to connect to an uplink immediately. Usually tincd attempts
64 to do this itself, but increases the time it waits between the attempts each time
65 it failed, and if tincd didn't succeed to connect to an uplink the first time after
66 it started, it defaults to the maximum time of 15 minutes.
67 .PP
69 The tinc daemon can send a lot of messages to the syslog. The more \fB\-d\fR options are
70 given to tincd, the more messages it will log. Each level inherits all messages of the
71 previous level:
72 .TP
73 \fIno debug options\fR
74 This will log a message indicating tincd has started along with a version number.
75 It will also any serious error.
76 .TP
77 \fB\-d\fR
78 This will log all connections that are made with other tinc daemons.
79 .TP
80 \fB\-dd\fR
81 This will log status and error messages from other tinc daemons.
82 .TP
83 \fB\-ddd\fR
84 This will log all requests that are exchanged with other tinc daemons. These include
85 authentication, key exchange and connection list updates.
86 .TP
87 \fB\-dddd\fR
88 This will log a copy of everything received on the meta socket.
89 .TP
90 \fB\-ddddd\fR
91 This will log all network traffic over the virtual private network.
92 .PP
93 .SH "FILES"
94 .TP
95 \fI/etc/tinc/<NETNAME>/tinc.conf\fR
96 The configuration file for tincd. This should also contain the private RSA key.
97 .TP
98 \fI/etc/tinc/<NETNAME>/hosts/*\fR
99 The directory containing the host configuration files
100 used to authenticate other tinc daemons. They contain
101 the public RSA keys of other hosts.
102 .PP
103 .SH "BUGS"
104 Maintaining a connection list on each tinc daemon that can connect and disconnect at any
105 moment, and making sure that all connections satisfy the tree property isn't easy. Although
106 we have done a lot to make sure tinc is sturdy and foolproof, it might happen that
107 some connection lists get corrupted.
108 .PP
109 \fBThe cryptography in tinc is not well tested yet. Use it at your own risk!\fR
110 .PP
111 If you find any bugs, report them to
112 .PP
113 .SH "TODO"
114 A lot, especially security auditting.
115 .PP 
116 .SH "SEE ALSO"
117 \fBtinc.conf\fR(5)
118 .TP
119 \fB\fR
120 .TP
121 \fB\fR
122 .PP
123 The full documentation for
124 .B tinc
125 is maintained as a Texinfo manual.  If the
126 .B info
127 and
128 .B tinc
129 programs are properly installed at your site, the command
130 .IP
131 .B info tinc
132 .PP
133 should give you access to the complete manual.
134 .PP
135 tinc comes with ABSOLUTELY NO WARRANTY.  This is free software,
136 and you are welcome to redistribute it under certain conditions;
137 see the file COPYING for details.
139 .na
140 .nf
141 Ivo Timmermans <>
142 Guus Sliepen <>
144 And thanks to many others for their contributions to tinc!
145 .PP