doc/client.texi

   1 @node Client
   2 @section Client part
   3
   4 Except for common @ref{Stats, -stats}, @ref{EGD, -egd}, @ref{Syslog, -syslog}
   5 options client has the following ones:
   6
   7 @table @option
   8
   9 @item -mtu
  10 Expected TUN/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 TUN/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 -noreconnect
  41 Disable reconnection after timeout.
  42
  43 @item -timesync
  44 Optional @ref{Timesync, time synchronization} requirement. If set to
  45 zero, then no synchronization required.
  46
  47 @item -noise
  48 Enable @ref{Noise}.
  49
  50 @item -cpr
  51 Set @ref{CPR} in KiB/sec.
  52
  53 @item -encless
  54 Enable @ref{Encless, encryptionless mode}.
  55
  56 @item -up
  57 Optional path to @ref{Scripts, script} that will be executed after
  58 connection is established. Interface name will be given to it as a first
  59 argument.
  60
  61 @item -down
  62 Same as @option{-up} above, but it is executed when connection is lost,
  63 when we exit.
  64
  65 @end table
  66
  67 Example up-script that calls DHCP client and IPv6 advertisement
  68 solicitation:
  69
  70 @verbatim
  71 client% cat > up.sh <<EOF
  72 #!/bin/sh
  73 dhclient $GOVPN_IFACE
  74 rtsol $GOVPN_IFACE
  75 EOF
  76 client% chmod +x up.sh
  77 @end verbatim