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