doc/client.texi

   1 @node Client part
   2 @section Client part
   3
   4 Except for common @code{-mtu}, @code{-stats}, @code{-egd} options client
   5 has the 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 -noise
  26 Enable @ref{Noise}.
  27
  28 @item -cpr
  29 Enable @ref{CPR} in KiB/sec.
  30
  31 @item -up
  32 Optional path to script that will be executed after connection is
  33 established. Interface name will be given to it as a first argument.
  34
  35 @item -down
  36 Same as @code{-up} above, but it is executed when connection is lost,
  37 when we exit.
  38
  39 @end table
  40
  41 Example up-script that calls DHCP client and IPv6 advertisement
  42 solicitation:
  43
  44 @example
  45 client% cat > up.sh <<EOF
  46 #!/bin/sh
  47 dhclient $1
  48 rtsol $1
  49 EOF
  50 client% chmod +x up.sh
  51 @end example