X-Git-Url: https://git.ozlabs.org/?a=blobdiff_plain;f=pppd%2Fpppd.8;h=67b5d3299378461a390d66daaf1f3038b2bd3e81;hb=fc8a2a1cb1a141e5c1d9c9f0580e4f97271f9734;hp=4c83af808c0aa4a0a00874f41cfe576ee5533ddf;hpb=de7942371374241e49ab63439c35b142882f150c;p=ppp.git diff --git a/pppd/pppd.8 b/pppd/pppd.8 index 4c83af8..67b5d32 100644 --- a/pppd/pppd.8 +++ b/pppd/pppd.8 @@ -1,5 +1,5 @@ .\" manual page [] for pppd 2.3 -.\" $Id: pppd.8,v 1.40 1999/05/13 00:34:04 paulus Exp $ +.\" $Id: pppd.8,v 1.46 1999/08/24 05:31:10 paulus Exp $ .\" SH section heading .\" SS subsection heading .\" LP paragraph @@ -132,6 +132,13 @@ with hex values 0x20 - 0x3f or 0x5e. Read options from file \fIname\fR (the format is described below). The file must be readable by the user who has invoked pppd. .TP +.B init \fIscript +Run the executable or shell command specified by \fIscript\fR to +initialize the serial line. This script would typically use the +chat(8) program to configure the modem to enable auto answer. A value +for this option from a privileged source cannot be overridden by a +non-privileged user. +.TP .B lock Specifies that pppd should create a UUCP-style lock file for the serial device to ensure exclusive access to the device. @@ -141,13 +148,14 @@ Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd will ask the peer to send packets of no more than \fIn\fR bytes. The minimum MRU value is 128. The default MRU value is 1500. A value of 296 is recommended for slow links (40 bytes for TCP/IP header + 256 -bytes of data). +bytes of data). (Note that for IPv6 MRU must be at least 1280) .TP .B mtu \fIn Set the MTU [Maximum Transmit Unit] value to \fIn\fR. Unless the peer requests a smaller value via MRU negotiation, pppd will request that the kernel networking code send data packets of no more -than \fIn\fR bytes through the PPP network interface. +than \fIn\fR bytes through the PPP network interface. (Note that for +IPv6 MTU must be at least 1280) .TP .B passive Enables the "passive" option in the LCP. With this option, pppd will @@ -170,6 +178,14 @@ will not accept a different value from the peer in the IPCP negotiation, unless the \fIipcp-accept-local\fR and/or \fIipcp-accept-remote\fR options are given, respectively. .TP +.B ipv6 \fI\fR,\fI +Set the local and/or remote 64-bit interface identifier. Either one may be +omitted. The identifier must be specified in standard ascii notation of +IPv6 addresses (e.g. ::dead:beef). If the +\fIipv6cp-use-ipaddr\fR +option is given, the local identifier is the local IPv4 address (see above). +Otherwise the identifier is randomized. +.TP .B active-filter \fIfilter-expression Specifies a packet filter to be applied to data packets to determine which packets are to be regarded as link activity, and therefore reset @@ -313,6 +329,22 @@ Provides an extra parameter to the ip-up and ip-down scripts. If this option is given, the \fIstring\fR supplied is given as the 6th parameter to those scripts. .TP +.B ipv6cp-max-configure \fIn +Set the maximum number of IPv6CP configure-request transmissions to +\fIn\fR (default 10). +.TP +.B ipv6cp-max-failure \fIn +Set the maximum number of IPv6CP configure-NAKs returned before starting +to send configure-Rejects instead to \fIn\fR (default 10). +.TP +.B ipv6cp-max-terminate \fIn +Set the maximum number of IPv6CP terminate-request transmissions to +\fIn\fR (default 3). +.TP +.B ipv6cp-restart \fIn +Set the IPv6CP restart interval (retransmission timeout) to \fIn\fR +seconds (default 3). +.TP .B ipx Enable the IPXCP and IPX protocols. This option is presently only supported under Linux, and only if your kernel has been configured to @@ -419,11 +451,31 @@ Set the maximum number of LCP terminate-request transmissions to Set the LCP restart interval (retransmission timeout) to \fIn\fR seconds (default 3). .TP +.B linkname \fIname\fR +Sets the logical name of the link to \fIname\fR. Pppd will create a +file named \fBppp-\fIname\fB.pid\fR in /var/run (or /etc/ppp on some +systems) containing its process ID. This can be useful in determining +which instance of pppd is responsible for the link to a given peer +system. This is a privileged option. +.TP .B local Don't use the modem control lines. With this option, pppd will ignore the state of the CD (Carrier Detect) signal from the modem and will not change the state of the DTR (Data Terminal Ready) signal. .TP +.B logfd \fIn +Send log messages to file descriptor \fIn\fR. Pppd will send log +messages to at most one file or file descriptor (as well as sending +the log messages to syslog), so this option and the \fBlogfile\fR +option are mutually exclusive. The default is for pppd to send log +messages to stdout (file descriptor 1), unless the serial port is +already open on stdout. +.TP +.B logfile \fIfilename +Append log messages to the file \fIfilename\fR (as well as sending the +log messages to syslog). The file is opened with the privileges of +the user who invoked pppd, in append mode. +.TP .B login Use the system password database for authenticating the peer using PAP, and record the user in the system wtmp file. Note that the peer @@ -435,6 +487,10 @@ Terminate the connection when it has been available for network traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first network control protocol comes up). .TP +.B maxfail \fIn +Terminate after \fIn\fR consecutive failed connection attempts. A +value of 0 means no limit. The default value is 10. +.TP .B modem Use the modem control lines. This option is the default. With this option, pppd will wait for the CD (Carrier Detect) signal from the @@ -526,6 +582,11 @@ Disable IPCP negotiation and IP communication. This option should only be required if the peer is buggy and gets confused by requests from pppd for IPCP negotiation. .TP +.B noipv6 +Disable IPv6CP negotiation and IPv6 communication. This option should +only be required if the peer is buggy and gets confused by requests +from pppd for IPv6CP negotiation. +.TP .B noipdefault Disables the default behaviour when no local IP address is specified, which is to determine (if possible) the local IP address from the @@ -538,6 +599,9 @@ Disable the IPXCP and IPX protocols. This option should only be required if the peer is buggy and gets confused by requests from pppd for IPXCP negotiation. .TP +.B nolog +Do not send log messages to a file or file descriptor. This option +cancels the \fBlogfd\fR and \fBlogfile\fR options. .B nomagic Disable magic number negotiation. With this option, pppd cannot detect a looped-back line. This option should only be needed if the @@ -553,7 +617,7 @@ default unless the \fIpersist\fR or \fIdemand\fR option has been specified. .TP .B nopredictor1 -Do not accept or agree to Predictor-1 comprssion. +Do not accept or agree to Predictor-1 compression. .TP .B noproxyarp Disable the \fIproxyarp\fR option. The system administrator who @@ -696,12 +760,23 @@ The device used by pppd with this option must have sync support. Currently supports Microgate SyncLink adapters under Linux and FreeBSD 2.2.8 and later. .TP +.B updetach +With this option, pppd will detach from its controlling terminal once +it has successfully established the ppp connection (to the point where +the first network control protocol, usually the IP control protocol, +has come up). +.TP .B usehostname Enforce the use of the hostname (with domain name appended, if given) as the name of the local system for authentication purposes (overrides the \fIname\fR option). This option is not normally needed since the \fIname\fR option is privileged. .TP +.B usepeerdns +Ask the peer for up to 2 DNS server addresses. The addresses supplied +by the peer (if any) are passed to the /etc/ppp/ip-up script in the +environment variables DNS1 and DNS2. +.TP .B user \fIname Sets the name used for authenticating the local system to the peer to \fIname\fR. @@ -1115,6 +1190,12 @@ The link was terminated by the modem hanging up. .TP .B 17 The PPP negotiation failed because serial loopback was detected. +.TP +.B 18 +The init script failed (returned a non-zero exit status). +.TP +.B 19 +We failed to authenticate ourselves to the peer. .SH SCRIPTS Pppd invokes scripts at various stages in its processing which can be used to perform site-specific ancillary processing. These scripts are @@ -1170,6 +1251,9 @@ connection. .B BYTES_RCVD The number of bytes received (at the level of the serial port) during the connection. +.TP +.B LINKNAME +The logical name of the link, set with the \fIlinkname\fR option. .P Pppd invokes the following scripts, if they exist. It is not an error if they don't exist. @@ -1203,6 +1287,18 @@ used for undoing the effects of the /etc/ppp/ip-up script. It is invoked in the same manner and with the same parameters as the ip-up script. .TP +.B /etc/ppp/ipv6-up +Like /etc/ppp/ip-up, except that it is executed when the link is available +for sending and receiving IPv6 packets. It is executed with the parameters +.IP +\fIinterface-name tty-device speed local-link-local-address +remote-link-local-address ipparam\fR +.TP +.B /etc/ppp/ipv6-down +Similar to /etc/ppp/ip-down, but it is executed when IPv6 packets can no +longer be transmitted on the link. It is executed with the same parameters +as the ipv6-up script. +.TP .B /etc/ppp/ipx-up A program or script which is executed when the link is available for sending and receiving IPX packets (that is, IPXCP has come up). It is @@ -1234,6 +1330,10 @@ 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) +Process-ID for pppd process for logical link \fIname\fR (see the +\fIlinkname\fR option). +.TP .B /etc/ppp/pap-secrets Usernames, passwords and IP addresses for PAP authentication. This file should be owned by root and not readable or writable by any other @@ -1296,6 +1396,11 @@ July 1994. Simpson, W.A. .I PPP in HDLC-like Framing. July 1994. +.TP +.B RFC2472 +Haskin, D. +.I IP Version 6 over PPP +December 1998. .SH NOTES The following signals have the specified effect when sent to pppd. .TP