doc/client.texi

   1 @node Client
   2 @section Client part
   3
   4 Except for common @ref{Stats, -stats}, @ref{EGD, -egd} options client
   5 has the following ones:
   6
   7 @table @option
   8
   9 @item -mtu
  10 Expected TAP interface @ref{MTU}.
  11
  12 @item -proto
  13 @ref{Network, Network protocol} to use. Can be either @emph{udp}
  14 (default) or @emph{tcp}.
  15
  16 @item -proxy
  17 Use specified @emph{host:port} @ref{Proxy} server for accessing remote
  18 server.
  19
  20 @item -proxy-auth
  21 Optional @emph{user:password} for HTTP Basic authorization on proxy
  22 server.
  23
  24 @item -remote
  25 Address (@code{host:port} format) of remote server we need to connect to.
  26
  27 @item -iface
  28 TAP interface name.
  29
  30 @item -verifier
  31 Our client's @ref{Verifier}.
  32
  33 @item -key
  34 Path to the file with the passphrase. If omitted, then you will be asked
  35 to enter it in the terminal.
  36
  37 @item -timeout
  38 @ref{Timeout} setting in seconds.
  39
  40 @item -timesync
  41 Optional @ref{Timesync, time synchronization} requirement. If set to
  42 zero, then no synchronization required.
  43
  44 @item -noise
  45 Enable @ref{Noise}.
  46
  47 @item -cpr
  48 Set @ref{CPR} in KiB/sec.
  49
  50 @item -encless
  51 Enable @ref{Encless, encryptionless mode}.
  52
  53 @item -up
  54 Optional path to @ref{Scripts, script} that will be executed after
  55 connection is established. Interface name will be given to it as a first
  56 argument.
  57
  58 @item -down
  59 Same as @option{-up} above, but it is executed when connection is lost,
  60 when we exit.
  61
  62 @end table
  63
  64 Example up-script that calls DHCP client and IPv6 advertisement
  65 solicitation:
  66
  67 @verbatim
  68 client% cat > up.sh <<EOF
  69 #!/bin/sh
  70 dhclient $GOVPN_IFACE
  71 rtsol $GOVPN_IFACE
  72 EOF
  73 client% chmod +x up.sh
  74 @end verbatim