X-Git-Url: https://tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=doc%2Ftinc.texi;h=d07958c7f5d87ea24f5d8e91fa7955d907f99829;hp=ce5b0b4c3867c8dccfbcb3b3b5889f75e3a8344b;hb=0e6856b1379e278aa5ed116d0911851339a6064c;hpb=e8f08ced76bf1b9a94dd0dc874ad22761ad8900b diff --git a/doc/tinc.texi b/doc/tinc.texi index ce5b0b4c..d07958c7 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -1,5 +1,4 @@ \input texinfo @c -*-texinfo-*- -@c $Id$ @c %**start of header @setfilename tinc.info @settitle tinc Manual @@ -16,12 +15,10 @@ This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon. -Copyright @copyright{} 1998-2008 Ivo Timmermans, +Copyright @copyright{} 1998-2009 Ivo Timmermans, Guus Sliepen and Wessel Dankers . -$Id$ - Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. @@ -43,12 +40,10 @@ permission notice identical to this one. @cindex copyright This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon. -Copyright @copyright{} 1998-2006 Ivo Timmermans, +Copyright @copyright{} 1998-2009 Ivo Timmermans, Guus Sliepen and Wessel Dankers . -$Id$ - Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. @@ -307,7 +302,7 @@ If the @file{net/if_tun.h} header file is missing, install it from the source pa @subsection Configuration of Darwin (MacOS/X) kernels Tinc on Darwin relies on a tunnel driver for its data acquisition from the kernel. -Tinc supports either the driver from @uref{http://www-user.rhrk.uni-kl.de/~nissler/tuntap/}, +Tinc supports either the driver from @uref{http://tuntaposx.sourceforge.net/}, which supports both tun and tap style devices, and also the driver from from @uref{http://chrisp.de/en/projects/tunnel.html}. The former driver is recommended. @@ -929,6 +924,11 @@ Note that there must be exactly one of PrivateKey or PrivateKeyFile specified in the configuration file. +@cindex ProcessPriority +@item ProcessPriority = +When this option is used the priority of the tincd process will be adjusted. +Increasing the priority may help to reduce latency and packet loss on the VPN. + @cindex TunnelServer @item TunnelServer = (no) [experimental] When this option is enabled tinc will no longer forward information between other tinc daemons, @@ -1015,7 +1015,7 @@ in each host configuration file, if you want to be able to establish a connection with that host. @cindex Subnet -@item Subnet = <@var{address}[/@var{prefixlength}]> +@item Subnet = <@var{address}[/@var{prefixlength}[#@var{weight}]]> The subnet which this tinc daemon will serve. Tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet. If the packet matches a subnet, @@ -1039,6 +1039,12 @@ example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes /22. This conforms to standard CIDR notation as described in @uref{ftp://ftp.isi.edu/in-notes/rfc1519.txt, RFC1519} +A Subnet can be given a weight to indicate its priority over identical Subnets +owned by different nodes. The default weight is 10. Lower values indicate +higher priority. Packets will be sent to the node with the highest priority, +unless that node is not reachable, in which case the node with the next highest +priority will be tried, and so on. + @cindex TCPonly @item TCPonly = (no) If this variable is set to yes, then the packets are tunnelled over a @@ -1505,6 +1511,23 @@ Write PID to @var{file} instead of @file{@value{localstatedir}/run/tinc.@var{net Disables encryption and authentication. Only useful for debugging. +@item -R, --chroot +Change process root directory to the directory where the config file is +located (@file{@value{sysconfdir}/tinc/@var{netname}/} as determined by +-n/--net option or as given by -c/--config option), for added security. +The chroot is performed after all the initialization is done, after +writing pid files and opening network sockets. + +Note that this option alone does not do any good without -U/--user, below. + +Note also that tinc can't run scripts anymore (such as tinc-down or host-up), +unless it's setup to be runnable inside chroot environment. + +@item -U, --user=@var{user} +Switch to the given @var{user} after initialization, at the same time as +chroot is performed (see --chroot above). With this option tinc drops +privileges, for added security. + @item --help Display a short reminder of these runtime options and terminate. @@ -2335,7 +2358,7 @@ and join channel #tinc. @section Authors @table @asis -@item Ivo Timmermans (zarq) (@email{ivo@@tinc-vpn.org}) +@item Ivo Timmermans (zarq) @item Guus Sliepen (guus) (@email{guus@@tinc-vpn.org}) @end table