doc/client.texi

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