git.meshlink.io Git - meshlink/blob - doc/tincd.8

   1 .TH TINCD 8 "Jan 2001" "tinc version 1.0pre4" "FSF"
   2 .SH NAME
   3 tincd \- 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 subnets
  13 it has to serve and to what other tinc daemons it should connect.
  14 It will connect to the ethertap or tun/tap device and set up a socket
  15 for incoming connections.
  16 Optionally a script will be executed to further configure the tap device.
  17 If that succeeds, it will detach from the controlling terminal and
  18 continue in the background, accepting and setting up connections to other
  19 tinc daemons that are part of the virtual private network.
  20
  21 .SH OPTIONS
  22 .TP
  23 \fB\-c\fR, \fB\-\-config\fR=\fIDIR\fR
  24 Read configuration options from DIR.
  25 .TP
  26 \fB\-D\fR, \fB\-\-no\-detach\fR
  27 Don't fork and detach. This will also disable the automatic
  28 restart mechanism for fatal errors.
  29 .TP
  30 \fB\-d\fR
  31 Increase debug level (see below).
  32 .TP
  33 \fB\-k\fR, \fB\-\-kill\fR
  34 Attempt to kill a running tincd and exit.
  35 .TP
  36 \fB\-n\fR, \fB\-\-net\fR=\fInetname\fR
  37 Connect to net `netname'.
  38 .TP
  39 \fB\-K\fR, \fB\-\-generate-keys\fR[=\fIBITS]\fR
  40 Generate public/private RSA keypair and exit. If BITS is omitted,
  41 the default length will be 1024 bits.
  42 .TP
  43 \fB\-\-help\fR
  44 Display short list of options.
  45 .TP
  46 \fB\-\-version\fR
  47 Output version information and exit.
  48 .PP
  49 .SH "SIGNALS"
  50 .TP
  51 \fBHUP\fR
  52 Closes all connections, rereads the configuration file and restarts the daemon.
  53 .TP
  54 \fBINT\fR
  55 Closes all connections and quits.
  56 .TP
  57 \fBUSR1\fR
  58 Dumps the connection list to syslog.
  59 .TP
  60 \fBUSR2\fR
  61 Dumps the subnet list to syslog.
  62 .TP
  63 \fBALRM\fR
  64 Forces tincd to try to connect to an uplink immediately. Usually tincd attempts
  65 to do this itself, but increases the time it waits between the attempts each time
  66 it failed, and if tincd didn't succeed to connect to an uplink the first time after
  67 it started, it defaults to the maximum time of 15 minutes.
  68 .PP
  69 .SH "DEBUG LEVELS"
  70 The tinc daemon can send a lot of messages to the syslog. The more \fB\-d\fR options are
  71 given to tincd, the more messages it will log. Each level inherits all messages of the
  72 previous level:
  73 .TP
  74 \fIno debug options\fR
  75 This will log a message indicating tincd has started along with a version number.
  76 It will also any serious error.
  77 .TP
  78 \fB\-d\fR
  79 This will log all connections that are made with other tinc daemons.
  80 .TP
  81 \fB\-dd\fR
  82 This will log status and error messages from other tinc daemons.
  83 .TP
  84 \fB\-ddd\fR
  85 This will log all requests that are exchanged with other tinc daemons. These include
  86 authentication, key exchange and connection list updates.
  87 .TP
  88 \fB\-dddd\fR
  89 This will log a copy of everything received on the meta socket.
  90 .TP
  91 \fB\-ddddd\fR
  92 This will log all network traffic over the virtual private network.
  93 .PP
  94 .SH "FILES"
  95 .TP
  96 \fI/etc/tinc/\fBnetname\fI/tinc.conf\fR
  97 The configuration file for tincd.
  98 .TP
  99 \fI/etc/tinc/\fBnetname\fI/tinc-up\fR
 100 Script which is executed as soon as a tap device has been allocated.
 101 Purpose is to further configure that device.
 102 .TP
 103 \fI/etc/tinc/\fBnetname\fI/tinc-down\fR
 104 Script which is executed when tinc quits.
 105 Purpose is to shut down the tap device.
 106 .TP
 107 \fI/etc/tinc/\fBnetname\fI/hosts/*\fR
 108 The directory containing the host configuration files
 109 used to authenticate other tinc daemons.
 110 .TP
 111 \fI/var/run/tinc.\fBnetname\fI.pid\fR
 112 The PID of the currently running tincd is stored in this file.
 113 .PP
 114 .SH "BUGS"
 115 The TCPonly and IndirectData options may not work correctly.
 116 .PP
 117 \fBThe cryptography in tinc is not well tested yet. Use it at your own risk!\fR
 118 .PP
 119 If you find any bugs, report them to tinc@nl.linux.org.
 120 .PP
 121 .SH "TODO"
 122 A lot, especially security auditting.
 123 .PP
 124 .SH "SEE ALSO"
 125 \fBtinc.conf\fR(5)
 126 .TP
 127 \fBhttp://tinc.nl.linux.org/\fR
 128 .TP
 129 \fBhttp://www.cabal.org/\fR
 130 .PP
 131 The full documentation for
 132 .B tinc
 133 is maintained as a Texinfo manual.  If the
 134 .B info
 135 and
 136 .B tinc
 137 programs are properly installed at your site, the command
 138 .IP
 139 .B info tinc
 140 .PP
 141 should give you access to the complete manual.
 142 .PP
 143 tinc comes with ABSOLUTELY NO WARRANTY.  This is free software,
 144 and you are welcome to redistribute it under certain conditions;
 145 see the file COPYING for details.
 146 .SH "AUTHORS"
 147 .na
 148 .nf
 149 Ivo Timmermans <itimmermans@bigfoot.com>
 150 Guus Sliepen <guus@sliepen.warande.net>
 151
 152 And thanks to many others for their contributions to tinc!
 153 .PP