Releasing 1.1pre5.

[tinc] / doc / tinc.texi

diff --git a/doc/tinc.texi b/doc/tinc.texi
index 0e2b1eb..8910115 100644 (file)
--- a/doc/tinc.texi
+++ b/doc/tinc.texi
@@ -15,7 +15,7 @@
 
 This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
 
-Copyright @copyright{} 1998-2012 Ivo Timmermans,
+Copyright @copyright{} 1998-2013 Ivo Timmermans,
 Guus Sliepen <guus@@tinc-vpn.org> and
 Wessel Dankers <wsl@@tinc-vpn.org>.
 
@@ -39,7 +39,7 @@ permission notice identical to this one.
 @vskip 0pt plus 1filll
 This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
 
-Copyright @copyright{} 1998-2012 Ivo Timmermans,
+Copyright @copyright{} 1998-2013 Ivo Timmermans,
 Guus Sliepen <guus@@tinc-vpn.org> and
 Wessel Dankers <wsl@@tinc-vpn.org>.
 
@@ -1063,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.
 
@@ -1098,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)
@@ -1242,11 +1242,9 @@ Furthermore, specifying "none" will turn off packet authentication.
 
 @cindex IndirectData
 @item IndirectData = <yes|no> (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)
@@ -1515,11 +1513,12 @@ tincctl -n @var{netname} import
 @end example
 
 If you are the owner of bar yourself, and you have SSH access to that computer,
-you can also swap the host configuration files using the following commands:
+you can also swap the host configuration files using the following command:
 
 @example
-tincctl -n @var{netname} export | ssh bar.example.org tincctl -n @var{netname} import
-ssh bar.example.org tincctl -n @var{netname} export | tincctl -n @var{netname} import
+tincctl -n @var{netname} export \
+    | ssh bar.example.org tincctl -n @var{netname} exchange \
+    | tincctl -n @var{netname} import
 @end example
 
 You should repeat this for all nodes you ConnectTo, or which ConnectTo you.
@@ -1849,6 +1848,8 @@ This option can be used more than once to specify multiple configuration variabl
 Lock tinc into main memory.
 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
 
+This option is not supported on all platforms.
+
 @item --logfile[=@var{file}]
 Write log entries to a file instead of to the system logging facility.
 If @var{file} is omitted, the default is @file{@value{localstatedir}/log/tinc.@var{netname}.log}.
@@ -1869,11 +1870,14 @@ 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.
 
+This option is not supported on all platforms.
 @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.
 
+This option is not supported on all platforms.
+
 @item --help
 Display a short reminder of these runtime options and terminate.
 
@@ -2196,9 +2200,15 @@ 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 exchange [--force]
+The same as export followed by import.
+
+@item exchange-all [--force]
+The same as export-all followed by import.
+
 @item start [tincd options]
 Start @samp{tincd}, optionally with the given extra options.