]> Cypherpunks.ru repositories - govpn.git/blobdiff - doc/client.texi
Pass parameters to scripts through environment variables
[govpn.git] / doc / client.texi
index 88e338e3090de2c05cf0c89241e4294712101e21..b6d8aab2a544863e63c7ef6f7cff7af539172b7d 100644 (file)
@@ -1,16 +1,16 @@
 @node Client
 @section Client part
 
-Except for common @code{-stats}, @code{-egd} options client has the
-following ones:
+Except for common @ref{Stats, -stats}, @ref{EGD, -egd} options client
+has the following ones:
 
-@table @code
+@table @option
 
 @item -mtu
 Expected TAP interface @ref{MTU}.
 
 @item -proto
-@ref{Network, network protocol} to use. Can be either @emph{udp}
+@ref{Network, Network protocol} to use. Can be either @emph{udp}
 (default) or @emph{tcp}.
 
 @item -proxy
@@ -31,12 +31,16 @@ TAP interface name.
 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 -timesync
+Optional @ref{Timesync, time synchronization} requirement. If set to
+zero, then no synchronization required.
+
 @item -noise
 Enable @ref{Noise}.
 
@@ -47,11 +51,12 @@ 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 @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
@@ -59,11 +64,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