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