X-Git-Url: https://git.ozlabs.org/?p=ppp.git;a=blobdiff_plain;f=pppd%2Fpppd.8;h=1cf0f67db62b181f584903a52eafd8b3aafa45fe;hp=bcb3e669fd4dcabd26963ebc033d87477c2472e5;hb=045169401601639b9163e1df00f868a0a49131ce;hpb=ec4108acfc11f02151d49bbf20d62988dc2586c2 diff --git a/pppd/pppd.8 b/pppd/pppd.8 index bcb3e66..1cf0f67 100644 --- a/pppd/pppd.8 +++ b/pppd/pppd.8 @@ -1,5 +1,5 @@ .\" manual page [] for pppd 2.4 -.\" $Id: pppd.8,v 1.86 2005/08/26 00:06:35 paulus Exp $ +.\" $Id: pppd.8,v 1.90 2008/03/26 12:09:40 paulus Exp $ .\" SH section heading .\" SS subsection heading .\" LP paragraph @@ -121,6 +121,18 @@ the gateway, when IPCP negotiation is successfully completed. This entry is removed when the PPP connection is broken. This option is privileged if the \fInodefaultroute\fR option has been specified. .TP +.B defaultroute-metric +Define the metric of the \fIdefaultroute\fR and only add it if there +is no other default route with the same metric. With the default +value of -1, the route is only added if there is no default route at +all. +.TP +.B defaultroute6 +Add a default IPv6 route to the system routing tables, using the peer as +the gateway, when IPv6CP negotiation is successfully completed. +This entry is removed when the PPP connection is broken. This option +is privileged if the \fInodefaultroute6\fR option has been specified. +.TP .B disconnect \fIscript Execute the command specified by \fIscript\fR, by passing it to a shell, after @@ -153,7 +165,8 @@ 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. +serial device to ensure exclusive access to the device. By default, +pppd will not create a lock file. .TP .B mru \fIn Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd @@ -192,9 +205,12 @@ 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 +Enable the IPv6CP and IPv6 protocols. +.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 +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). @@ -316,8 +332,9 @@ can do either.) .TP .B demand Initiate the link only on demand, i.e. when data traffic is present. -With this option, the remote IP address must be specified by the user -on the command line or in an options file. Pppd will initially +With this option, the remote IP address may be specified by the user +on the command line or in an options file, or if not, pppd will use +an arbitrary address in the 10.x.x.x range. Pppd will initially configure the interface and enable it for IP traffic without connecting to the peer. When traffic is available, pppd will connect to the peer and perform negotiation, authentication, etc. @@ -327,7 +344,7 @@ When this is completed, pppd will commence passing data packets The \fIdemand\fR option implies the \fIpersist\fR option. If this behaviour is not desired, use the \fInopersist\fR option after the \fIdemand\fR option. The \fIidle\fR and \fIholdoff\fR -options are also useful in conjuction with the \fIdemand\fR option. +options are also useful in conjunction with the \fIdemand\fR option. .TP .B domain \fId Append the domain name \fId\fR to the local host name for authentication @@ -351,6 +368,16 @@ 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 enable-session +Enables session accounting via PAM or wtwp/wtmpx, as appropriate. +When PAM is enabled, the PAM "account" and "session" module stacks +determine behavior, and are enabled for all PPP authentication +protocols. When PAM is disabled, wtmp/wtmpx entries are recorded +regardless of whether the peer name identifies a valid user on the +local system, making peers visible in the last(1) log. This feature +is automatically enabled when the pppd \fBlogin\fR option is used. +Session accounting is disabled by default. +.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 @@ -438,6 +465,16 @@ scripts. If this option is given, the \fIstring\fR supplied is given as the 6th parameter to those scripts. .TP +.B ipv6cp\-accept\-local +With this option, pppd will accept the peer's idea of our local IPv6 +interface identifier, even if the local IPv6 interface identifier +was specified in an option. +.TP +.B ipv6cp\-accept\-remote +With this option, pppd will accept the peer's idea of its (remote) +IPv6 interface identifier, even if the remote IPv6 interface +identifier was specified in an option. +.TP .B ipv6cp\-max\-configure \fIn Set the maximum number of IPv6CP configure-request transmissions to \fIn\fR (default 10). @@ -514,7 +551,7 @@ Set the maximum number of IPXCP NAK frames which the local system will send before it rejects the options. The default value is 3. .TP .B ipxcp\-max\-terminate \fIn -Set the maximum nuber of IPXCP terminate request frames before the +Set the maximum number of IPXCP terminate request frames before the local system considers that the peer is not listening to them. The default value is 3. .TP @@ -538,6 +575,11 @@ to 1) if the \fIproxyarp\fR option is used, and will enable the dynamic IP address option (i.e. set /proc/sys/net/ipv4/ip_dynaddr to 1) in demand mode if the local address changes. .TP +.B lcp\-echo\-adaptive +If this option is used with the \fIlcp\-echo\-failure\fR option then +pppd will send LCP echo\-request frames only if no traffic was received +from the peer since the last echo\-request was sent. +.TP .B lcp\-echo\-failure \fIn If this option is given, pppd will presume the peer to be dead if \fIn\fR LCP echo\-requests are sent without receiving a valid LCP @@ -601,7 +643,16 @@ the user who invoked pppd, in append mode. Use the system password database for authenticating the peer using PAP, and record the user in the system wtmp file. Note that the peer must have an entry in the /etc/ppp/pap\-secrets file as well as the -system password database to be allowed access. +system password database to be allowed access. See also the +\fBenable\-session\fR option. +.TP +.B master_detach +If multilink is enabled and this pppd process is the multilink bundle +master, and the link controlled by this pppd process terminates, this +pppd process continues to run in order to maintain the bundle. If the +\fBmaster_detach\fR option has been given, pppd will detach from its +controlling terminal in this situation, even if the \fBnodetach\fR +option has been given. .TP .B maxconnect \fIn Terminate the connection when it has been available for network @@ -708,6 +759,11 @@ Disable the \fIdefaultroute\fR option. The system administrator who wishes to prevent users from creating default routes with pppd can do so by placing this option in the /etc/ppp/options file. .TP +.B nodefaultroute6 +Disable the \fIdefaultroute6\fR option. The system administrator who +wishes to prevent users from adding a default route with pppd +can do so by placing this option in the /etc/ppp/options file. +.TP .B nodeflate Disables Deflate compression; pppd will not request or agree to compress packets using the Deflate scheme. @@ -748,6 +804,11 @@ for IPXCP negotiation. Opposite of the \fIktune\fR option; disables pppd from changing system settings. .TP +.B nolock +Opposite of the \fIlock\fR option; specifies that pppd should not +create a UUCP-style lock file for the serial device. This option is +privileged. +.TP .B nolog Do not send log messages to a file or file descriptor. This option cancels the \fBlogfd\fR and \fBlogfile\fR options. @@ -800,6 +861,18 @@ Disable the \fIproxyarp\fR option. The system administrator who wishes to prevent users from creating proxy ARP entries with pppd can do so by placing this option in the /etc/ppp/options file. .TP +.B noremoteip +Allow pppd to operate without having an IP address for the peer. This +option is only available under Linux. Normally, pppd will request the +peer's IP address, and if the peer does not supply it, pppd will use +an arbitrary address in the 10.x.x.x subnet. +With this option, if the peer does +not supply its IP address, pppd will not ask the peer for it, and will +not set the destination address of the ppp interface. In this +situation, the ppp interface can be used for routing by creating +device routes, but the peer itself cannot be addressed directly for IP +traffic. +.TP .B notty Normally, pppd requires a terminal device. With this option, pppd will allocate itself a pseudo-tty master/slave pair and use the slave @@ -901,7 +974,7 @@ 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. (Note: if the -\fIrecord\fR option is used in conjuction with the \fIpty\fR option, +\fIrecord\fR option is used in conjunction with the \fIpty\fR option, the child process will have pipes on its standard input and output.) .TP .B receive\-all @@ -982,6 +1055,13 @@ Authentication Protocol] authentication. Require the peer to authenticate itself using PAP [Password Authentication Protocol] authentication. .TP +.B set \fIname\fR=\fIvalue +Set an environment variable for scripts that are invoked by pppd. +When set by a privileged source, the variable specified by \fIname\fR +cannot be changed by options contained in an unprivileged source. See +also the \fIunset\fR option and the environment described in +\fISCRIPTS\fR. +.TP .B show\-password When logging the contents of PAP packets, this option causes pppd to show the password string in the log message. @@ -1009,9 +1089,13 @@ in the pseudonym. .TP .B srp\-use\-pseudonym When operating as an EAP SRP\-SHA1 client, attempt to use the pseudonym -stored in ~/.ppp_psuedonym first as the identity, and save in this +stored in ~/.ppp_pseudonym first as the identity, and save in this file any pseudonym offered by the peer during authentication. .TP +.B stop\-bits \fIn +Set the number of stop bits for the serial port. Valid values are 1 or 2. +The default value is 1. +.TP .B sync Use synchronous HDLC serial encoding instead of asynchronous. The device used by pppd with this option must have sync support. @@ -1020,7 +1104,20 @@ under Linux and FreeBSD 2.2.8 and later. .TP .B unit \fInum Sets the ppp unit number (for a ppp0 or ppp1 etc interface name) for outbound -connections. +connections. If the unit is already in use a dynamically allocated number will +be used. +.TP +.B ifname \fIstring +Set the ppp interface name for outbound connections. If the interface name is +already in use, or if the name cannot be used for any other reason, pppd will +terminate. +.TP +.B unset \fIname +Remove a variable from the environment variable for scripts that are +invoked by pppd. When specified by a privileged source, the variable +\fIname\fR cannot be set by options contained in an unprivileged +source. See also the \fIset\fR option and the environment described +in \fISCRIPTS\fR. .TP .B updetach With this option, pppd will detach from its controlling terminal once @@ -1028,6 +1125,15 @@ 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 up_sdnotify +Use this option to run pppd in systemd service units of Type=notify +(\fBup_sdnotify\fR implies \fBnodetach\fR). +When \fBup_sdnotify\fR is enabled, pppd will notify systemd once +it has successfully established the ppp connection (to the point where +the first network control protocl, usually the IP control protocol, +has come up). This option is only availble when pppd is compiled with +systemd support. +.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 @@ -1072,7 +1178,7 @@ the initial /dev/ is removed from the terminal name, and any remaining .PP An options file is parsed into a series of words, delimited by whitespace. Whitespace can be included in a word by enclosing the -word in double-quotes ("). A backslash (\\) quotes the following character. +word in double-quotes ("). A backslash (\e) quotes the following character. A hash (#) starts a comment, which continues until the end of the line. There is no restriction on using the \fIfile\fR or \fIcall\fR options within an options file. @@ -1384,9 +1490,9 @@ OK "atdt2468135" .br "name:" "^Umyuserid" .br -"word:" "\\qmypassword" +"word:" "\eqmypassword" .br -"ispts" "\\q^Uppp" +"ispts" "\eq^Uppp" .br "~\-^Uppp\-~" .LP @@ -1583,11 +1689,13 @@ The logical name of the link, set with the \fIlinkname\fR option. .TP .B DNS1 If the peer supplies DNS server addresses, this variable is set to the -first DNS server address supplied. +first DNS server address supplied (whether or not the usepeerdns +option was given). .TP .B DNS2 If the peer supplies DNS server addresses, this variable is set to the -second DNS server address supplied. +second DNS server address supplied (whether or not the usepeerdns +option was given). .P Pppd invokes the following scripts, if they exist. It is not an error if they don't exist. @@ -1760,6 +1868,11 @@ Simpson, W.A. .I PPP in HDLC-like Framing. July 1994. .TP +.B RFC1990 +Sklower, K.; et al., +.I The PPP Multilink Protocol (MP). +August 1996. +.TP .B RFC2284 Blunk, L.; Vollbrecht, J., .I PPP Extensible Authentication Protocol (EAP). @@ -1785,7 +1898,10 @@ process by sending it a signal from the list below. .TP .B SIGINT, SIGTERM These signals cause pppd to terminate the link (by closing LCP), -restore the serial device settings, and exit. +restore the serial device settings, and exit. If a connector or +disconnector process is currently running, pppd will send the same +signal to its process group, so as to terminate the connector or +disconnector process. .TP .B SIGHUP This signal causes pppd to terminate the link, restore the serial @@ -1794,6 +1910,8 @@ device settings, and close the serial device. If the \fIpersist\fR or serial device and start another connection (after the holdoff period). Otherwise pppd will exit. If this signal is received during the holdoff period, it causes pppd to end the holdoff period immediately. +If a connector or disconnector process is running, pppd will send the +same signal to its process group. .TP .B SIGUSR1 This signal toggles the state of the \fIdebug\fR option. @@ -1874,7 +1992,7 @@ are met: prior written permission. .LP 4. Redistributions of any form whatsoever must retain the following - acknowledgments: + acknowledgements: .br "This product includes software developed by Computing Services at Carnegie Mellon University (http://www.cmu.edu/computing/)."