- Updated manual pages.

This commit is contained in:
Guus Sliepen 2001-01-06 18:44:55 +00:00
parent 90bf1b21fa
commit 0d99ae59bd
2 changed files with 28 additions and 7 deletions

View file

@ -1,4 +1,4 @@
.TH TINC 5 "May 2000" "tinc version 1.0" "FSF"
.TH TINC 5 "Jan 2001" "tinc version 1.0pre4" "FSF"
.SH NAME
tinc.conf \- tinc daemon configuration
.SH "DESCRIPTION"
@ -104,10 +104,16 @@ probe to the other end. If that other end doesn't answer within that
same amount of seconds, the connection is terminated, and the others
will be notified of this.
.TP
\fBPrivateKey\fR = <\fIkey\fR> (required)
\fBPrivateKey\fR = <\fIkey\fR>
The private RSA key of this tinc daemon. It will allow this tinc daemon to
authenticate itself to other daemons.
.TP
\fBPrivateKeyFile\fR = <\fIfilename\fR>
The file in which the private RSA key of this tinc daemon resides.
Note that there must be exactly one of \fBPrivateKey\fR or \fBPrivateKeyFile\fR
specified in the configuration file.
.TP
\fBTapDevice\fR = <\fIdevice\fR> (/dev/tap0)
The ethertap or tun/tap device to use. tinc will automatically detect what
kind of tapdevice it is.
@ -134,10 +140,17 @@ The real address or hostname of this tinc daemon.
\fBPort\fR = <\fIport number\fR> (655)
The port on which this tinc daemon is listening for incoming connections.
.TP
\fBPublicKey\fR = <\fIkey\fR> (required)
\fBPublicKey\fR = <\fIkey\fR>
The public RSA key of this tinc daemon. It will be used to cryptographically
verify it's identity and to set up a secure connection.
.TP
\fBPublicKeyFile\fR = <\fIfilename\fR>
The file in which the public RSA key of this tinc daemon resides.
Note that there must be exactly one of \fBPublicKey\fR or \fBPublicKeyFile\fR
specified in each host configuration file, if you want to be able to establish
a connection with that host.
.TP
\fBSubnet\fR = <\fIaddress/masklength\fR> (optional)
The subnet which this tinc daemon will serve. tinc tries to look up which other
daemon it should send a packet to by searching the appropiate subnet. If the

View file

@ -1,4 +1,4 @@
.TH TINCD 8 "June 2000" "tinc version 1.0pre3" "FSF"
.TH TINCD 8 "Jan 2001" "tinc version 1.0pre4" "FSF"
.SH NAME
tincd \- tinc VPN daemon
.SH SYNOPSIS
@ -13,6 +13,7 @@ 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 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.
@ -93,12 +94,19 @@ This will log all network traffic over the virtual private network.
.SH "FILES"
.TP
\fI/etc/tinc/<NETNAME>/tinc.conf\fR
The configuration file for tincd. This should also contain the private RSA key.
The configuration file for tincd.
.TP
\fI/etc/tinc/<NETNAME>/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/<NETNAME>/tinc-down\fR
Script which is executed when tinc quits.
Purpose is to shut down the tap device.
.TP
\fI/etc/tinc/<NETNAME>/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.
.PP
.SH "BUGS"
Maintaining a connection list on each tinc daemon that can connect and disconnect at any