www.tinc-vpn.org Git - tinc/blob - doc/tincd.8

   1 .TH TINCD 8 "June 2000" "tinc version 1.0pre3" "FSF"
   2 .SH NAME
   3 tinc \- tinc VPN daemon
   4 .SH SYNOPSIS
   5 .B tincd
   6 [\fIoption\fR]...
   7 .SH DESCRIPTION
   8 .PP
   9
  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 subnet
  13 it has to serve and to what other tinc daemons it should connect.
  14 It will connect to the ethertap device and set up a socket for incomming
  15 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.
  19
  20 .SH OPTIONS
  21 .TP
  22 \fB\-c\fR, \fB\-\-config\fR=\fIFILE\fR
  23 Read configuration options from FILE.
  24 .TP
  25 \fB\-D\fR, \fB\-\-no\-detach\fR
  26 Don't fork and detach.
  27 .TP
  28 \fB\-d\fR
  29 Increase debug level.
  30 .TP
  31 \fB\-k\fR, \fB\-\-kill\fR
  32 Attempt to kill a running tincd and exit.
  33 .TP
  34 \fB\-n\fR, \fB\-\-net\fR=\fINETNAME\fR
  35 Connect to net NETNAME.
  36 .TP
  37 \fB\-t\fR, \fB\-\-timeout\fR=\fITIMEOUT\fR
  38 Seconds to wait before giving a timeout.
  39 .TP
  40 \fB\-\-help\fR
  41 Display this help and exit.
  42 .TP
  43 \fB\-\-version\fR
  44 Output version information and exit.
  45 .PP
  46 .SH "SIGNALS"
  47 .TP
  48 \fBHUP\fR
  49 Closes all connections, rereads the configuration file and restarts the daemon.
  50 .TP
  51 \fBINT\fR
  52 Closes all connections and quits.
  53 .TP
  54 \fBUSR1\fR
  55 Dumps the connection list to syslog.
  56 .TP
  57 \fBUSR2\fR
  58 Invalidates the current cryptographic key and generates a new one.
  59 .TP
  60 \fBALRM\fR
  61 Forces tincd to try to connect to an uplink immediately. Usually tincd attempts
  62 to do this itself, but increases the time it waits between the attempts each time
  63 it failed, and if tincd didn't succeed to connect to an uplink the first time after
  64 it started, it defaults to the maximum time of 15 minutes.
  65 .PP
  66 .SH "DEBUG LEVELS"
  67 The tinc daemon can send a lot of messages to the syslog. The more \fB\-d\fR options are
  68 given to tincd, the more messages it will log. Each level inherits all messages of the
  69 previous level:
  70 .TP
  71 \fIno debug options\fR
  72 This will log a message indicating tincd has started along with a version number.
  73 It will also any serious error.
  74 .TP
  75 \fB\-d\fR
  76 This will log all connections that are made with other tinc daemons.
  77 .TP
  78 \fB\-d \-d\fR
  79 This will log all requests that are exchanged with other tinc daemons. These include
  80 authentication, key exchange and connection list updates.
  81 .TP
  82 \fB\-d \-d \-d\fR
  83 This will log a copy of everything received on the meta socket.
  84 .TP
  85 \fB\-d \-d \-d \-d\fR
  86 This will log all packets that are sent over the virtual private network.
  87 .PP
  88 .SH "FILES"
  89 .TP
  90 \fI/etc/tinc/<NETNAME>/tinc.conf\fR
  91 The configuration file for tincd.
  92 .TP
  93 \fI/etc/tinc/<NETNAME>/passphrases/*\fR
  94 The directory containing the secret passphrases
  95 used to authenticate other tinc daemons.
  96 .PP
  97 .SH "BUGS"
  98 Maintaining a connection list on each tinc daemon that can connect and disconnect at any
  99 moment, and making sure that all connections satisfy the tree property isn't easy. Although
 100 we have done a lot to make sure tinc is sturdy and foolproof, it might happen that
 101 some connection lists get corrupted.
 102 .PP
 103 If you find any bugs, report them to tinc@nl.linux.org.
 104 .PP
 105 .SH "TODO"
 106 A lot. If something you would like to see is not implemented, just ask; we most certainly will.
 107 .PP
 108 .SH "SEE ALSO"
 109 \fBtinc.conf\fR(5), \fBgenauth\fR(8)
 110 .TP
 111 \fBhttp://tinc.nl.linux.org/\fR
 112 .TP
 113 \fBhttp://www.cabal.org/\fR
 114 .PP
 115 The full documentation for
 116 .B tinc
 117 is maintained as a Texinfo manual.  If the
 118 .B info
 119 and
 120 .B tinc
 121 programs are properly installed at your site, the command
 122 .IP
 123 .B info tinc
 124 .PP
 125 should give you access to the complete manual.
 126 .PP
 127 tinc comes with ABSOLUTELY NO WARRANTY.  This is free software,
 128 and you are welcome to redistribute it under certain conditions;
 129 see the file COPYING for details.
 130 .PP
 131 This product includes software developed by Eric Young (eay@mincom.oz.au)
 132 .SH "AUTHORS"
 133 .na
 134 .nf
 135 Ivo Timmermans <itimmermans@bigfoot.com>
 136 Guus Sliepen <guus@sliepen.warande.net>
 137
 138 And thanks to many others for their contributions to tinc!
 139 .PP