Switch to using RoaringPenguin-based PPPOE plugin

[ppp.git] / pppd / pppd.8

diff --git a/pppd/pppd.8 b/pppd/pppd.8
index d4b3df4bd26cfa67511792bebb99b2bc76e28a93..31c65a1c33696f40269a1847563d2acaf60e0b7f 100644 (file)
--- a/pppd/pppd.8
+++ b/pppd/pppd.8
@@ -1,5 +1,5 @@
-.\" manual page [] for pppd 2.3
-.\" $Id: pppd.8,v 1.52 2000/07/24 14:58:15 paulus Exp $
+.\" manual page [] for pppd 2.4
+.\" $Id: pppd.8,v 1.58 2001/05/23 02:28:42 paulus Exp $

 .\" SH section heading
 .\" SS subsection heading
 .\" LP paragraph
 .\" SH section heading
 .\" SS subsection heading
 .\" LP paragraph


@@ -265,7 +265,7 @@ Request that the peer compress packets that it sends, using the
 Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
 agree to compress packets sent to the peer with a maximum window size
 of \fI2**nt\fR bytes.  If \fInt\fR is not specified, it defaults to
 Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
 agree to compress packets sent to the peer with a maximum window size
 of \fI2**nt\fR bytes.  If \fInt\fR is not specified, it defaults to

-the value given for \fInr\fR.  Values in the range 8 to 15 may be used
+the value given for \fInr\fR.  Values in the range 9 to 15 may be used

 for \fInr\fR and \fInt\fR; larger values give better compression but
 consume more kernel memory for compression dictionaries.
 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
 for \fInr\fR and \fInt\fR; larger values give better compression but
 consume more kernel memory for compression dictionaries.
 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables


@@ -298,6 +298,19 @@ specify \fIdomain Quotron.COM\fR.  Pppd would then use the name
 and as the default name to send to the peer when authenticating itself
 to the peer.  This option is privileged.
 .TP
 and as the default name to send to the peer when authenticating itself
 to the peer.  This option is privileged.
 .TP

+.B dryrun
+With the \fBdryrun\fR option, pppd will print out all the option
+values which have been set and then exit, after parsing the command
+line and options files and checking the option values, but before
+initiating the link.  The option values are logged at level info, and
+also printed to standard output unless the device on standard output
+is the device that pppd would be using to communicate with the peer.
+.TP
+.B dump
+With the \fBdump\fR option, pppd will print out all the option values
+which have been set.  This option is like the \fBdryrun\fR option
+except that pppd proceeds as normal rather than exiting.
+.TP

 .B endpoint \fI<epdisc>
 Sets the endpoint discriminator sent by the local machine to the peer
 during multilink negotiation to \fI<epdisc>\fR.  The default is to use
 .B endpoint \fI<epdisc>
 Sets the endpoint discriminator sent by the local machine to the peer
 during multilink negotiation to \fI<epdisc>\fR.  The default is to use


@@ -444,7 +457,11 @@ default value is 3.
 .TP
 .B kdebug \fIn
 Enable debugging code in the kernel-level PPP driver.  The argument
 .TP
 .B kdebug \fIn
 Enable debugging code in the kernel-level PPP driver.  The argument

-\fIn\fR is a number which is the sum of the following values: 1 to
+values depend on the specific kernel driver, but in general a value of
+1 will enable general kernel debug messages.  (Note that these
+messages are usually only useful for debugging the kernel driver
+itself.)  For the Linux 2.2.x kernel driver, the value is a sum of
+bits: 1 to

 enable general debug messages, 2 to request that the contents of
 received packets be printed, and 4 to request that the contents of
 transmitted packets be printed.  On most systems, messages printed by
 enable general debug messages, 2 to request that the contents of
 received packets be printed, and 4 to request that the contents of
 transmitted packets be printed.  On most systems, messages printed by


@@ -621,10 +638,10 @@ requests from pppd for CCP negotiation.
 .B nocrtscts
 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the
 .B nocrtscts
 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the

-\fIcdtrcts\fR nor the \fInodtrcts\fR option is given, the hardware
+\fIcdtrcts\fR nor the \fInocdtrcts\fR option is given, the hardware

 flow control setting for the serial port is left unchanged.
 .TP
 flow control setting for the serial port is left unchanged.
 .TP

-.B nodtrcts
+.B nocdtrcts

 This option is a synonym for \fInocrtscts\fR. Either of these options will
 disable both forms of hardware flow control.
 .TP
 This option is a synonym for \fInocrtscts\fR. Either of these options will
 disable both forms of hardware flow control.
 .TP


@@ -777,7 +794,10 @@ the connection.
 .TP
 .B plugin \fIfilename
 Load the shared library object file \fIfilename\fR as a plugin.  This
 .TP
 .B plugin \fIfilename
 Load the shared library object file \fIfilename\fR as a plugin.  This

-is a privileged option.
+is a privileged option.  If \fIfilename\fR does not contain a slash
+(/), pppd will look in the \fB/usr/lib/pppd/\fIversion\fR directory
+for the plugin, where
+\fIversion\fR is the version number of pppd (for example, 2.4.2).

 .TP
 .B predictor1
 Request that the peer compress frames that it sends using Predictor-1
 .TP
 .B predictor1
 Request that the peer compress frames that it sends using Predictor-1