X-Git-Url: http://git.ozlabs.org/?p=ppp.git;a=blobdiff_plain;f=pppd%2Fpppd.8;h=339dde77d569a6859bf6e8b5b107004912235f29;hp=94c5ca094c2fe9fecdeeadbae9c11d040b7be4fe;hb=19872c62b8c5c5f77a4db07e52852f6bd22d4f75;hpb=76189970b651967f272501e8634de73443ee1a60 diff --git a/pppd/pppd.8 b/pppd/pppd.8 index 94c5ca0..339dde7 100644 --- a/pppd/pppd.8 +++ b/pppd/pppd.8 @@ -1,5 +1,5 @@ -.\" manual page [] for pppd 2.3 -.\" $Id: pppd.8,v 1.49 1999/11/17 03:49:56 paulus Exp $ +.\" manual page [] for pppd 2.4 +.\" $Id: pppd.8,v 1.65 2002/09/20 06:53:19 fcusack Exp $ .\" SH section heading .\" SS subsection heading .\" LP paragraph @@ -93,17 +93,6 @@ but will be unable to request the modem stop sending to the computer. This mode retains the ability to use DTR as a modem control line. .TP -.B cdtrcts -Use a non-standard hardware flow control (i.e. DTR/CTS) to control -the flow of data on the serial port. If neither the \fIcrtscts\fR, -the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR -option is given, the hardware flow control setting for the serial -port is left unchanged. -Some serial ports (such as Macintosh serial ports) lack a true -RTS output. Such serial ports use this mode to implement true -bi-directional flow control. The sacrifice is that this flow -control mode does not permit using DTR as a modem control line. -.TP .B defaultroute Add a default route to the system routing tables, using the peer as the gateway, when IPCP negotiation is successfully completed. @@ -202,7 +191,7 @@ except that qualifiers which are inappropriate for a PPP link, such as \fBether\fR and \fBarp\fR, are not permitted. Generally the filter expression should be enclosed in single-quotes to prevent whitespace in the expression from being interpreted by the shell. This option -is currently only available under NetBSD, and then only +is currently only available under NetBSD or Linux, and then only if both the kernel and pppd were compiled with PPP_FILTER defined. .TP .B allow-ip \fIaddress(es) @@ -223,6 +212,17 @@ Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables compression in the corresponding direction. Use \fInobsdcomp\fR or \fIbsdcomp 0\fR to disable BSD-Compress compression entirely. .TP +.B cdtrcts +Use a non-standard hardware flow control (i.e. DTR/CTS) to control +the flow of data on the serial port. If neither the \fIcrtscts\fR, +the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR +option is given, the hardware flow control setting for the serial +port is left unchanged. +Some serial ports (such as Macintosh serial ports) lack a true +RTS output. Such serial ports use this mode to implement true +bi-directional flow control. The sacrifice is that this flow +control mode does not permit using DTR as a modem control line. +.TP .B chap-interval \fIn If this option is given, pppd will rechallenge the peer every \fIn\fR seconds. @@ -235,6 +235,14 @@ Set the maximum number of CHAP challenge transmissions to \fIn\fR Set the CHAP restart interval (retransmission timeout for challenges) to \fIn\fR seconds (default 3). .TP +.B connect-delay \fIn +Wait for up \fIn\fR milliseconds after the connect script finishes for +a valid PPP packet from the peer. At the end of this time, or when a +valid PPP packet is received from the peer, pppd will commence +negotiation by sending its first LCP packet. The default value is +1000 (1 second). This wait period only applies if the \fBconnect\fR +or \fBpty\fR option is used. +.TP .B debug Enables connection debugging facilities. If this option is given, pppd will log the contents of all @@ -257,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 -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 @@ -290,9 +298,38 @@ 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 +.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 +Sets the endpoint discriminator sent by the local machine to the peer +during multilink negotiation to \fI\fR. The default is to use +the MAC address of the first ethernet interface on the system, if any, +otherwise the IPv4 address corresponding to the hostname, if any, +provided it is not in the multicast or locally-assigned IP address +ranges, or the localhost address. The endpoint discriminator can be +the string \fBnull\fR or of the form \fItype\fR:\fIvalue\fR, where +type is a decimal number or one of the strings \fBlocal\fR, \fBIP\fR, +\fBMAC\fR, \fBmagic\fR, or \fBphone\fR. The value is an IP address in +dotted-decimal notation for the \fBIP\fR type, or a string of bytes in +hexadecimal, separated by periods or colons for the other types. For +the MAC type, the value may also be the name of an ethernet or similar +network interface. This option is currently only available under +Linux. +.TP .B hide-password When logging the contents of PAP packets, this option causes pppd to -exclude the password string from the log. +exclude the password string from the log. This is the default. .TP .B holdoff \fIn Specifies how many seconds to wait before re-initiating the link after @@ -420,7 +457,11 @@ default value is 3. .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 @@ -516,6 +557,27 @@ signal briefly when the connection is terminated and before executing the connect script. On Ultrix, this option implies hardware flow control, as for the \fIcrtscts\fR option. .TP +.B mp +Enables the use of PPP multilink; this is an alias for the `multilink' +option. This option is currently only available under Linux. +.TP +.B mppe-stateful +Allow MPPE to use stateful mode. Stateless mode is still attempted first. +The default is to disallow stateful mode. +.TP +.B mpshortseq +Enables the use of short (12-bit) sequence numbers in multilink +headers, as opposed to 24-bit sequence numbers. This option is only +available under Linux, and only has any effect if multilink is +enabled (see the multilink option). +.TP +.B mrru \fIn +Sets the Maximum Reconstructed Receive Unit to \fIn\fR. The MRRU is +the maximum size for a received packet on a multilink bundle, and is +analogous to the MRU for the individual links. This option is +currently only available under Linux, and only has any effect if +multilink is enabled (see the multilink option). +.TP .B ms-dns \fI If pppd is acting as a server for Microsoft Windows clients, this option allows pppd to supply one or two DNS (Domain Name Server) @@ -531,6 +593,14 @@ Internet Name Services) server addresses to the clients. The first instance of this option specifies the primary WINS address; the second instance (if given) specifies the secondary WINS address. .TP +.B multilink +Enables the use of the PPP multilink protocol. If the peer also +supports multilink, then this link can become part of a bundle between +the local system and the peer. If there is an existing bundle to the +peer, pppd will join this link to that bundle, otherwise pppd will +create a new bundle. See the MULTILINK section below. This option is +currently only available under Linux. +.TP .B name \fIname Set the name of the local system for authentication purposes to \fIname\fR. This is a privileged option. With this option, pppd will @@ -572,10 +642,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 -\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 -.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 @@ -593,6 +663,11 @@ Don't detach from the controlling terminal. Without this option, if a serial device other than the terminal on the standard input is specified, pppd will fork to become a background process. .TP +.B noendpoint +Disables pppd from sending an endpoint discriminator to the peer or +accepting one from the peer (see the MULTILINK section below). This +option should only be required if the peer is buggy. +.TP .B noip Disable IPCP negotiation and IP communication. This option should only be required if the peer is buggy and gets confused by requests @@ -622,11 +697,38 @@ settings. .B nolog Do not send log messages to a file or file descriptor. This option cancels the \fBlogfd\fR and \fBlogfile\fR options. +.TP .B nomagic Disable magic number negotiation. With this option, pppd cannot detect a looped-back line. This option should only be needed if the peer is buggy. .TP +.B nomp +Disables the use of PPP multilink. This option is currently only +available under Linux. +.TP +.B nomppe +Disables MPPE (Microsoft Point to Point Encryption). This is the default. +.TP +.B nomppe-40 +Disable 40\-bit encryption with MPPE. +.TP +.B nomppe-128 +Disable 128\-bit encryption with MPPE. +.TP +.B nomppe-stateful +Disable MPPE stateful mode. This is the default. +.TP +.B nompshortseq +Disables the use of short (12-bit) sequence numbers in the PPP +multilink protocol, forcing the use of 24-bit sequence numbers. This +option is currently only available under Linux, and only has any +effect if multilink is enabled. +.TP +.B nomultilink +Disables the use of PPP multilink. This option is currently only +available under Linux. +.TP .B nopcomp Disable protocol field compression negotiation in both the receive and the transmit direction. @@ -704,11 +806,15 @@ the kernel and pppd were compiled with PPP_FILTER defined. .TP .B persist Do not exit after a connection is terminated; instead try to reopen -the connection. +the connection. The \fBmaxfail\fR option still has an effect on +persistent connections. .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 @@ -735,7 +841,9 @@ rather than a specific terminal device. Pppd will allocate itself a pseudo-tty master/slave pair and use the slave as its terminal device. The \fIscript\fR will be run in a child process with the pseudo-tty master as its standard input and output. An explicit -device name may not be given if this option is used. +device name may not be given if this option is used. (Note: if the +\fIrecord\fR option is used in conjuction with the \fIpty\fR option, +the child process will have pipes on its standard input and output.) .TP .B receive-all With this option, pppd will accept all control characters from the @@ -761,6 +869,14 @@ to \fIname\fR. With this option, pppd will not agree to authenticate itself to the peer using CHAP. .TP +.B refuse-mschap +With this option, pppd will not agree to authenticate itself to the +peer using MS-CHAP. +.TP +.B refuse-mschap-v2 +With this option, pppd will not agree to authenticate itself to the +peer using MS-CHAPv2. +.TP .B refuse-pap With this option, pppd will not agree to authenticate itself to the peer using PAP. @@ -769,10 +885,36 @@ peer using PAP. Require the peer to authenticate itself using CHAP [Challenge Handshake Authentication Protocol] authentication. .TP +.B require-mppe +Require the use of MPPE (Microsoft Point to Point Encryption). This +option disables all other compression types. This option enables +both 40\-bit and 128\-bit encryption. In order for MPPE to successfully +come up, you must have authenticated with either MS-CHAP or MS-CHAPv2. +This option is presently only supported under Linux, and only if your +kernel has been configured to include MPPE support. +.TP +.B require-mppe-40 +Require the use of MPPE, with 40\-bit encryption. +.TP +.B require-mppe-128 +Require the use of MPPE, with 128\-bit encryption. +.TP +.B require-mschap +Require the peer to authenticate itself using MS-CHAP [Microsft Challenge +Handshake Authentication Protocol] authentication. +.TP +.B require-mschap-v2 +Require the peer to authenticate itself using MS-CHAPv2 [Microsft Challenge +Handshake Authentication Protocol, Version 2] authentication. +.TP .B require-pap Require the peer to authenticate itself using PAP [Password Authentication Protocol] authentication. .TP +.B show-password +When logging the contents of PAP packets, this option causes pppd to +show the password string in the log message. +.TP .B silent With this option, pppd will not transmit LCP packets to initiate a connection until a valid LCP packet is received from the peer (as for @@ -916,7 +1058,8 @@ pppd will not agree to authenticate itself with a particular protocol if it has no secrets which could be used to do so. .LP Pppd stores secrets for use in authentication in secrets -files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP). +files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for +CHAP/MS-CHAP/MS-CHAPv2). Both secrets files have the same format. The secrets files can contain secrets for pppd to use in authenticating itself to other systems, as well as secrets for pppd to use when authenticating other @@ -1049,6 +1192,39 @@ IP address assignment), pppd has to change the interface IP addresses to the negotiated addresses. This may disrupt existing connections, and the use of demand dialling with peers that do dynamic IP address assignment is not recommended. +.SH MULTILINK +Multilink PPP provides the capability to combine two or more PPP links +between a pair of machines into a single `bundle', which appears as a +single virtual PPP link which has the combined bandwidth of the +individual links. Currently, multilink PPP is only supported under +Linux. +.LP +Pppd detects that the link it is controlling is connected to the same +peer as another link using the peer's endpoint discriminator and the +authenticated identity of the peer (if it authenticates itself). The +endpoint discriminator is a block of data which is hopefully unique +for each peer. Several types of data can be used, including +locally-assigned strings of bytes, IP addresses, MAC addresses, +randomly strings of bytes, or E-164 phone numbers. The endpoint +discriminator sent to the peer by pppd can be set using the endpoint +option. +.LP +In circumstances the peer may send no endpoint discriminator or a +non-unique value. The optional bundle option adds an extra string +which is added to the peer's endpoint discriminator and authenticated +identity when matching up links to be joined together in a bundle. +The bundle option can also be used to allow the establishment of +multiple bundles between the local system and the peer. Pppd uses a +TDB database in /var/run/pppd.tdb to match up links. +.LP +Assuming that multilink is enabled and the peer is willing to +negotiate multilink, then when pppd is invoked to bring up the first +link to the peer, it will detect that no other link is connected to +the peer and create a new bundle, that is, another ppp network +interface unit. When another pppd is invoked to bring up another link +to the peer, it will detect the existing bundle and join its link to +it. Currently, if the first pppd terminates (for example, because of +a hangup or a received signal) the bundle is destroyed. .SH EXAMPLES .LP The following examples assume that the /etc/ppp/options file contains @@ -1361,7 +1537,8 @@ script. .B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others) Process-ID for pppd process on ppp interface unit \fIn\fR. .TP -.B /var/run/ppp-\fIname\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp-\fIname\fB.pid \fR(others) +.B /var/run/ppp-\fIname\fB.pid \fR(BSD or Linux), +\fB/etc/ppp/ppp-\fIname\fB.pid \fR(others) Process-ID for pppd process for logical link \fIname\fR (see the \fIlinkname\fR option). .TP @@ -1371,8 +1548,8 @@ file should be owned by root and not readable or writable by any other user. Pppd will log a warning if this is not the case. .TP .B /etc/ppp/chap-secrets -Names, secrets and IP addresses for CHAP authentication. As for -/etc/ppp/pap-secrets, this file should be owned by root and not +Names, secrets and IP addresses for CHAP/MS-CHAP/MS-CHAPv2 authentication. +As for /etc/ppp/pap-secrets, this file should be owned by root and not readable or writable by any other user. Pppd will log a warning if this is not the case. .TP