doc/client.texi

   1 @node Client part
   2 @section Client part
   3
   4 Except for common @code{-mtu}, @code{-stats}, options client has the
   5 following ones:
   6
   7 @table @code
   8
   9 @item -remote
  10 Address (@code{host:port} format) of remote server we need to connect to.
  11
  12 @item -iface
  13 TAP interface name.
  14
  15 @item -id
  16 Our client's identification (hexadecimal string).
  17
  18 @item -key
  19 Path to the file with the PSK key.
  20
  21 @item -timeout
  22 @ref{Timeout} setting in seconds.
  23
  24 @item -noncediff
  25 Allowable @ref{Nonce difference}.
  26
  27 @item -noise
  28 Enable @ref{Noise}.
  29
  30 @item -cpr
  31 Enable @ref{CPR} in KiB/sec.
  32
  33 @item -up
  34 Optional path to script that will be executed after connection is
  35 established. Interface name will be given to it as a first argument.
  36
  37 @item -down
  38 Same as @code{-up} above, but it is executed when connection is lost,
  39 when we exit.
  40
  41 @end table
  42
  43 Example up-script that calls DHCP client and IPv6 advertisement
  44 solicitation:
  45
  46 @example
  47 client% cat > up.sh <<EOF
  48 #!/bin/sh
  49 dhclient $1
  50 rtsol $1
  51 EOF
  52 client% chmod +x up.sh
  53 @end example