git.meshlink.io Git - meshlink/blob - doc/tincd.8.in

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