From 7905ee65fc4b79d86652123a79b9d9bef4be7122 Mon Sep 17 00:00:00 2001 From: Paul Mackerras Date: Sat, 14 Sep 1996 05:17:17 +0000 Subject: [PATCH] update, make more consistent --- pppd/pppd.8 | 814 +++++++++++++++++++++++++++------------------------- 1 file changed, 426 insertions(+), 388 deletions(-) diff --git a/pppd/pppd.8 b/pppd/pppd.8 index 4a1fecb..c7e05e3 100644 --- a/pppd/pppd.8 +++ b/pppd/pppd.8 @@ -1,5 +1,5 @@ -.\" manual page [] for pppd 2.3 -.\" $Id: pppd.8,v 1.21 1996/08/28 06:41:53 paulus Exp $ +.\" manual page [] for pppd 2.0 +.\" $Id: pppd.8,v 1.22 1996/09/14 05:17:17 paulus Exp $ .\" SH section heading .\" SS subsection heading .\" LP paragraph @@ -27,18 +27,19 @@ a family of Network Control Protocols (NCP) for establishing and configuring different network-layer protocols. .LP The encapsulation scheme is provided by driver code in the kernel. -Pppd provides the basic LCP, authentication support, and an NCP for -establishing and configuring the Internet Protocol (IP) (called the IP -Control Protocol, IPCP). +.B pppd +provides the basic LCP, authentication support, and an +NCP for establishing and configuring the Internet Protocol (IP) +(called the IP Control Protocol, IPCP). .SH FREQUENTLY USED OPTIONS .TP .I Communicate over the named device. The string "/dev/" is prepended if necessary. If no device name is given, or if the name of the terminal -connected to the standard input is given, pppd +connected to the standard input is given, +.I pppd will use that terminal, and will not fork to put itself in the -background. This option is privileged if the \fInoauth\fR option is -used. +background. .TP .I Set the baud rate to (a decimal number). On systems such as @@ -46,90 +47,86 @@ Set the baud rate to (a decimal number). On systems such as (e.g. SunOS) allow only a limited set of speeds. .TP .B asyncmap \fI -Set the async character map to . This map describes which -control characters cannot be successfully received over the serial -line. Pppd will ask the peer to send these characters as a 2-byte -escape sequence. The argument is a 32 bit hex number with each bit -representing a character to escape. Bit 0 (00000001) represents the -character 0x00; bit 31 (80000000) represents the character 0x1f or ^_. -If multiple \fIasyncmap\fR options are given, the values are ORed -together. If no \fIasyncmap\fR option is given, no async character -map will be negotiated for the receive direction; the peer should then -escape \fIall\fR control characters. To escape transmitted -characters, use the \fIescape\fR option. +Set the async character map to . +This map describes which control characters cannot be successfully +received over the serial line. +.I pppd +will ask the peer to send these characters as a 2-byte escape sequence. +The argument is a 32 bit hex number +with each bit representing a character to escape. +Bit 0 (00000001) represents the character 0x00; +bit 31 (80000000) represents the character 0x1f or ^_. +If multiple \fBasyncmap\fR options are +given, the values are ORed together. +If no \fBasyncmap\fR option is given, no async character map will be +negotiated for the receive direction; the peer should then escape +\fIall\fR control characters. .TP .B auth Require the peer to authenticate itself before allowing network packets to be sent or received. .TP -.B call \fIname -Read options from the file /etc/ppp/peers/\fIname\fR. This file may -contain privileged options, such as \fInoauth\fR, even if pppd -is not being run by root. The \fIname\fR string may not begin with / -or include .. as a pathname component. -.TP -.B connect \fIscript -Use the executable or shell command specified by \fIscript\fR to set -up the serial line. This script would typically use the chat(8) -program to dial the modem and start the remote ppp session. This -option is privileged if the \fInoauth\fR option is used. +.B connect \fI

+Use the executable or shell command specified by \fI

\fR to set up the +serial line. This script would typically use the chat(8) program to +dial the modem and start the remote ppp session. .TP .B crtscts Use hardware flow control (i.e. RTS/CTS) to control the flow of data -on the serial port. If neither the \fIcrtscts\fR nor the -\fI\nocrtscts\fR option is given, the hardware flow control setting -for the serial port is left unchanged. +on the serial port. If neither the \fBcrtscts\fR nor the +\fB\-crtscts\fR option is given, the hardware flow control setting for +the serial port is left unchanged. .TP .B defaultroute Add a default route to the system routing tables, using the peer as 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. +This entry is removed when the PPP connection is broken. .TP -.B disconnect \fIscript -Run the executable or shell command specified by \fIscript\fR after -pppd has terminated the link. This script could, for example, issue -commands to the modem to cause it to hang up if hardware modem control -signals were not available. The disconnect script is not run if the -modem has already hung up. This option is privileged if the -\fInoauth\fR option is used. +.B disconnect \fI

+Run the executable or shell command specified by \fI

