Releasing 1.1pre1.
[wiki] / docs.mdwn
1 ## Documentation
2
3 Most of the documentation you can find here is in the tinc packages
4 as well. If you have any questions you cannot find answered here,
5 please try the list of [[Frequently Asked Questions|faq]]. If you
6 still have a problem or comments you can send them to the
7 [[mailing list|mail]] or you can [[contact]] the authors.
8
9 Note: documentation is always behind. If you think you miss
10 something, you spotted an error or you notice that the program does
11 something else than the documentation says, please tell us!
12
13 ### Manual
14
15 The main source of information is the
16 manual ([HTML](/documentation/tinc_toc), [PDF](/documentation/tinc.pdf)).
17 This text describes how to
18 set up a VPN using tinc. It also contains a chapter with more
19 technical details, which you may want to read, as well as the ideas
20 behind tinc. This manual is currently up to date with version
21 1.0.15.
22
23 ### Manpages
24
25 You can also view the HTML version of the manpages that come with
26 version 1.0.15 of tinc:
27
28 - [tincd(8)](/documentation/tincd.8)
29 - [tinc.conf(5)](/documentation/tinc.conf.5)
30
31 ### Tinc 1.1 documentation
32
33 The documentation for the prerelease versions of tinc 1.1 is also available:
34
35 - [manual (HTML)](/documentation-1.1/tinc_toc)
36 - [manual (PDF)](/documentation-1.1/tinc.pdf)
37 - [tincd(8)](/documentation-1.1/tincd.8)
38 - [tincctl(8)](/documentation-1.1/tincctl.8)
39 - [tinc.conf(5)](/documentation-1.1/tinc.conf.5)
40
41 ### Examples
42
43 After reading the manual, you can look at further
44 [[examples]] of configuration files and scripts for
45 various setups. There is also an example of
46 [[installing tinc on Windows|examples/windows-install]].
47
48 ### Other material
49
50 - The sheets of the
51   [presentation about VPNs and tinc](/presentations/linuxexpo-20010123/)
52   we gave during the Linux Expo in Amsterdam, 2001/01/23.
53 - The sheets of the
54   [presentation about VPNs and tinc](/presentations/nllgg/tp.ps.gz)
55   we gave at the NLLGG meeting 2000/10/07.