X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fclient.texi;h=42b8a65910f2a1e18ecef5f0d86f33d797c7a454;hb=a11b0bda178937e6891770f40f800d69b5640313;hp=52f6429888f5071121a0b17a298fab72fb4ee22e;hpb=75a14e6594c7acfc9ac68d9ecf96ed0b0974bbb8;p=govpn.git diff --git a/doc/client.texi b/doc/client.texi index 52f6429..42b8a65 100644 --- a/doc/client.texi +++ b/doc/client.texi @@ -1,34 +1,77 @@ -@node Client part +@node Client @section Client part -Except for common @code{-mtu}, @code{-noncediff}, @code{-timeout}, -@code{-stats}, @code{-noise} options client has the following ones: +Except for common @ref{Stats, -stats}, @ref{EGD, -egd}, @ref{Syslog, -syslog} +options client has the following ones: + +@table @option + +@item -mtu +Expected TUN/TAP interface @ref{MTU}. + +@item -proto +@ref{Network, Network protocol} to use. Can be either @emph{udp} +(default) or @emph{tcp}. + +@item -proxy +Use specified @emph{host:port} @ref{Proxy} server for accessing remote +server. + +@item -proxy-auth +Optional @emph{user:password} for HTTP Basic authorization on proxy +server. -@table @code @item -remote Address (@code{host:port} format) of remote server we need to connect to. + @item -iface -TAP interface name. -@item -id -Our client's identification (hexadecimal string). +TUN/TAP interface name. + +@item -verifier +Our client's @ref{Verifier}. + @item -key -Path to the file with the PSK key. +Path to the file with the passphrase. If omitted, then you will be asked +to enter it in the terminal. + +@item -timeout +@ref{Timeout} setting in seconds. + +@item -noreconnect +Disable reconnection after timeout. + +@item -timesync +Optional @ref{Timesync, time synchronization} requirement. If set to +zero, then no synchronization required. + +@item -noise +Enable @ref{Noise}. + +@item -cpr +Set @ref{CPR} in KiB/sec. + +@item -encless +Enable @ref{Encless, encryptionless mode}. + @item -up -Optional path to script that will be executed after connection is -established. Interface name will be given to it as a first argument. +Optional path to @ref{Scripts, script} that will be executed after +connection is established. Interface name will be given to it as a first +argument. + @item -down -Same as @code{-up} above, but it is executed when connection is lost, +Same as @option{-up} above, but it is executed when connection is lost, when we exit. + @end table Example up-script that calls DHCP client and IPv6 advertisement solicitation: -@example +@verbatim client% cat > up.sh <