Ability to use TUN-interfaces under GNU/Linux

[govpn.git] / doc / client.texi

diff --git a/doc/client.texi b/doc/client.texi
index 1ed749e746dfb3be08195bb822807ae49990c739..42b8a65910f2a1e18ecef5f0d86f33d797c7a454 100644 (file)
--- a/doc/client.texi
+++ b/doc/client.texi
@@ -1,13 +1,17 @@
 @node Client
 @section Client part
 
-Except for common @code{-mtu}, @code{-stats}, @code{-egd}
+Except for common @ref{Stats, -stats}, @ref{EGD, -egd}, @ref{Syslog, -syslog}
 options client has the following ones:
 
-@table @code
+@table @option
+
+@item -mtu
+Expected TUN/TAP interface @ref{MTU}.
 
 @item -proto
-@ref{Network, network protocol} to use. Can be either @emph{udp} or @emph{tcp}.
+@ref{Network, Network protocol} to use. Can be either @emph{udp}
+(default) or @emph{tcp}.
 
 @item -proxy
 Use specified @emph{host:port} @ref{Proxy} server for accessing remote
@@ -21,30 +25,41 @@ server.
 Address (@code{host:port} format) of remote server we need to connect to.
 
 @item -iface
-TAP interface name.
+TUN/TAP interface name.
 
-@item -id
-Our client's @ref{Identity} (hexadecimal string).
+@item -verifier
+Our client's @ref{Verifier}.
 
 @item -key
-Path to the file with the passphrase. See @ref{Verifier} for
-how to enter passphrase from stdin silently and store it in the file.
+Path to the file with the passphrase. If omitted, then you will be asked
+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.
+
 @item -noise
 Enable @ref{Noise}.
 
 @item -cpr
-Enable @ref{CPR} in KiB/sec.
+Set @ref{CPR} in KiB/sec.
+
+@item -encless
+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 @code{-up} above, but it is executed when connection is lost,
+Same as @option{-up} above, but it is executed when connection is lost,
 when we exit.
 
 @end table
@@ -52,11 +67,11 @@ when we exit.
 Example up-script that calls DHCP client and IPv6 advertisement
 solicitation:
 
-@example
+@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 example
+@end verbatim