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

   1 .Dd 2011-01-02
   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 -controlsocket Ns = Ns Ar FILENAME
  74 Open control socket at
  75 .Ar FILENAME .
  76 If
  77 .Ar FILE
  78 is omitted, the default is
  79 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .control.
  80 .It Fl -bypass-security
  81 Disables encryption and authentication of the meta protocol.
  82 Only useful for debugging.
  83 .It Fl R, -chroot
  84 With this option tinc chroots into the directory where network
  85 config is located (@sysconfdir@/tinc/NETNAME if -n option is used,
  86 or to the directory specified with -c option) after initialization.
  87 .It Fl U, -user Ns = Ns Ar USER
  88 setuid to the specified
  89 .Ar USER
  90 after initialization.
  91 .It Fl -help
  92 Display short list of options.
  93 .It Fl -version
  94 Output version information and exit.
  95 .El
  96 .Sh SIGNALS
  97 .Bl -tag -width indent
  98 .It HUP
  99 Partially rereads configuration files.
 100 Connections to hosts whose host config file are removed are closed.
 101 New outgoing connections specified in
 102 .Pa tinc.conf
 103 will be made.
 104 .El
 105 .Sh DEBUG LEVELS
 106 The tinc daemon can send a lot of messages to the syslog.
 107 The higher the debug level,
 108 the more messages it will log.
 109 Each level inherits all messages of the previous level:
 110 .Bl -tag -width indent
 111 .It 0
 112 This will log a message indicating
 113 .Nm
 114 has started along with a version number.
 115 It will also log any serious error.
 116 .It 1
 117 This will log all connections that are made with other tinc daemons.
 118 .It 2
 119 This will log status and error messages from scripts and other tinc daemons.
 120 .It 3
 121 This will log all requests that are exchanged with other tinc daemons. These include
 122 authentication, key exchange and connection list updates.
 123 .It 4
 124 This will log a copy of everything received on the meta socket.
 125 .It 5
 126 This will log all network traffic over the virtual private network.
 127 .El
 128 .Sh FILES
 129 .Bl -tag -width indent
 130 .It Pa @sysconfdir@/tinc/
 131 Directory containing the configuration files tinc uses.
 132 For more information, see
 133 .Xr tinc.conf 5 .
 134 .It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid
 135 The PID of the currently running
 136 .Nm
 137 is stored in this file.
 138 .El
 139 .Sh BUGS
 140 The
 141 .Va BindToInterface
 142 option may not work correctly.
 143 .Pp
 144 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
 145 .Pp
 146 If you find any bugs, report them to tinc@tinc-vpn.org.
 147 .Sh TODO
 148 A lot, especially security auditing.
 149 .Sh SEE ALSO
 150 .Xr tincctl 8 ,
 151 .Xr tinc.conf 5 ,
 152 .Pa http://www.tinc-vpn.org/ ,
 153 .Pa http://www.cabal.org/ .
 154 .Pp
 155 The full documentation for tinc is maintained as a Texinfo manual.
 156 If the info and tinc programs are properly installed at your site,
 157 the command
 158 .Ic info tinc
 159 should give you access to the complete manual.
 160 .Pp
 161 tinc comes with ABSOLUTELY NO WARRANTY.
 162 This is free software, and you are welcome to redistribute it under certain conditions;
 163 see the file COPYING for details.
 164 .Sh AUTHORS
 165 .An "Ivo Timmermans"
 166 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 167 .Pp
 168 And thanks to many others for their contributions to tinc!