X-Git-Url: http://tinc-vpn.org/git/browse?a=blobdiff_plain;ds=sidebyside;f=doc%2Ftinc.texi;h=55560f4ad007abb139efb71bf25ead080ee8c914;hb=7027bba541eca3e34f689bebd6f6e408ba4e7710;hp=427fbeaa0b651243e326b628e48583f99652ba5b;hpb=07108117ceddaff0654f9def703e717c002f3e2d;p=tinc diff --git a/doc/tinc.texi b/doc/tinc.texi index 427fbeaa..55560f4a 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -1207,10 +1207,10 @@ The environment variables @env{NAME}, @env{NODE}, @env{REMOTEADDRES} and @env{RE @end table @cindex ReplayWindow -@item ReplayWindow = (16) +@item ReplayWindow = (32) This is the size of the replay tracking window for each remote node, in bytes. The window is a bitfield which tracks 1 packet per bit, so for example -the default setting of 16 will track up to 128 packets in the window. In high +the default setting of 32 will track up to 256 packets in the window. In high bandwidth scenarios, setting this to a higher value can reduce packet loss from the interaction of replay tracking with underlying real packet loss and/or reordering. Setting this to zero will disable replay tracking completely and @@ -1254,14 +1254,16 @@ If tinc doesn't receive any UDP ping replies over the specified interval, it will assume UDP communication is broken and will fall back to TCP. @cindex UDPRcvBuf -@item UDPRcvBuf = (OS default) +@item UDPRcvBuf = (1048576) Sets the socket receive buffer size for the UDP socket, in bytes. -If unset, the default buffer size will be used by the operating system. +If set to zero, the default buffer size will be used by the operating system. +Note: this setting can have a significant impact on performance, especially raw throughput. @cindex UDPSndBuf -@item UDPSndBuf = Pq OS default +@item UDPSndBuf = (1048576) Sets the socket send buffer size for the UDP socket, in bytes. -If unset, the default buffer size will be used by the operating system. +If set to zero, the default buffer size will be used by the operating system. +Note: this setting can have a significant impact on performance, especially raw throughput. @end table @@ -2247,6 +2249,9 @@ Use the cookie from @var{filename} to authenticate with a running tinc daemon. If unspecified, the default is @file{@value{localstatedir}/run/tinc.@var{netname}.pid}. +@item --force +Force some commands to work despite warnings. + @item --help Display a short reminder of runtime options and commands, then terminate. @@ -2293,6 +2298,7 @@ To set a variable for a specific host, use the notation @var{host}.@var{variable @cindex add @item add @var{variable} @var{value} As above, but without removing any previously existing configuration variables. +If the variable already exists with the given value, nothing happens. @cindex del @item del @var{variable} [@var{value}] @@ -2313,16 +2319,16 @@ Export the host configuration file of the local node to standard output. Export all host configuration files to standard output. @cindex import -@item import [--force] +@item import Import host configuration file(s) generated by the tinc export command from standard input. Already existing host configuration files are not overwritten unless the option --force is used. @cindex exchange -@item exchange [--force] +@item exchange The same as export followed by import. @cindex exchange-all -@item exchange-all [--force] +@item exchange-all The same as export-all followed by import. @cindex invite @@ -2436,11 +2442,21 @@ Dump VPN traffic going through the local tinc node in pcap-savefile format to st from where it can be redirected to a file or piped through a program that can parse it directly, such as tcpdump. -@cindex network [@var{netname}] -@item network +@cindex network +@item network [@var{netname}] If @var{netname} is given, switch to that network. Otherwise, display a list of all networks for which configuration files exist. +@cindex fsck +@item fsck +This will check the configuration files for possible problems, +such as unsafe file permissions, missing executable bit on script, +unknown and obsolete configuration variables, wrong public and/or private keys, and so on. + +When problems are found, this will be printed on a line with WARNING or ERROR in front of it. +Most problems must be corrected by the user itself, however in some cases (like file permissions and missing public keys), +tinc will ask if it should fix the problem. + @end table @c ==================================================================