X-Git-Url: https://www.tinc-vpn.org/git/browse?a=blobdiff_plain;f=doc%2Ftinc.texi;h=81283e4a7cac4d73b420e116cdf91dd7d0240524;hb=refs%2Fheads%2F1.1;hp=9921cda0689d6fd3f95a742b52723806183977ae;hpb=0f18410ebaf1c503e5d0ca9624b24df930561d7d;p=tinc diff --git a/doc/tinc.texi b/doc/tinc.texi index 9921cda0..81283e4a 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -468,13 +468,18 @@ default). @cindex LZ4 Another form of compression is offered using the LZ4 library. -The LZ4 codec is bundled with Tinc and built-in by default as -compression level 12. Tinc can be linked to an external liblz4 -library by using the "--disable-lz4-builtin" configure switch. +Tinc has support for the LZ4 compression algorithm as compression level 12. -If LZ4 support is entirely disabled by passing "--disable-lz4" to the -configure script, then the resulting binary will not work correctly -on VPNs where LZ4 compression is used. +By default, tinc will try to link to an external LZ4 library. If it is not +found on your system or its version is older than r129, then tinc falls back to +the built-in copy of the library. + +You can force the use of the built-in copy by passing `--enable-lz4-builtin`, +or disable it completely with `--disable-lz4-builtin`. + +LZ4 support can be completely disabled with `--disable-lz4`. Note that the +resulting binary will not work correctly on VPNs where LZ4 compression is used +by other peers. @c ================================================================== @@ -544,11 +549,7 @@ for yourself, you can use the source. The source is distributed under the GNU General Public License (GPL). Download the source from the @uref{https://www.tinc-vpn.org/download/, download page}. -Tinc comes in a convenient autoconf/automake package, which you can just -treat the same as any other package. Which is just untar it, type -`./configure' and then `make'. -More detailed instructions are in the file @file{INSTALL}, which is -included in the source distribution. +Please refer to @file{INSTALL.md} for information on how to build tinc from source. @menu * Building and installing tinc:: @@ -570,7 +571,7 @@ The documentation that comes along with your distribution will tell you how to d @menu * Darwin (MacOS/X) build environment:: -* MinGW (Windows) build environment:: +* Windows build environment:: @end menu @@ -585,14 +586,16 @@ You need to download and install LibreSSL (or OpenSSL) and LZO, either directly from their websites (see @ref{Libraries}) or using Fink. @c ================================================================== -@node MinGW (Windows) build environment -@subsection MinGW (Windows) build environment +@node Windows build environment +@subsection Windows build environment + +You will need to install either the native Windows SDK from @uref{https://visualstudio.com}, +or the MinGW environment from @uref{https://msys2.org}. -You will need to install the MinGW environment from @uref{http://www.mingw.org}. You also need to download and install LibreSSL (or OpenSSL) and LZO. -When tinc is compiled using MinGW it runs natively under Windows, -it is not necessary to keep MinGW installed. +Whether tinc is compiled using MinGW or the native SDK, it runs natively under Windows, +so it is not necessary to keep either SDK to run the compiled binaries. When detaching, tinc will install itself as a service, which will be restarted automatically after reboots. @@ -1150,7 +1153,7 @@ This option controls the amount of time MAC addresses are kept before they are r This only has effect when Mode is set to @samp{switch}. @cindex MaxConnectionBurst -@item MaxConnectionBurst = <@var{count}> (100) +@item MaxConnectionBurst = <@var{count}> (10) This option controls how many connections tinc accepts in quick succession. If there are more connections than the given number in a short time interval, tinc will reduce the number of accepted connections to only one per second,