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 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 When saving keys to existing files, tinc will not delete the old keys,
  71 you have to remove them manually.
  72 .It Fl L, -mlock
  73 Lock tinc into main memory.
  74 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
  75 .It Fl -logfile Ns Op = Ns Ar FILE
  76 Write log entries to a file instead of to the system logging facility.
  77 If
  78 .Ar FILE
  79 is omitted, the default is
  80 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
  81 .It Fl -pidfile Ns = Ns Ar FILE
  82 Write PID to
  83 .Ar FILE
  84 instead of
  85 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
  86 Under Windows this option will be ignored.
  87 .It Fl -bypass-security
  88 Disables encryption and authentication of the meta protocol.
  89 Only useful for debugging.
  90 .It Fl -help
  91 Display short list of options.
  92 .It Fl -version
  93 Output version information and exit.
  94 .El
  95 .Sh SIGNALS
  96 .Bl -tag -width indent
  97 .It ALRM
  98 Forces
  99 .Nm
 100 to try to connect to all uplinks immediately.
 101 Usually
 102 .Nm
 103 attempts to do this itself,
 104 but increases the time it waits between the attempts each time it failed,
 105 and if
 106 .Nm
 107 didn't succeed to connect to an uplink the first time after it started,
 108 it defaults to the maximum time of 15 minutes.
 109 .It HUP
 110 Partially rereads configuration files.
 111 Connections to hosts whose host config file are removed are closed.
 112 New outgoing connections specified in
 113 .Pa tinc.conf
 114 will be made.
 115 .It INT
 116 Temporarily increases debug level to 5.
 117 Send this signal again to revert to the original level.
 118 .It USR1
 119 Dumps the connection list to syslog.
 120 .It USR2
 121 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
 122 .It WINCH
 123 Purges all information remembered about unreachable nodes.
 124 .El
 125 .Sh DEBUG LEVELS
 126 The tinc daemon can send a lot of messages to the syslog.
 127 The higher the debug level,
 128 the more messages it will log.
 129 Each level inherits all messages of the previous level:
 130 .Bl -tag -width indent
 131 .It 0
 132 This will log a message indicating
 133 .Nm
 134 has started along with a version number.
 135 It will also log any serious error.
 136 .It 1
 137 This will log all connections that are made with other tinc daemons.
 138 .It 2
 139 This will log status and error messages from scripts and other tinc daemons.
 140 .It 3
 141 This will log all requests that are exchanged with other tinc daemons. These include
 142 authentication, key exchange and connection list updates.
 143 .It 4
 144 This will log a copy of everything received on the meta socket.
 145 .It 5
 146 This will log all network traffic over the virtual private network.
 147 .El
 148 .Sh FILES
 149 .Bl -tag -width indent
 150 .It Pa @sysconfdir@/tinc/
 151 Directory containing the configuration files tinc uses.
 152 For more information, see
 153 .Xr tinc.conf 5 .
 154 .It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid
 155 The PID of the currently running
 156 .Nm
 157 is stored in this file.
 158 .El
 159 .Sh BUGS
 160 The
 161 .Va BindToInterface
 162 option may not work correctly.
 163 .Pp
 164 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
 165 .Pp
 166 If you find any bugs, report them to tinc@tinc-vpn.org.
 167 .Sh TODO
 168 A lot, especially security auditing.
 169 .Sh SEE ALSO
 170 .Xr tinc.conf 5 ,
 171 .Pa http://www.tinc-vpn.org/ ,
 172 .Pa http://www.cabal.org/ .
 173 .Pp
 174 The full documentation for tinc is maintained as a Texinfo manual.
 175 If the info and tinc programs are properly installed at your site,
 176 the command
 177 .Ic info tinc
 178 should give you access to the complete manual.
 179 .Pp
 180 tinc comes with ABSOLUTELY NO WARRANTY.
 181 This is free software, and you are welcome to redistribute it under certain conditions;
 182 see the file COPYING for details.
 183 .Sh AUTHORS
 184 .An "Ivo Timmermans"
 185 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 186 .Pp
 187 And thanks to many others for their contributions to tinc!