doc/client.texi

   1 @node Client
   2 @section Client part
   3
   4 Except for common @code{-stats}, @code{-egd} options client has the
   5 following ones:
   6
   7 @table @code
   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. See @ref{Verifier} for
  35 how to enter passphrase from stdin silently and store it in the file.
  36
  37 @item -timeout
  38 @ref{Timeout} setting in seconds.
  39
  40 @item -noise
  41 Enable @ref{Noise}.
  42
  43 @item -cpr
  44 Set @ref{CPR} in KiB/sec.
  45
  46 @item -encless
  47 Enable @ref{Encless, encryptionless mode}.
  48
  49 @item -up
  50 Optional path to script that will be executed after connection is
  51 established. Interface name will be given to it as a first argument.
  52
  53 @item -down
  54 Same as @code{-up} above, but it is executed when connection is lost,
  55 when we exit.
  56
  57 @end table
  58
  59 Example up-script that calls DHCP client and IPv6 advertisement
  60 solicitation:
  61
  62 @example
  63 client% cat > up.sh <<EOF
  64 #!/bin/sh
  65 dhclient $1
  66 rtsol $1
  67 EOF
  68 client% chmod +x up.sh
  69 @end example