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 @ref{Identity} (hexadecimal string).
  17
  18 @item -key
  19 Path to the file with the passphrase. See @ref{Verifier} for
  20 how to enter passphrase from stdin silently and store it in the file.
  21
  22 @item -timeout
  23 @ref{Timeout} setting in seconds.
  24
  25 @item -noncediff
  26 Allowable @ref{Nonce difference}.
  27
  28 @item -noise
  29 Enable @ref{Noise}.
  30
  31 @item -cpr
  32 Enable @ref{CPR} in KiB/sec.
  33
  34 @item -up
  35 Optional path to script that will be executed after connection is
  36 established. Interface name will be given to it as a first argument.
  37
  38 @item -down
  39 Same as @code{-up} above, but it is executed when connection is lost,
  40 when we exit.
  41
  42 @end table
  43
  44 Example up-script that calls DHCP client and IPv6 advertisement
  45 solicitation:
  46
  47 @example
  48 client% cat > up.sh <<EOF
  49 #!/bin/sh
  50 dhclient $1
  51 rtsol $1
  52 EOF
  53 client% chmod +x up.sh
  54 @end example