Small corrections to the manuals.

[tinc] / doc / tincd.8

diff --git a/doc/tincd.8 b/doc/tincd.8
index 648c5de..138d811 100644 (file)
--- a/doc/tincd.8
+++ b/doc/tincd.8
@@ -1,6 +1,6 @@
-.TH TINCD 8 "June 2000" "tinc version 1.0pre3" "FSF"
+.TH TINCD 8 "Jan 2001" "tinc version 1.0pre4" "FSF"
 .SH NAME
-tinc \- tinc VPN daemon
+tincd \- tinc VPN daemon
 .SH SYNOPSIS
 .B tincd
 [\fIoption\fR]...
@@ -12,7 +12,8 @@ network (VPN) project. When started, tincd will read
 it's configuration file to determine what virtual subnets
 it has to serve and to what other tinc daemons it should connect.
 It will connect to the ethertap or tun/tap device and set up a socket
-for incomming connections.
+for incoming connections.
+Optionally a script will be executed to further configure the tap device.
 If that succeeds, it will detach from the controlling terminal and
 continue in the background, accepting and setting up connections to other
 tinc daemons that are part of the virtual private network.
@@ -32,10 +33,10 @@ Increase debug level (see below).
 \fB\-k\fR, \fB\-\-kill\fR
 Attempt to kill a running tincd and exit.
 .TP
-\fB\-n\fR, \fB\-\-net\fR=\fINETNAME\fR
-Connect to net NETNAME.
+\fB\-n\fR, \fB\-\-net\fR=\fInetname\fR
+Connect to net `netname'.
 .TP
-\fB\-K\fR, \fB\-\-generate-key\fR[=\fIBITS]\fR
+\fB\-K\fR, \fB\-\-generate-keys\fR[=\fIBITS]\fR
 Generate public/private RSA keypair and exit. If BITS is omitted,
 the default length will be 1024 bits.
 .TP
@@ -92,19 +93,26 @@ This will log all network traffic over the virtual private network.
 .PP
 .SH "FILES"
 .TP
-\fI/etc/tinc/<NETNAME>/tinc.conf\fR
-The configuration file for tincd. This should also contain the private RSA key.
+\fI/etc/tinc/\fBnetname\fI/tinc.conf\fR
+The configuration file for tincd.
 .TP
-\fI/etc/tinc/<NETNAME>/hosts/*\fR
+\fI/etc/tinc/\fBnetname\fI/tinc-up\fR
+Script which is executed as soon as a tap device has been allocated.
+Purpose is to further configure that device.
+.TP
+\fI/etc/tinc/\fBnetname\fI/tinc-down\fR
+Script which is executed when tinc quits.
+Purpose is to shut down the tap device.
+.TP
+\fI/etc/tinc/\fBnetname\fI/hosts/*\fR
 The directory containing the host configuration files
-used to authenticate other tinc daemons. They contain
-the public RSA keys of other hosts.
+used to authenticate other tinc daemons.
+.TP
+\fI/var/run/tinc.\fBnetname\fI.pid\fR
+The PID of the currently running tincd is stored in this file.
 .PP
 .SH "BUGS"
-Maintaining a connection list on each tinc daemon that can connect and disconnect at any
-moment, and making sure that all connections satisfy the tree property isn't easy. Although
-we have done a lot to make sure tinc is sturdy and foolproof, it might happen that
-some connection lists get corrupted.
+The TCPonly and IndirectData options may not work correctly.
 .PP
 \fBThe cryptography in tinc is not well tested yet. Use it at your own risk!\fR
 .PP