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

   1 .Dd 2002-03-25
   2 .Dt TINCD 8
   3 .\" Manual page created by:
   4 .\" Ivo Timmermans <ivo@o2w.nl>
   5 .\" Guus Sliepen <guus@sliepen.eu.org>
   6 .Sh NAME
   7 .Nm tincd
   8 .Nd tinc VPN daemon
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Op Fl cdDkKnL
  12 .Op Fl -config Ns = Ns Ar DIR
  13 .Op Fl -no-detach
  14 .Op Fl -debug Ns Op = Ns Ar LEVEL
  15 .Op Fl -kill Ns Op = Ns Ar SIGNAL
  16 .Op Fl -net Ns = Ns Ar NETNAME
  17 .Op Fl -generate-keys Ns Op = Ns Ar BITS
  18 .Op Fl -mlock
  19 .Op Fl -logfile Ns Op = Ns Ar FILE
  20 .Op Fl -pidfile Ns = Ns Ar FILE
  21 .Op Fl -bypass-security
  22 .Op Fl -help
  23 .Op Fl -version
  24 .Sh DESCRIPTION
  25 This is the daemon of tinc, a secure virtual private network (VPN) project.
  26 When started,
  27 .Nm
  28 will read it's configuration file to determine what virtual subnets it has to serve
  29 and to what other tinc daemons it should connect.
  30 It will connect to the ethertap or tun/tap device
  31 and set up a socket for incoming connections.
  32 Optionally a script will be executed to further configure the virtual device.
  33 If that succeeds,
  34 it will detach from the controlling terminal and continue in the background,
  35 accepting and setting up connections to other tinc daemons
  36 that are part of the virtual private network.
  37 Under Windows (not Cygwin) tinc will install itself as a service,
  38 which will be restarted automatically after reboots.
  39 .Sh OPTIONS
  40 .Bl -tag -width indent
  41 .It Fl c, -config Ns = Ns Ar DIR
  42 Read configuration files from
  43 .Ar DIR
  44 instead of
  45 .Pa @sysconfdir@/tinc/ .
  46 .It Fl D, -no-detach
  47 Don't fork and detach.
  48 This will also disable the automatic restart mechanism for fatal errors.
  49 If not mentioned otherwise, this will show log messages on the standard error output.
  50 .It Fl d, -debug Ns Op = Ns Ar LEVEL
  51 Increase debug level or set it to
  52 .Ar LEVEL
  53 (see below).
  54 .It Fl k, -kill Ns Op = Ns Ar SIGNAL
  55 Attempt to kill a running
  56 .Nm
  57 (optionally with the specified
  58 .Ar SIGNAL
  59 instead of SIGTERM) and exit.
  60 Under Windows (not Cygwin) the optional argument is ignored,
  61 the service will always be stopped and removed.
  62 .It Fl n, -net Ns = Ns Ar NETNAME
  63 Connect to net
  64 .Ar NETNAME .
  65 .It Fl K, -generate-keys Ns Op = Ns Ar BITS
  66 Generate public/private RSA keypair and exit.
  67 If
  68 .Ar BITS
  69 is omitted, the default length will be 1024 bits.
  70 .It Fl L, -mlock
  71 Lock tinc into main memory.
  72 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
  73 .It Fl -logfile Ns Op = Ns Ar FILE
  74 Write log entries to a file instead of to the system logging facility.
  75 If
  76 .Ar FILE
  77 is omitted, the default is
  78 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
  79 .It Fl -pidfile Ns = Ns Ar FILE
  80 Write PID to
  81 .Ar FILE
  82 instead of
  83 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
  84 Under Windows this option will be ignored.
  85 .It Fl -bypass-security
  86 Disables encryption and authentication of the meta protocol.
  87 Only useful for debugging.
  88 .It Fl -help
  89 Display short list of options.
  90 .It Fl -version
  91 Output version information and exit.
  92 .El
  93 .Sh SIGNALS
  94 .Bl -tag -width indent
  95 .It ALRM
  96 Forces
  97 .Nm
  98 to try to connect to all uplinks immediately.
  99 Usually
 100 .Nm
 101 attempts to do this itself,
 102 but increases the time it waits between the attempts each time it failed,
 103 and if
 104 .Nm
 105 didn't succeed to connect to an uplink the first time after it started,
 106 it defaults to the maximum time of 15 minutes.
 107 .It HUP
 108 Partially rereads configuration files.
 109 Connections to hosts whose host config file are removed are closed.
 110 New outgoing connections specified in
 111 .Pa tinc.conf
 112 will be made.
 113 .It INT
 114 Temporarily increases debug level to 5.
 115 Send this signal again to revert to the original level.
 116 .It USR1
 117 Dumps the connection list to syslog.
 118 .It USR2
 119 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
 120 .It WINCH
 121 Purges all information remembered about unreachable nodes.
 122 .El
 123 .Sh DEBUG LEVELS
 124 The tinc daemon can send a lot of messages to the syslog.
 125 The higher the debug level,
 126 the more messages it will log.
 127 Each level inherits all messages of the previous level:
 128 .Bl -tag -width indent
 129 .It 0
 130 This will log a message indicating
 131 .Nm
 132 has started along with a version number.
 133 It will also any serious error.
 134 .It 1
 135 This will log all connections that are made with other tinc daemons.
 136 .It 2
 137 This will log status and error messages from scripts and other tinc daemons.
 138 .It 3
 139 This will log all requests that are exchanged with other tinc daemons. These include
 140 authentication, key exchange and connection list updates.
 141 .It 4
 142 This will log a copy of everything received on the meta socket.
 143 .It 5
 144 This will log all network traffic over the virtual private network.
 145 .El
 146 .Sh FILES
 147 .Bl -tag -width indent
 148 .It Pa @sysconfdir@/tinc/
 149 Directory containing the configuration files tinc uses.
 150 For more information, see
 151 .Xr tinc.conf 5 .
 152 .It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid
 153 The PID of the currently running
 154 .Nm
 155 is stored in this file.
 156 .El
 157 .Sh BUGS
 158 The
 159 .Va BindToInterface
 160 option may not work correctly.
 161 .Pp
 162 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
 163 .Pp
 164 If you find any bugs, report them to tinc@nl.linux.org.
 165 .Sh TODO
 166 A lot, especially security auditing.
 167 .Sh SEE ALSO
 168 .Xr tinc.conf 5 ,
 169 .Pa http://tinc.nl.linux.org/ ,
 170 .Pa http://www.cabal.org/ .
 171 .Pp
 172 The full documentation for tinc is maintained as a Texinfo manual.
 173 If the info and tinc programs are properly installed at your site,
 174 the command
 175 .Ic info tinc
 176 should give you access to the complete manual.
 177 .Pp
 178 tinc comes with ABSOLUTELY NO WARRANTY.
 179 This is free software, and you are welcome to redistribute it under certain conditions;
 180 see the file COPYING for details.
 181 .Sh AUTHORS
 182 .An "Ivo Timmermans" Aq ivo@o2w.nl
 183 .An "Guus Sliepen" Aq guus@sliepen.eu.org
 184 .Pp
 185 And thanks to many others for their contributions to tinc!