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

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