Initial revision
[oweals/tinc.git] / README
1 This is the README file for tinc version 0.3.
2 Installation instructions may be found in the INSTALL file.
3
4 tinc is Copyright (C) 1998,99 Ivo Timmermans <zarq@iname.com> and
5 others. For a complete list of authors see the AUTHORS file.
6 This product includes software developed by Eric Young (eay@mincom.oz.au)
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or (at
11 your option) any later version. See the file COPYING for more details.
12
13 This version of tinc relies on the GNU Multi-Precision Library
14 (gmp). This library is available from your nearest GNU mirror. Please
15 install this first even before trying to run configure. If you don't
16 do this, configure will (hopefully) mention it to you.
17
18 This version of tinc supports multiple virtual networks at once. To
19 use this feature, you may supply a netname via the -n or --net
20 options. The standard locations for the config files will then be
21 /etc/tinc/<net>/.
22
23 In this version, MAC addresses are stripped off before encoding and
24 sending a packet. When the packet reaches its destination, the MAC
25 addresses are rebuilt again. They then have the form
26 FE:FD:aa:bb:cc:dd. aa, bb, cc and dd are taken from the destination
27 and source IP address.
28
29 tincd regenerates its encryption key pairs. It does this on the first
30 activity after the keys have expired. This period is adjustable in the
31 configuration file, and the default time is 3600 seconds (one
32 hour). If you send a USR2 signal to the daemon, it'll regenerate
33 immediately.