\fR after +\fIpppd\fR has terminated the link. This script could, for example, +issue commands to the modem to cause it to hang up if hardware modem +control signals were not available. .TP .B escape \fIxx,yy,... Specifies that certain characters should be escaped on transmission (regardless of whether the peer requests them to be escaped with its async control character map). The characters to be escaped are specified as a list of hex numbers separated by commas. Note that -almost any character can be specified for the \fIescape\fR option, -unlike the \fIasyncmap\fR option which only allows control characters +almost any character can be specified for the \fBescape\fR option, +unlike the \fBasyncmap\fR option which only allows control characters to be specified. The characters which may not be escaped are those with hex values 0x20 - 0x3f or 0x5e. .TP -.B file \fIname -Read options from file \fIname\fR (the format is described below). -The file must be readable by the user who has invoked pppd. +.B file \fI +Read options from file (the format is described below). .TP .B lock -Specifies that pppd should create a UUCP-style lock file for the +Specifies that \fIpppd\fR should create a UUCP-style lock file for the serial device to ensure exclusive access to the device. .TP -.B mru \fIn -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 +.B mru \fI +Set the MRU [Maximum Receive Unit] value to for negotiation. +.I pppd +will ask the peer to send packets of no more than 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). .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 +.B mtu \fI +Set the MTU [Maximum Transmit Unit] value to \fI\fR. Unless the +peer requests a smaller value via MRU negotiation, \fIpppd\fR will request that the kernel networking code send data packets of no more than \fIn\fR bytes through the PPP network interface. .TP .B passive -Enables the "passive" option in the LCP. With this option, pppd will -attempt to initiate a connection; if no reply is received from the -peer, pppd will then just wait passively for a valid LCP packet from -the peer, instead of exiting, as it would without this option. +Enables the "passive" option in the LCP. With this option, +.I pppd +will attempt to initiate a connection; if no reply is received from +the peer, +.I pppd +will then just wait passively for a valid LCP packet from the peer, +instead of exiting, as it would without this option. .SH OPTIONS .TP .I \fB:\fI @@ -137,14 +134,18 @@ Set the local and/or remote interface IP addresses. Either one may be omitted. The IP addresses can be specified with a host name or in decimal dot notation (e.g. 150.234.56.78). The default local address is the (first) IP address of the system (unless the -\fInoipdefault\fR +.B noipdefault option is given). The remote address will be obtained from the peer if not specified in any option. Thus, in simple cases, this option is not required. If a local and/or remote IP address is specified with -this option, pppd +this option, +.I pppd 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. +negotiation, unless the +.B ipcp-accept-local +and/or +.B ipcp-accept-remote +options are given, respectively. .TP .B bsdcomp \fInr,nt Request that the peer compress packets that it sends, using the @@ -157,21 +158,22 @@ consume more kernel memory for compression dictionaries. Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables compression in the corresponding direction. .TP -.B chap-interval \fIn -If this option is given, pppd will rechallenge the peer every \fIn\fR -seconds. +.B chap-interval \fI +If this option is given, +.I pppd +will rechallenge the peer every seconds. .TP -.B chap-max-challenge \fIn -Set the maximum number of CHAP challenge transmissions to \fIn\fR -(default 10). +.B chap-max-challenge \fI +Set the maximum number of CHAP challenge transmissions to (default +10). .TP -.B chap-restart \fIn +.B chap-restart \fI Set the CHAP restart interval (retransmission timeout for challenges) -to \fIn\fR seconds (default 3). +to seconds (default 3). .TP .B debug Increase debugging level. -If this option is given, pppd will log the contents of all +If this option is given, \fIpppd\fR will log the contents of all control packets sent or received in a readable form. The packets are logged through syslog with facility \fIdaemon\fR and level \fIdebug\fR. This information can be directed to a file by setting up @@ -183,57 +185,51 @@ escaped for both the transmit and the receive direction. .TP .B default-mru Disable MRU [Maximum Receive Unit] negotiation. With this option, -pppd will use the default MRU value of 1500 bytes for both the +\fIpppd\fR will use the default MRU value of 1500 bytes for both the transmit and receive direction. .TP .B deflate \fInr,nt 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 -for \fInr\fR and \fInt\fR; larger values give better compression but +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 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 -compression in the corresponding direction. (Note: pppd requests -Deflate compression in preference to BSD-Compress if the peer can do -either.) +compression in the corresponding direction. (Note: \fBpppd\fR +requests Deflate compression in preference to BSD-Compress +if the peer 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 must be specific by the user +on the command line or in an options file. \fBpppd\fR will initially configure the interface and enable it for IP traffic without -connecting to the peer. When traffic is available, pppd will +connecting to the peer. When traffic is available, \fBpppd\fR will connect to the peer and perform negotiation, authentication, etc. -When this is completed, pppd will commence passing data packets -(i.e., IP packets) across the link. - -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. -.TP -.B domain \fId -Append the domain name \fId\fR to the local host name for authentication -purposes. For example, if gethostname() returns the name porsche, but -the fully qualified domain name is porsche.Quotron.COM, you could -specify \fIdomain Quotron.COM\fR. Pppd would then use the name -\fIporsche.Quotron.COM\fR for looking up secrets in the secrets file, -and as the default name to send to the peer when authenticating itself -to the peer. This option is privileged. -.TP -.B holdoff \fIn +When this is completed, \fBpppd\fR will commence passing data packets +(i.e., IP packets) across the link. The persist, idle and holdoff +options are often useful in conjuction with this option. (Note that +this option does \fInot\fR imply the persist option.) +.TP +.B domain \fI +Append the domain name to the local host name for authentication +purposes. For example, if gethostname() returns the name porsche, but the +fully qualified domain name is porsche.Quotron.COM, you would use the +domain option to set the domain name to Quotron.COM. +.TP +.B holdoff \fI Specifies how many seconds to wait before re-initiating the link after -it terminates. This option only has any effect if the \fIpersist\fR -or \fIdemand\fR option is used. The holdoff period is not applied if -the link was terminated because it was idle. +it terminates. This option only has effect if the persist option is +used. .TP -.B idle \fIn -Specifies that pppd should disconnect if the link is idle for \fIn\fR -seconds. The link is idle when no data packets (i.e. IP packets) are -being sent or received. Note: it is not advisable to use this option -with the \fIpersist\fR option without the \fIdemand\fR option. +.B idle \fI +Specifies that \fBpppd\fR should disconnect if it is idle for +\fI\fR seconds. The link is idle when no data packets (i.e. IP +packets) are being sent or received. If the \fBactive-filter\fR +option is given, data packets which are rejected by the specified +activity filter also count as the link being idle. .TP .B ipx Enable the IPXCP and IPX protocols. Under Linux, this is the default @@ -241,55 +237,61 @@ condition if your kernel supports IPX. This option is presently only supported under Linux. .TP .B ipcp-accept-local -With this option, pppd will accept the peer's idea of our local IP -address, even if the local IP address was specified in an option. +With this option, +.I pppd +will accept the peer's idea of our local IP address, even if the +local IP address was specified in an option. .TP .B ipcp-accept-remote -With this option, pppd will accept the peer's idea of its (remote) IP -address, even if the remote IP address was specified in an option. +With this option, +.I pppd +will accept the peer's idea of its (remote) IP address, even if the +remote IP address was specified in an option. .TP -.B ipcp-max-configure \fIn -Set the maximum number of IPCP configure-request transmissions to -\fIn\fR (default 10). +.B ipcp-max-configure \fI +Set the maximum number of IPCP configure-request transmissions to +(default 10). .TP -.B ipcp-max-failure \fIn +.B ipcp-max-failure \fI Set the maximum number of IPCP configure-NAKs returned before starting -to send configure-Rejects instead to \fIn\fR (default 10). +to send configure-Rejects instead to (default 10). .TP -.B ipcp-max-terminate \fIn -Set the maximum number of IPCP terminate-request transmissions to -\fIn\fR (default 3). +.B ipcp-max-terminate \fI +Set the maximum number of IPCP terminate-request transmissions to +(default 3). .TP -.B ipcp-restart \fIn -Set the IPCP restart interval (retransmission timeout) to \fIn\fR -seconds (default 3). +.B ipcp-restart \fI +Set the IPCP restart interval (retransmission timeout) to seconds +(default 3). .TP .B ipparam \fIstring 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 ipx-network \fIn +.B ipx-network \fI Set the IPX network number in the IPXCP configure request frame to -\fIn\fR, a hexadecimal number (without a leading 0x). There is no -valid default. If this option is not specified, the network number is -obtained from the peer. If the peer does not have the network number, -the IPX protocol will not be started. +. There is no valid default. If this option is not specified then +the network number is obtained from the peer. If the peer does not +have the network number, the IPX protocol will not be started. This is +a hexadecimal number and is entered without any leading sequence such +as 0x. It is related to the \fIipxcp-accept-network\fR option. .TP -.B ipx-node \fIn\fB:\fIm +.B ipx-node \fI: Set the IPX node numbers. The two node numbers are separated from each -other with a colon character. The first number \fIn\fR is the local -node number. The second number \fIm\fR is the peer's node number. Each -node number is a hexadecimal number, at most 10 digits long. The node -numbers on the ipx-network must be unique. There is no valid -default. If this option is not specified then the node numbers are -obtained from the peer. +other with a colon character. The first number is the local node +number. The second number is the peer's node number. Each node number +is a hexadecimal number, to the maximum of ten significant digits. The +node numbers on the ipx-network must be unique. There is no valid +default. If this option is not specified then the node number is +obtained from the peer. This option is a related to the +\fIipxcp-accept-local\fR and \fIipxcp-accept-remote\fR options. .TP .B ipx-router-name \fI Set the name of the router. This is a string and is sent to the peer as information data. .TP -.B ipx-routing \fIn +.B ipx-routing \fI Set the routing protocol to be received by this option. More than one instance of \fIipx-routing\fR may be specified. The '\fInone\fR' option (0) may be specified as the only instance of ipx-routing. The @@ -315,15 +317,15 @@ frame. If a node number was specified for the peer and this option was not specified, the peer will be forced to use the value which you have specified. .TP -.B ipxcp-max-configure \fIn +.B ipxcp-max-configure \fI Set the maximum number of IPXCP configure request frames which the -system will send to \fIn\fR. The default is 10. +system will send to . The default is 10. .TP -.B ipxcp-max-failure \fIn +.B ipxcp-max-failure \fI 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 +.B ipxcp-max-terminate \fI Set the maximum nuber of IPXCP terminate request frames before the local system considers that the peer is not listening to them. The default value is 3. @@ -335,43 +337,46 @@ 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. .TP -.B lcp-echo-failure \fIn -If this option is given, pppd will presume the peer to be dead +.B lcp-echo-failure \fI +If this option is given, \fIpppd\fR will presume the peer to be dead if \fIn\fR LCP echo-requests are sent without receiving a valid LCP -echo-reply. If this happens, pppd will terminate the +echo-reply. If this happens, \fIpppd\fR will terminate the connection. Use of this option requires a non-zero value for the \fIlcp-echo-interval\fR parameter. This option can be used to enable -pppd to terminate after the physical connection has been broken +\fIpppd\fR to terminate after the physical connection has been broken (e.g., the modem has hung up) in situations where no hardware modem control lines are available. .TP -.B lcp-echo-interval \fIn -If this option is given, pppd will send an LCP echo-request frame to -the peer every \fIn\fR seconds. Normally the peer should respond to -the echo-request by sending an echo-reply. This option can be used -with the \fIlcp-echo-failure\fR option to detect that the peer is no -longer connected. -.TP -.B lcp-max-configure \fIn -Set the maximum number of LCP configure-request transmissions to -\fIn\fR (default 10). +.B lcp-echo-interval \fI +If this option is given, \fIpppd\fR will send an LCP echo-request +frame to the peer every \fIn\fR seconds. Under Linux, the +echo-request is sent when no packets have been received from the peer +for \fIn\fR seconds. Normally the peer should respond to the +echo-request by sending an echo-reply. This option can be used with +the \fIlcp-echo-failure\fR option to detect that the peer is no longer +connected. +.TP +.B lcp-max-configure \fI +Set the maximum number of LCP configure-request transmissions to +(default 10). .TP -.B lcp-max-failure \fIn +.B lcp-max-failure \fI Set the maximum number of LCP configure-NAKs returned before starting -to send configure-Rejects instead to \fIn\fR (default 10). +to send configure-Rejects instead to (default 10). .TP -.B lcp-max-terminate \fIn -Set the maximum number of LCP terminate-request transmissions to -\fIn\fR (default 3). +.B lcp-max-terminate \fI +Set the maximum number of LCP terminate-request transmissions to +(default 3). .TP -.B lcp-restart \fIn -Set the LCP restart interval (retransmission timeout) to \fIn\fR -seconds (default 3). +.B lcp-restart \fI +Set the LCP restart interval (retransmission timeout) to seconds +(default 3). .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. +Don't use the modem control lines. With this option, +.B 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 login Use the system password database for authenticating the peer using @@ -384,31 +389,32 @@ Terminate the connection after \fIn\fR seconds. .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 -modem to be asserted when opening the serial device (unless a connect -script is specified), and it will drop the DTR (Data Terminal Ready) -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. +option, +.B pppd +will wait for the CD (Carrier Detect) signal from the modem to be asserted +when opening the serial device +(unless a connect script is specified), and it will drop the DTR (Data +Terminal Ready) signal briefly when the connection is terminated and before +executing the connect script. +On Ultrix, this option implies hardware +flow control, as for the \fBcrtscts\fR 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) -addresses to the clients. The first instance of this option specifies -the primary DNS address; the second instance (if given) specifies the -secondary DNS address. -.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 -use lines in the secrets files which have \fIname\fR as the second -field when looking for a secret to use in authenticating the peer. In -addition, unless overridden with the \fIuser\fR option, \fIname\fR -will be used as the name to send to the peer when authenticating the -local system to the peer. -.TP -.B netmask \fIn -Set the interface netmask to \fIn\fR, a 32 bit netmask in "decimal dot" +If +.I pppd +is acting as a server for Microsoft Windows clients, this option +allows +.I pppd +to supply one or two DNS (Domain Name Server) addresses to the +clients. The first instance of this option specifies the primary DNS +address; the second instance (if given) specifies the secondary DNS +address. +.TP +.B name \fI +Set the name of the local system for authentication purposes to . +.TP +.B netmask \fI +Set the interface netmask to , a 32 bit netmask in "decimal dot" notation (e.g. 255.255.255.0). If this option is given, the value specified is ORed with the default netmask. The default netmask is chosen based on the negotiated remote IP address; it is the @@ -420,10 +426,6 @@ system which are on the same network. Disable Address/Control compression in both directions (send and receive). .TP -.B noauth -Do not require the peer to authenticate itself. This option is -privileged if the \fIauth\fR option is specified in /etc/ppp/options. -.TP .B nobsdcomp Disables BSD-Compress compression; \fBpppd\fR will not request or agree to compress packets using the BSD-Compress scheme. @@ -431,32 +433,38 @@ agree to compress packets using the BSD-Compress scheme. .B noccp Disable CCP (Compression Control Protocol) negotiation. This option should only be required if the peer is buggy and gets confused by -requests from pppd for CCP negotiation. +requests from +.I pppd +for CCP negotiation. .TP .B nocrtscts Disable hardware flow control (i.e. RTS/CTS) on the serial port. If -neither the \fIcrtscts\fR nor the \fI\nocrtscts\fR option is given, +neither the \fBcrtscts\fR nor the \fB\-crtscts\fR option is given, the hardware flow control setting for the serial port is left unchanged. .TP .B nodefaultroute -Disable the \fIdefaultroute\fR option. The system administrator who -wishes to prevent users from creating default routes with pppd +Disable the \fBdefaultroute\fR option. The system administrator who +wishes to prevent users from creating default routes with \fIpppd\fR 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 +Disables Deflate compression; \fBpppd\fR will not request or agree to compress packets using the Deflate scheme. .TP .B nodetach 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. +specified, +.I pppd +will fork to become a background process. .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 -from pppd for IPCP negotiation. +from +.I pppd +for IPCP negotiation. .TP .B noipdefault Disables the default behaviour when no local IP address is specified, @@ -467,30 +475,28 @@ command line or in an options file). .TP .B noipx Disable the IPXCP and IPX protocols. This option should only be -required if the peer is buggy and gets confused by requests from pppd +required if the peer is buggy and gets confused by requests from +.I pppd for IPXCP negotiation. .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. +Disable magic number negotiation. With this option, +.I pppd +cannot detect a looped-back line. This option should only be needed +if the peer is buggy. .TP .B nopcomp Disable protocol field compression negotiation in both the receive and the transmit direction. .TP -.B nopersist -Exit once a connection has been made and terminated. This is the -default unless the \fIpersist\fR or \fIdemand\fR option has been -specified. -.TP .B nopredictor1 Do not accept or agree to Predictor-1 comprssion. .TP .B noproxyarp -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. +Disable the \fBproxyarp\fR option. The system administrator who +wishes to prevent users from creating proxy ARP entries with +\fIpppd\fR can do so by placing this option in the /etc/ppp/options +file. .TP .B novj Disable Van Jacobson style TCP/IP header compression in both the @@ -498,58 +504,58 @@ transmit and the receive direction. .TP .B novjccomp Disable the connection-ID compression option in Van Jacobson style -TCP/IP header compression. With this option, pppd will not omit the -connection-ID byte from Van Jacobson compressed TCP/IP headers, nor -ask the peer to do so. +TCP/IP header compression. With this option, \fIpppd\fR will not omit +the connection-ID byte from Van Jacobson compressed TCP/IP headers, +nor ask the peer to do so. .TP .B papcrypt -Indicates that all secrets in the /etc/ppp/pap-secrets file which are -used for checking the identity of the peer are encrypted, and thus -pppd should not accept a password which, before encryption, is +Indicates that all secrets in the /etc/ppp/pap-secrets file which +are used for checking the identity of the peer are encrypted, and thus +pppd should not accept a password which (before encryption) is identical to the secret from the /etc/ppp/pap-secrets file. .TP -.B pap-max-authreq \fIn +.B pap-max-authreq \fI Set the maximum number of PAP authenticate-request transmissions to -\fIn\fR (default 10). + (default 10). .TP -.B pap-restart \fIn -Set the PAP restart interval (retransmission timeout) to \fIn\fR -seconds (default 3). +.B pap-restart \fI +Set the PAP restart interval (retransmission timeout) to seconds +(default 3). .TP -.B pap-timeout \fIn -Set the maximum time that pppd will wait for the peer to authenticate -itself with PAP to \fIn\fR seconds (0 means no limit). +.B pap-timeout \fI +Set the maximum time that +.I pppd +will wait for the peer to authenticate itself with PAP to + seconds (0 means no limit). .TP .B persist Do not exit after a connection is terminated; instead try to reopen the connection. .TP .B predictor1 -Request that the peer compress frames that it sends using Predictor-1 -compression, and agree to compress transmitted frames with Predictor-1 -if requested. This option has no effect unless the kernel driver -supports Predictor-1 compression. +Attempt to request that the peer send frames which +have been compressed using Predictor-1 compression. This option will +be ignored unless Predictor-1 code has been loaded into the kernel. .TP .B proxyarp Add an entry to this system's ARP [Address Resolution Protocol] table with the IP address of the peer and the Ethernet address of this -system. This will have the effect of making the peer appear to other -systems to be on the local ethernet. +system. .TP -.B remotename \fIname +.B remotename \fI Set the assumed name of the remote system for authentication purposes -to \fIname\fR. +to . .TP .B refuse-chap -With this option, pppd will not agree to authenticate itself to the -peer using CHAP. +With this option, \fIpppd\fR will not agree to authenticate itself +to the peer using CHAP. .TP .B refuse-pap -With this option, pppd will not agree to authenticate itself to the -peer using PAP. +With this option, \fIpppd\fR will not agree to authenticate itself +to the peer using PAP. .TP .B require-chap -Require the peer to authenticate itself using CHAP [Challenge +Require the peer to authenticate itself using CHAP [Cryptographic Handshake Authentication Protocol] authentication. .TP .B require-pap @@ -557,18 +563,21 @@ Require the peer to authenticate itself using PAP [Password Authentication Protocol] authentication. .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 -the `passive' option with ancient versions of pppd). +With this option, +.I pppd +will not transmit LCP packets to initiate a connection until a valid +LCP packet is received from the peer (as for the `passive' option with +ancient versions of \fIpppd\fR). .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). +Enforce the use of the hostname as the name of the local system for +authentication purposes (overrides the +.B name +option). This option can be useful in the /etc/ppp/options file. .TP -.B user \fIname -Sets the name used for authenticating the local system to the peer to -\fIname\fR. +.B user \fI +Set the user name to use for authenticating this machine with the peer +using PAP to . .TP .B vj-max-slots \fIn Sets the number of connection slots to be used by the Van Jacobson @@ -578,70 +587,56 @@ must be between 2 and 16 (inclusive). .B welcome \fIscript Run the executable or shell command specified by \fIscript\fR before initiating PPP negotiation, after the connect script (if any) has -completed. This option is privileged if the \fInoauth\fR option is -used. +completed. .TP .B xonxoff Use software flow control (i.e. XON/XOFF) to control the flow of data on -the serial port. +the serial port. This option is only implemented on Linux systems +at present. .SH OPTIONS FILES -Options can be taken from files as well as the command line. Pppd +Options can be taken from files as well as the command line. +.I pppd reads options from the files /etc/ppp/options, ~/.ppprc and -/etc/ppp/options.\fIttyname\fR (in that order) before processing the -options on the command line. (In fact, the command-line options are -scanned to find the terminal name before the options.\fIttyname\fR -file is read.) In forming the name of the options.\fIttyname\fR file, -the initial /dev/ is removed from the terminal name, and any remaining -/ characters are replaced with dots. +/etc/ppp/options.\fIttyname\fR before processing the options on the +command line. (In fact, the command-line options are scanned to find +the terminal name before the options.\fIttyname\fR file is read.) In +forming the name of the options.\fIttyname\fR file, the initial /dev/ +is removed from the terminal name, and any remaining / characters are +replaced with dots. .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 quotes ("). A backslash (\\) quotes the following character. A hash (#) starts a comment, which continues until the end of the line. -.SH PRIVILEGED OPTIONS -As indicated above, some security-sensitive options are privileged, -which means that they may not be used by an ordinary non-privileged -user running a setuid-root pppd, either on the command line, in the -user's ~/.ppprc file, or in an options file read using the \fIfile\fR -option. Privileged options may be used in /etc/ppp/options file or in -an options file read using the \fIcall\fR option. If pppd is being -run by the root user, privileged options can be used without -restriction. -.PP -The normal way that pppd should be set up is to have the \fIauth\fR -option in the /etc/ppp/options file. (This may become the default in -later releases.) If users wish to use pppd to dial out to a peer -which will refuse to authenticate itself (such as an internet service -provider), the system administrator should create an options file -under /etc/ppp/peers containing the \fInoauth\fR option, the name of -the serial port to use, and the \fIconnect\fR option (if required), -plus any other appropriate options. In this way, pppd can be set up -to allow non-privileged users to make unauthenticated connections only -to trusted peers. .SH AUTHENTICATION .I pppd provides system administrators with sufficient access control that PPP access to a server machine can be provided to legitimate users without fear of compromising the security of the server or the network it's on. In part this is provided by the /etc/ppp/options file, where the -administrator can place options to restrict the ways in which pppd can -be used, and in part by the PAP and CHAP secrets files, where the +administrator can place options to require authentication whenever +.I pppd +is run, and in part by the PAP and CHAP secrets files, where the administrator can restrict the set of IP addresses which individual users may use. .LP -The default behaviour of pppd is to agree to authenticate if -requested, and to not require authentication from the peer. However, -pppd will not agree to authenticate itself with a particular protocol -if it has no secrets which could be used to do so. +The default behaviour of +.I pppd +is to agree to authenticate if requested, and to not require +authentication from the peer. However, +.I pppd +will not agree to authenticate itself with a particular protocol if it +has no secrets which could be used to do so. .LP Authentication is based on secrets, which are selected from secrets files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP). Both secrets files have the same format, and both can store secrets for several combinations of server (authenticating peer) and client -(peer being authenticated). Note that pppd can be both a server and -client, and that different protocols can be used in the two directions -if desired. +(peer being authenticated). Note that +.I pppd +can be both a server and client, and that different protocols can be +used in the two directions if desired. .LP A secrets file is parsed into words as for a options file. A secret is specified by a line containing at least 3 words, in the order @@ -654,89 +649,122 @@ acceptable. An address may be followed by "/" and a number \fIn\fR, to indicate a whole subnet, i.e. all addresses which have the same value in the most significant \fIn\fR bits. .LP -If the secret starts with an `@', what follows is assumed to be the -name of a file from which to read the secret. A "*" as the client or -server name matches any name. When selecting a secret, pppd takes the +If the +secret starts with an `@', what follows is assumed to be the name of a +file from which to read the secret. A "*" as the client or server +name matches any name. When selecting a secret, \fIpppd\fR takes the best match, i.e. the match with the fewest wildcards. .LP Thus a secrets file contains both secrets for use in authenticating other hosts, plus secrets which we use for authenticating ourselves to -others. When pppd is authenticating the peer (checking the peer's -identity), it chooses a secret with the peer's name in the first -column and the name of the local system in the second column. The -name of the local system defaults to the hostname, with the domain -name appended if the \fIdomain\fR option is used. This default can be -overridden with the \fIname\fR option (unless the \fIusehostname\fR -option is used.) +others. Which secret to use is chosen based on the names of the host +(the `local name') and its peer (the `remote name'). The local name +is set as follows: +.TP 3 +if the \fBusehostname\fR option is given, +then the local name is the hostname of this machine +(with the domain appended, if given) +.TP 3 +else if the \fBname\fR option is given, +then use the argument of the first \fBname\fR option seen +.TP 3 +else if the local IP address is specified with a hostname, +then use that name +.TP 3 +else use the hostname of this machine (with the domain appended, if given) +.LP +When authenticating ourselves using PAP, there is also a `username' +which is the local name by default, but can be set with the \fBuser\fR +option. +.LP +The remote name is set as follows: +.TP 3 +if the \fBremotename\fR option is given, +then use the argument of the last \fBremotename\fR option seen +.TP 3 +else if the remote IP address is specified with a hostname, +then use that host name +.TP 3 +else the remote name is the null string "". .LP -When pppd is choosing a secret to use in authenticating itself to the -peer, it looks for a secret with the local name in the first column -and the name of the remote system in the second column. The local -name is determined as described in the previous paragraph, except that -it may be overridden with the \fIuser\fR option. The remote name will -have been received from the peer if CHAP authentication is being -used. However, with PAP, pppd does not know the remote name at the -time when it has to look for the secret. In this case, it will use -the value given for the \fIremotename\fR option if specified. Failing -that, if the remote IP address was given as a name (rather than in -numeric form), it will use that name. Failing that, it will use the -empty string. +Secrets are selected from the PAP secrets file as follows: +.TP 2 +* +For authenticating the peer, look for a secret with client == +username specified in the PAP authenticate-request, and server == +local name. +.TP 2 +* +For authenticating ourselves to the peer, look for a secret with +client == our username, server == remote name. .LP When authenticating the peer with PAP, a secret of "" matches any password supplied by the peer. If the password doesn't match the secret, the password is encrypted using crypt() and checked against the secret again; thus secrets for authenticating the peer can be -stored in encrypted form. If the \fIpapcrypt\fR option is given, the +stored in encrypted form. If the \fBpapcrypt\fR option is given, the first (unencrypted) comparison is omitted, for better security. .LP -If the \fIlogin\fR option was specified, the username and password are -also checked against the system password database. Thus, the system -administrator can set up the pap-secrets file to allow PPP access only -to certain users, and to restrict the set of IP addresses that each -user can use. Typically, when using the \fIlogin\fR option, the -secret in /etc/ppp/pap-secrets would be "", to avoid the need to have -the same secret in two places. +If the \fBlogin\fR option was specified, the +username and password are also checked against the system password +database. Thus, the system administrator can set up the pap-secrets +file to allow PPP access only to certain users, and to restrict the +set of IP addresses that each user can use. Typically, when using the +\fBlogin\fR option, the secret in /etc/ppp/pap-secrets would be "", to +avoid the need to have the same secret in two places. +.LP +Secrets are selected from the CHAP secrets file as follows: +.TP 2 +* +For authenticating the peer, look for a secret with client == name +specified in the CHAP-Response message, and server == local name. +.TP 2 +* +For authenticating ourselves to the peer, look for a secret with +client == local name, and server == name specified in the +CHAP-Challenge message. .LP Authentication must be satisfactorily completed before IPCP (or any -other Network Control Protocol) can be started. If the peer is -required to authenticate itself, and fails to do so, pppd will -terminated the link (by closing LCP). If IPCP negotiates an -unacceptable IP address for the remote host, IPCP will be closed. IP -packets can only be sent or received when IPCP is open. +other Network Control Protocol) can be started. If authentication +fails, \fIpppd\fR will terminated the link (by closing LCP). If IPCP +negotiates an unacceptable IP address for the remote host, IPCP will +be closed. IP packets can only be sent or received when IPCP is open. .LP In some cases it is desirable to allow some hosts which can't authenticate themselves to connect and use one of a restricted set of IP addresses, even when the local host generally requires authentication. If the peer refuses to authenticate itself when -requested, pppd takes that as equivalent to authenticating with PAP -using the empty string for the username and password. Thus, by adding -a line to the pap-secrets file which specifies the empty string for -the client and password, it is possible to allow restricted access to -hosts which refuse to authenticate themselves. +requested, \fIpppd\fR takes that as equivalent to authenticating with +PAP using the empty string for the username and password. Thus, by +adding a line to the pap-secrets file which specifies the empty string +for the client and password, it is possible to allow restricted access +to hosts which refuse to authenticate themselves. .SH ROUTING .LP -When IPCP negotiation is completed successfully, pppd will inform the -kernel of the local and remote IP addresses for the ppp interface. -This is sufficient to create a host route to the remote end of the -link, which will enable the peers to exchange IP packets. -Communication with other machines generally requires further -modification to routing tables and/or ARP (Address Resolution -Protocol) tables. In some cases this will be done automatically -through the actions of the \fIrouted\fR or \fIgated\fR daemons, but in -most cases some further intervention is required. +When IPCP negotiation is completed successfully, +.I pppd +will inform the kernel of the local and remote IP addresses for the +ppp interface. This is sufficient to create a +host route to the remote end of the link, which will enable the peers +to exchange IP packets. Communication with other machines generally +requires further modification to routing tables and/or ARP (Address +Resolution Protocol) tables. In some cases this will be done +automatically through the actions of the \fIrouted\fR or \fIgated\fR +daemons, but in most cases some further intervention is required. .LP -Sometimes it is desirable to add a default route through the remote -host, as in the case of a machine whose only connection to the -Internet is through the ppp interface. The \fIdefaultroute\fR option -causes pppd to create such a default route when IPCP comes up, and -delete it when the link is terminated. +Sometimes it is desirable +to add a default route through the remote host, as in the case of a +machine whose only connection to the Internet is through the ppp +interface. The \fBdefaultroute\fR option causes \fIpppd\fR to create such a +default route when IPCP comes up, and delete it when the link is +terminated. .LP In some cases it is desirable to use proxy ARP, for example on a server machine connected to a LAN, in order to allow other hosts to -communicate with the remote host. The \fIproxyarp\fR option causes -pppd to look for a network interface on the same subnet as the remote -host (an interface supporting broadcast and ARP, which is up and not a -point-to-point or loopback interface). If found, pppd creates a +communicate with the remote host. The \fBproxyarp\fR option causes \fIpppd\fR +to look for a network interface on the same subnet as the remote host +(an interface supporting broadcast and ARP, which is up and not a +point-to-point or loopback interface). If found, \fIpppd\fR creates a permanent, published ARP entry with the IP address of the remote host and the hardware address of the network interface found. .SH EXAMPLES @@ -759,7 +787,7 @@ isn't dropped), and issue a command like pppd /dev/ttya 9600 .LP The process of logging in to the other machine and starting \fIpppd\fR -can be automated by using the \fIconnect\fR option to run \fIchat\fR, +can be automated by using the \fBconnect\fR option to run \fIchat\fR, for example: .IP pppd /dev/ttya 38400 connect 'chat "" "" "login:" "username" @@ -771,43 +799,44 @@ visible in the parameter list of pppd and chat.) If your serial connection is any more complicated than a piece of wire, you may need to arrange for some control characters to be escaped. In particular, it is often useful to escape XON (^Q) and -XOFF (^S), using \fIasyncmap a0000\fR. If the path includes a telnet, -you probably should escape ^] as well (\fIasyncmap 200a0000\fR). If -the path includes an rlogin, you will need to use the \fIescape ff\fR -option on the end which is running the rlogin client, since many -rlogin implementations are not transparent; they will remove the -sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the -stream. +XOFF (^S), using \fBasyncmap a0000\fR. If the path includes a telnet, +you probably should escape ^] as well (\fBasyncmap 200a0000\fR). +If the path includes an rlogin, you will need to use the \fBescape +ff\fR option on the end which is running the rlogin client, since many +rlogin implementations are not +transparent; they will remove the sequence [0xff, 0xff, 0x73, 0x73, +followed by any 8 bytes] from the stream. .SH DIAGNOSTICS .LP Messages are sent to the syslog daemon using facility LOG_DAEMON. -(This can be overriden by recompiling pppd with the macro +(This can be overriden by recompiling \fIpppd\fR with the macro LOG_PPP defined as the desired facility.) In order to see the error and debug messages, you will need to edit your /etc/syslog.conf file to direct the messages to the desired output device or file. .LP -The \fIdebug\fR option causes the contents of all control packets sent +The \fBdebug\fR option causes the contents of all control packets sent or received to be logged, that is, all LCP, PAP, CHAP or IPCP packets. This can be useful if the PPP negotiation does not succeed. -If debugging is enabled at compile time, the \fIdebug\fR option also +If debugging is enabled at compile time, the \fBdebug\fR option also causes other debugging messages to be logged. .LP -Debugging can also be enabled or disabled by sending a SIGUSR1 signal -to the pppd process. This signal acts as a toggle. +Debugging can also be enabled or disabled by sending a +SIGUSR1 to the +.I pppd +process. This signal acts as a toggle. .SH FILES .TP .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. +Process-ID for \fIpppd\fR process on ppp interface unit \fIn\fR. .TP .B /etc/ppp/auth-up A program or script which is executed after the remote system successfully authenticates itself. It is executed with the parameters .IP \fIinterface-name peer-name user-name tty-device speed\fR -.IP -and with its standard input, output and error redirected to -/dev/null. This program or script is executed with the real and -effective user-IDs set to root, and with an empty environment. +.IP and with its standard input, output and error redirected to +\fB/dev/null\fR. This program or script is executed with the real and +effective user-IDs set to \fBroot\fR, and with an empty environment. .TP .B /etc/ppp/auth-down A program or script which is executed when the link goes down, if @@ -823,16 +852,18 @@ executed with the parameters remote-IP-address ipparam\fR .IP and with its standard input, -output and error streams redirected to /dev/null. +output and error streams redirected to \fB/dev/null\fR. .IP This program or script is executed with the real and effective -user-IDs set to root. This is so that it can be used to manipulate -routes, run privileged daemons (e.g. \fIsendmail\fR), etc. Be -careful that the contents of the /etc/ppp/ip-up and /etc/ppp/ip-down -scripts do not compromise your system's security. +user-IDs set to \fBroot\fR. This is so that it can +be used to manipulate routes, run privileged daemons (e.g. +\fBsendmail\fR), etc. Be careful that the contents of the +/etc/ppp/ip-up and /etc/ppp/ip-down scripts do not compromise your +system's security. .IP This program or script is executed with an empty environment, so you -must either specify a PATH or use full pathnames. +must either specify a PATH or use full pathnames (e.g. \fI/sbin/route\fR, +as opposed to \fIroute\fR). .TP .B /etc/ppp/ip-down A program or script which is executed when the link is no longer @@ -851,7 +882,7 @@ remote-IPX-node-address local-IPX-routing-protocol remote-IPX-routing-protocol local-IPX-router-name remote-IPX-router-name ipparam pppd-pid\fR .IP and with its standard input, -output and error streams redirected to /dev/null. +output and error streams redirected to \fB/dev/null\fR. .br .IP The local-IPX-routing-protocol and remote-IPX-routing-protocol field @@ -867,9 +898,9 @@ RIP NLSP to indicate that both RIP/SAP and NLSP should be used .br .IP This program or script is executed with the real and effective -user-IDs set to root, and with an empty environment. This is so +user-IDs set to \fBroot\fR, and with an empty environment. This is so that it can be used to manipulate routes, run privileged daemons (e.g. -\fIripd\fR), etc. Be careful that the contents of the /etc/ppp/ipx-up +\fBripd\fR), etc. Be careful that the contents of the /etc/ppp/ipx-up and /etc/ppp/ipx-down scripts do not compromise your system's security. .TP @@ -887,11 +918,12 @@ Usernames, passwords and IP addresses for PAP authentication. Names, secrets and IP addresses for CHAP authentication. .TP .B /etc/ppp/options -System default options for pppd, read before user default options or -command-line options. +System default options for +.I pppd, +read before user default options or command-line options. .TP .B ~/.ppprc -User default options, read before /etc/ppp/options.\fIttyname\fR. +User default options, read before command-line options. .TP .B /etc/ppp/options.\fIttyname System default options for the serial port being used, read after @@ -903,7 +935,7 @@ dots. .TP .B RFC1144 Jacobson, V. -\fICompressing TCP/IP headers for low-speed serial links.\fR +.I Compressing TCP/IP headers for low-speed serial links. February 1990. .TP .B RFC1321 @@ -931,28 +963,34 @@ Simpson, W.A. .I PPP in HDLC-like Framing. July 1994. .SH NOTES -The following signals have the specified effect when sent to pppd. +The following signals have the specified effect when sent to the +.I pppd +process. .TP .B SIGINT, SIGTERM -These signals cause pppd to terminate the link (by closing LCP), +These signals cause \fBpppd\fR to terminate the link (by closing LCP), restore the serial device settings, and exit. .TP .B SIGHUP -This signal causes pppd to terminate the link, restore the serial -device settings, and close the serial device. If the \fIpersist\fR or -\fIdemand\fR option has been specified, pppd will try to reopen the -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. +This signal causes \fBpppd\fR to terminate the link, restore the +serial device settings, and close the serial device. If the +\fBpersist\fR option has been specified, \fBpppd\fR will try to reopen +the serial device and start another connection (after the holdoff +period). Otherwise \fBpppd\fR will exit. If this signal is received +during the holdoff period, it causes \fBpppd\fR to end the holdoff +period immediately. .TP .B SIGUSR2 -This signal causes pppd to renegotiate compression. This can be -useful to re-enable compression after it has been disabled as a result -of a fatal decompression error. (Fatal decompression errors generally -indicate a bug in one or other implementation.) +This signal causes +.B pppd +to renegotiate compression. This can be useful to re-enable +compression after it has been disabled as a result of a fatal +decompression error. With the BSD Compress scheme, fatal +decompression errors generally indicate a bug in one or other +implementation. .SH AUTHORS -Paul Mackerras (Paul.Mackerras@cs.anu.edu.au), based on earlier work by +Paul Mackerras (paulus@cs.anu.edu.au), based on earlier work by Drew Perkins, Brad Clements, Karl Fox, -- 2.39.2