X-Git-Url: https://tinc-vpn.org/git/browse?a=blobdiff_plain;f=doc%2Ftinc.texi;h=4a5270bc8864b475293e55d60d596ff62d0d5b9c;hb=5b88f5ba74fa9aa2cad82576308847e08cea88b1;hp=6337b3c7278bb07c3ddfc6d605aaafe49046c38e;hpb=5766518589a5e6cc43ba77a4049059ead05fb300;p=tinc diff --git a/doc/tinc.texi b/doc/tinc.texi index 6337b3c7..4a5270bc 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -339,7 +339,6 @@ having them installed, configure will give you an error message, and stop. * OpenSSL:: * zlib:: * lzo:: -* libevent:: * libcurses:: * libreadline:: @end menu @@ -458,27 +457,6 @@ make sure you build development and runtime libraries (which is the default). -@c ================================================================== -@node libevent -@subsection libevent - -@cindex libevent -For the main event loop, tinc uses the libevent library. - -If this library is not installed, you wil get an error when configuring -tinc for build. - -You can use your operating system's package manager to install this if -available. Make sure you install the development AND runtime versions -of this package. - -If you have to install libevent manually, you can get the source code -from @url{http://libevent.org/}. Instructions on how to configure, -build and install this package are included within the package. Please -make sure you build development and runtime libraries (which is the -default). - - @c ================================================================== @node libcurses @subsection libcurses @@ -506,7 +484,7 @@ of this package. @node libreadline @subsection libreadline -@cindex libevent +@cindex libreadline For the "tincctl" command's shell functionality, tinc uses the readline library. If this library is not installed, you wil get an error when running the @@ -1049,16 +1027,6 @@ This is less efficient, but allows the kernel to apply its routing and firewall and can also help debugging. @end table -@cindex GraphDumpFile -@item GraphDumpFile = <@var{filename}> -If this option is present, -tinc will dump the current network graph to the file @var{filename} -every minute, unless there were no changes to the graph. -The file is in a format that can be read by graphviz tools. -If @var{filename} starts with a pipe symbol |, -then the rest of the filename is interpreted as a shell command -that is executed, the graph is then sent to stdin. - @cindex Hostnames @item Hostnames = (no) This option selects whether IP addresses (both real and on the VPN) @@ -1095,7 +1063,7 @@ This option selects the way packets are routed to other daemons. @item router In this mode Subnet variables in the host configuration files will be used to form a routing table. -Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode. +Only packets of routable protocols (IPv4 and IPv6) are supported in this mode. This is the default mode, and unless you really know you need another mode, don't change it. @@ -1130,12 +1098,12 @@ This only has effect when Mode is set to "switch". @cindex Name @item Name = <@var{name}> [required] This is a symbolic name for this connection. -The name should consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _). +The name should consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _), and is case sensitive. If Name starts with a $, then the contents of the environment variable that follows will be used. In that case, invalid characters will be converted to underscores. If Name is $HOST, but no such environment variable exist, -the hostname will be read using the gethostnname() system call. +the hostname will be read using the gethostname() system call. @cindex PingInterval @item PingInterval = <@var{seconds}> (60) @@ -1165,10 +1133,6 @@ This is the full path name of the RSA private key file that was generated by @samp{tincctl generate-keys}. It must be a full path, not a relative directory. -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. @@ -1278,11 +1242,9 @@ Furthermore, specifying "none" will turn off packet authentication. @cindex IndirectData @item IndirectData = (no) -This option specifies whether other tinc daemons besides the one you -specified with ConnectTo can make a direct connection to you. This is -especially useful if you are behind a firewall and it is impossible to -make a connection from the outside to your tinc daemon. Otherwise, it -is best to leave this option out or set it to no. +When set to yes, other nodes which do not already have a meta connection to you +will not try to establish direct communication with you. +It is best to leave this option out or set it to no. @cindex MACLength @item MACLength = <@var{bytes}> (4) @@ -2232,7 +2194,7 @@ Export the host configuration file of the local node to standard output. Export all host configuration files to standard output. @item import [--force] -Import host configuration file(s) from standard input. +Import host configuration file(s) generated by the tincctl export command from standard input. Already existing host configuration files are not overwritten unless the option --force is used. @item start [tincd options] @@ -2258,8 +2220,9 @@ Generate public/private keypair of @var{bits} length. If @var{bits} is not speci but will default to the configuration directory (you can use the -c or -n option). -@item dump nodes +@item dump [reachable] nodes Dump a list of all known nodes in the VPN. +If the reachable keyword is used, only lists reachable nodes. @item dump edges Dump a list of all known connections in the VPN.