Ability to use TUN-interfaces under GNU/Linux

[govpn.git] / doc / client.texi

diff --git a/doc/client.texi b/doc/client.texi
index 5b0ae2b7fda2723894f76a765641ae736c656f95..42b8a65910f2a1e18ecef5f0d86f33d797c7a454 100644 (file)
--- a/doc/client.texi
+++ b/doc/client.texi
@@ -1,13 +1,13 @@
 @node Client
 @section Client part
 
-Except for common @ref{Stats, -stats}, @ref{EGD, -egd} options client
-has the following ones:
+Except for common @ref{Stats, -stats}, @ref{EGD, -egd}, @ref{Syslog, -syslog}
+options client has the following ones:
 
 @table @option
 
 @item -mtu
-Expected TAP interface @ref{MTU}.
+Expected TUN/TAP interface @ref{MTU}.
 
 @item -proto
 @ref{Network, Network protocol} to use. Can be either @emph{udp}
@@ -25,7 +25,7 @@ server.
 Address (@code{host:port} format) of remote server we need to connect to.
 
 @item -iface
-TAP interface name.
+TUN/TAP interface name.
 
 @item -verifier
 Our client's @ref{Verifier}.
@@ -37,6 +37,9 @@ to enter it in the terminal.
 @item -timeout
 @ref{Timeout} setting in seconds.
 
+@item -noreconnect
+Disable reconnection after timeout.
+
 @item -timesync
 Optional @ref{Timesync, time synchronization} requirement. If set to
 zero, then no synchronization required.
@@ -51,8 +54,9 @@ Set @ref{CPR} in KiB/sec.
 Enable @ref{Encless, encryptionless mode}.
 
 @item -up
-Optional path to script that will be executed after connection is
-established. Interface name will be given to it as a first argument.
+Optional path to @ref{Scripts, script} that will be executed after
+connection is established. Interface name will be given to it as a first
+argument.
 
 @item -down
 Same as @option{-up} above, but it is executed when connection is lost,
@@ -66,8 +70,8 @@ solicitation:
 @verbatim
 client% cat > up.sh <<EOF
 #!/bin/sh
-dhclient $1
-rtsol $1
+dhclient $GOVPN_IFACE
+rtsol $GOVPN_IFACE
 EOF
 client% chmod +x up.sh
 @end verbatim