doc/client.texi

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