Added EAP support with MD5-Challenge and SRP-SHA1 methods. Tested
[ppp.git] / pppd / pppd.8
1 .\" manual page [] for pppd 2.4
2 .\" $Id: pppd.8,v 1.67 2002/11/02 19:48:13 carlsonj Exp $
3 .\" SH section heading
4 .\" SS subsection heading
5 .\" LP paragraph
6 .\" IP indented paragraph
7 .\" TP hanging label
8 .TH PPPD 8
9 .SH NAME
10 pppd \- Point to Point Protocol daemon
11 .SH SYNOPSIS
12 .B pppd
13 [
14 .I tty_name
15 ] [
16 .I speed
17 ] [
18 .I options
19 ]
20 .SH DESCRIPTION
21 .LP
22 The Point-to-Point Protocol (PPP) provides a method for transmitting
23 datagrams over serial point-to-point links.  PPP
24 is composed of three parts: a method for encapsulating datagrams over
25 serial links, an extensible Link Control Protocol (LCP), and
26 a family of Network Control Protocols (NCP) for establishing
27 and configuring different network-layer protocols.
28 .LP
29 The encapsulation scheme is provided by driver code in the kernel.
30 Pppd provides the basic LCP, authentication support, and an NCP for
31 establishing and configuring the Internet Protocol (IP) (called the IP
32 Control Protocol, IPCP).
33 .SH FREQUENTLY USED OPTIONS
34 .TP
35 .I <tty_name>
36 Communicate over the named device.  The string "/dev/" is prepended if
37 necessary.  If no device name is given, or if the name of the terminal
38 connected to the standard input is given, pppd will use that terminal,
39 and will not fork to put itself in the background.  A value for this
40 option from a privileged source cannot be overridden by a
41 non-privileged user.
42 .TP
43 .I <speed>
44 Set the baud rate to <speed> (a decimal number).  On systems such as
45 4.4BSD and NetBSD, any speed can be specified.  Other systems
46 (e.g. SunOS) allow only a limited set of speeds.
47 .TP
48 .B asyncmap \fI<map>
49 Set the async character map to <map>.  This map describes which
50 control characters cannot be successfully received over the serial
51 line.  Pppd will ask the peer to send these characters as a 2-byte
52 escape sequence.  The argument is a 32 bit hex number with each bit
53 representing a character to escape.  Bit 0 (00000001) represents the
54 character 0x00; bit 31 (80000000) represents the character 0x1f or ^_.
55 If multiple \fIasyncmap\fR options are given, the values are ORed
56 together.  If no \fIasyncmap\fR option is given, no async character
57 map will be negotiated for the receive direction; the peer should then
58 escape \fIall\fR control characters.  To escape transmitted
59 characters, use the \fIescape\fR option.
60 .TP
61 .B auth
62 Require the peer to authenticate itself before allowing network
63 packets to be sent or received.  This option is the default if the
64 system has a default route.  If neither this option nor the
65 \fInoauth\fR option is specified, pppd will only allow the peer to use
66 IP addresses to which the system does not already have a route.
67 .TP
68 .B call \fIname
69 Read options from the file /etc/ppp/peers/\fIname\fR.  This file may
70 contain privileged options, such as \fInoauth\fR, even if pppd
71 is not being run by root.  The \fIname\fR string may not begin with /
72 or include .. as a pathname component.  The format of the options file
73 is described below.
74 .TP
75 .B connect \fIscript
76 Use the executable or shell command specified by \fIscript\fR to set
77 up the serial line.  This script would typically use the chat(8)
78 program to dial the modem and start the remote ppp session.  A value
79 for this option from a privileged source cannot be overridden by a
80 non-privileged user.
81 .TP
82 .B crtscts
83 Use hardware flow control (i.e. RTS/CTS) to control the flow of
84 data on the serial port.  If neither the \fIcrtscts\fR, the
85 \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR option
86 is given, the hardware flow control setting for the serial port is
87 left unchanged.
88 Some serial ports (such as Macintosh serial ports) lack a true
89 RTS output. Such serial ports use this mode to implement
90 unidirectional flow control. The serial port will
91 suspend transmission when requested by the modem (via CTS)
92 but will be unable to request the modem stop sending to the
93 computer. This mode retains the ability to use DTR as
94 a modem control line.
95 .TP
96 .B defaultroute
97 Add a default route to the system routing tables, using the peer as
98 the gateway, when IPCP negotiation is successfully completed.
99 This entry is removed when the PPP connection is broken.  This option
100 is privileged if the \fInodefaultroute\fR option has been specified.
101 .TP
102 .B disconnect \fIscript
103 Run the executable or shell command specified by \fIscript\fR after
104 pppd has terminated the link.  This script could, for example, issue
105 commands to the modem to cause it to hang up if hardware modem control
106 signals were not available.  The disconnect script is not run if the
107 modem has already hung up.  A value for this option from a privileged
108 source cannot be overridden by a non-privileged user.
109 .TP
110 .B escape \fIxx,yy,...
111 Specifies that certain characters should be escaped on transmission
112 (regardless of whether the peer requests them to be escaped with its
113 async control character map).  The characters to be escaped are
114 specified as a list of hex numbers separated by commas.  Note that
115 almost any character can be specified for the \fIescape\fR option,
116 unlike the \fIasyncmap\fR option which only allows control characters
117 to be specified.  The characters which may not be escaped are those
118 with hex values 0x20 - 0x3f or 0x5e.
119 .TP
120 .B file \fIname
121 Read options from file \fIname\fR (the format is described below).
122 The file must be readable by the user who has invoked pppd.
123 .TP
124 .B init \fIscript
125 Run the executable or shell command specified by \fIscript\fR to
126 initialize the serial line.  This script would typically use the
127 chat(8) program to configure the modem to enable auto answer.  A value
128 for this option from a privileged source cannot be overridden by a
129 non-privileged user.
130 .TP
131 .B lock
132 Specifies that pppd should create a UUCP-style lock file for the
133 serial device to ensure exclusive access to the device.
134 .TP
135 .B mru \fIn
136 Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd
137 will ask the peer to send packets of no more than \fIn\fR bytes.  The
138 minimum MRU value is 128.  The default MRU value is 1500.  A value of
139 296 is recommended for slow links (40 bytes for TCP/IP header + 256
140 bytes of data).  (Note that for IPv6 MRU must be at least 1280)
141 .TP
142 .B mtu \fIn
143 Set the MTU [Maximum Transmit Unit] value to \fIn\fR.  Unless the
144 peer requests a smaller value via MRU negotiation, pppd will
145 request that the kernel networking code send data packets of no more
146 than \fIn\fR bytes through the PPP network interface.  (Note that for 
147 IPv6 MTU must be at least 1280)
148 .TP
149 .B passive
150 Enables the "passive" option in the LCP.  With this option, pppd will
151 attempt to initiate a connection; if no reply is received from the
152 peer, pppd will then just wait passively for a valid LCP packet from
153 the peer, instead of exiting, as it would without this option.
154 .SH OPTIONS
155 .TP
156 .I <local_IP_address>\fB:\fI<remote_IP_address>
157 Set the local and/or remote interface IP addresses.  Either one may be
158 omitted.  The IP addresses can be specified with a host name or in
159 decimal dot notation (e.g. 150.234.56.78).  The default local
160 address is the (first) IP address of the system (unless the
161 \fInoipdefault\fR
162 option is given).  The remote address will be obtained from the peer
163 if not specified in any option.  Thus, in simple cases, this option is
164 not required.  If a local and/or remote IP address is specified with
165 this option, pppd
166 will not accept a different value from the peer in the IPCP
167 negotiation, unless the \fIipcp-accept-local\fR and/or
168 \fIipcp-accept-remote\fR options are given, respectively.
169 .TP
170 .B ipv6 \fI<local_interface_identifier>\fR,\fI<remote_interface_identifier>
171 Set the local and/or remote 64-bit interface identifier. Either one may be
172 omitted. The identifier must be specified in standard ascii notation of
173 IPv6 addresses (e.g. ::dead:beef). If the
174 \fIipv6cp-use-ipaddr\fR
175 option is given, the local identifier is the local IPv4 address (see above).
176 On systems which supports a unique persistent id, such as EUI-48 derived
177 from the Ethernet MAC address, \fIipv6cp-use-persistent\fR option can be
178 used to replace the \fIipv6 <local>,<remote>\fR option. Otherwise the 
179 identifier is randomized.
180 .TP
181 .B active-filter \fIfilter-expression
182 Specifies a packet filter to be applied to data packets to determine
183 which packets are to be regarded as link activity, and therefore reset
184 the idle timer, or cause the link to be brought up in demand-dialling
185 mode.  This option is useful in conjunction with the
186 \fBidle\fR option if there are packets being sent or received
187 regularly over the link (for example, routing information packets)
188 which would otherwise prevent the link from ever appearing to be idle.
189 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
190 except that qualifiers which are inappropriate for a PPP link, such as
191 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
192 expression should be enclosed in single-quotes to prevent whitespace
193 in the expression from being interpreted by the shell. This option
194 is currently only available under NetBSD or Linux, and then only
195 if both the kernel and pppd were compiled with PPP_FILTER defined.
196 .TP
197 .B allow-ip \fIaddress(es)
198 Allow peers to use the given IP address or subnet without
199 authenticating themselves.  The parameter is parsed as for each
200 element of the list of allowed IP addresses in the secrets files (see
201 the AUTHENTICATION section below).
202 .TP
203 .B allow-number \fInumber
204 Allow peers to connect from the given telephone number.  A trailing
205 `*' character will match all numbers beginning with the leading part.
206 .TP
207 .B bsdcomp \fInr,nt
208 Request that the peer compress packets that it sends, using the
209 BSD-Compress scheme, with a maximum code size of \fInr\fR bits, and
210 agree to compress packets sent to the peer with a maximum code size of
211 \fInt\fR bits.  If \fInt\fR is not specified, it defaults to the value
212 given for \fInr\fR.  Values in the range 9 to 15 may be used for
213 \fInr\fR and \fInt\fR; larger values give better compression but
214 consume more kernel memory for compression dictionaries.
215 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
216 compression in the corresponding direction.  Use \fInobsdcomp\fR or
217 \fIbsdcomp 0\fR to disable BSD-Compress compression entirely.
218 .TP
219 .B cdtrcts
220 Use a non-standard hardware flow control (i.e. DTR/CTS) to control
221 the flow of data on the serial port.  If neither the \fIcrtscts\fR,
222 the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR
223 option is given, the hardware flow control setting for the serial
224 port is left unchanged.
225 Some serial ports (such as Macintosh serial ports) lack a true
226 RTS output. Such serial ports use this mode to implement true
227 bi-directional flow control. The sacrifice is that this flow
228 control mode does not permit using DTR as a modem control line.
229 .TP
230 .B chap-interval \fIn
231 If this option is given, pppd will rechallenge the peer every \fIn\fR
232 seconds.
233 .TP
234 .B chap-max-challenge \fIn
235 Set the maximum number of CHAP challenge transmissions to \fIn\fR
236 (default 10).
237 .TP
238 .B chap-restart \fIn
239 Set the CHAP restart interval (retransmission timeout for challenges)
240 to \fIn\fR seconds (default 3).
241 .TP
242 .B connect-delay \fIn
243 Wait for up \fIn\fR milliseconds after the connect script finishes for
244 a valid PPP packet from the peer.  At the end of this time, or when a
245 valid PPP packet is received from the peer, pppd will commence
246 negotiation by sending its first LCP packet.  The default value is
247 1000 (1 second).  This wait period only applies if the \fBconnect\fR
248 or \fBpty\fR option is used.
249 .TP
250 .B debug
251 Enables connection debugging facilities.
252 If this option is given, pppd will log the contents of all
253 control packets sent or received in a readable form.  The packets are
254 logged through syslog with facility \fIdaemon\fR and level
255 \fIdebug\fR.  This information can be directed to a file by setting up
256 /etc/syslog.conf appropriately (see syslog.conf(5)).
257 .TP
258 .B default-asyncmap
259 Disable asyncmap negotiation, forcing all control characters to be
260 escaped for both the transmit and the receive direction.
261 .TP
262 .B default-mru
263 Disable MRU [Maximum Receive Unit] negotiation.  With this option,
264 pppd will use the default MRU value of 1500 bytes for both the
265 transmit and receive direction.
266 .TP
267 .B deflate \fInr,nt
268 Request that the peer compress packets that it sends, using the
269 Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
270 agree to compress packets sent to the peer with a maximum window size
271 of \fI2**nt\fR bytes.  If \fInt\fR is not specified, it defaults to
272 the value given for \fInr\fR.  Values in the range 9 to 15 may be used
273 for \fInr\fR and \fInt\fR; larger values give better compression but
274 consume more kernel memory for compression dictionaries.
275 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
276 compression in the corresponding direction.  Use \fInodeflate\fR or
277 \fIdeflate 0\fR to disable Deflate compression entirely.  (Note: pppd
278 requests Deflate compression in preference to BSD-Compress if the peer
279 can do either.)
280 .TP
281 .B demand
282 Initiate the link only on demand, i.e. when data traffic is present.
283 With this option, the remote IP address must be specified by the user
284 on the command line or in an options file.  Pppd will initially
285 configure the interface and enable it for IP traffic without
286 connecting to the peer.  When traffic is available, pppd will
287 connect to the peer and perform negotiation, authentication, etc.
288 When this is completed, pppd will commence passing data packets
289 (i.e., IP packets) across the link.
290
291 The \fIdemand\fR option implies the \fIpersist\fR option.  If this
292 behaviour is not desired, use the \fInopersist\fR option after the
293 \fIdemand\fR option.  The \fIidle\fR and \fIholdoff\fR
294 options are also useful in conjuction with the \fIdemand\fR option.
295 .TP
296 .B domain \fId
297 Append the domain name \fId\fR to the local host name for authentication
298 purposes.  For example, if gethostname() returns the name porsche, but
299 the fully qualified domain name is porsche.Quotron.COM, you could
300 specify \fIdomain Quotron.COM\fR.  Pppd would then use the name
301 \fIporsche.Quotron.COM\fR for looking up secrets in the secrets file,
302 and as the default name to send to the peer when authenticating itself
303 to the peer.  This option is privileged.
304 .TP
305 .B dryrun
306 With the \fBdryrun\fR option, pppd will print out all the option
307 values which have been set and then exit, after parsing the command
308 line and options files and checking the option values, but before
309 initiating the link.  The option values are logged at level info, and
310 also printed to standard output unless the device on standard output
311 is the device that pppd would be using to communicate with the peer.
312 .TP
313 .B dump
314 With the \fBdump\fR option, pppd will print out all the option values
315 which have been set.  This option is like the \fBdryrun\fR option
316 except that pppd proceeds as normal rather than exiting.
317 .TP
318 .B endpoint \fI<epdisc>
319 Sets the endpoint discriminator sent by the local machine to the peer
320 during multilink negotiation to \fI<epdisc>\fR.  The default is to use
321 the MAC address of the first ethernet interface on the system, if any,
322 otherwise the IPv4 address corresponding to the hostname, if any,
323 provided it is not in the multicast or locally-assigned IP address
324 ranges, or the localhost address.  The endpoint discriminator can be
325 the string \fBnull\fR or of the form \fItype\fR:\fIvalue\fR, where
326 type is a decimal number or one of the strings \fBlocal\fR, \fBIP\fR,
327 \fBMAC\fR, \fBmagic\fR, or \fBphone\fR.  The value is an IP address in
328 dotted-decimal notation for the \fBIP\fR type, or a string of bytes in
329 hexadecimal, separated by periods or colons for the other types.  For
330 the MAC type, the value may also be the name of an ethernet or similar
331 network interface.  This option is currently only available under
332 Linux.
333 .TP
334 .B eap-interval \fIn
335 If this option is given and pppd authenticates the peer with EAP
336 (i.e., is the server), pppd will restart EAP authentication every
337 \fIn\fR seconds.  For EAP SRP-SHA1, see also the \fBsrp-interval\fR
338 option, which enables lightweight rechallenge.
339 .TP
340 .B eap-max-rreq \fIn
341 Set the maximum number of EAP Requests to which pppd will respond (as
342 a client) without hearing EAP Success or Failure.  (Default is 20.)
343 .TP
344 .B eap-max-sreq \fIn
345 Set the maximum number of EAP Requests that pppd will issue (as a
346 server) while attempting authentication.  (Default is 10.)
347 .TP
348 .B eap-restart \fIn
349 Set the retransmit timeout for EAP Requests when acting as a server
350 (authenticator).  (Default is 3 seconds.)
351 .TP
352 .B eap-timeout \fIn
353 Set the maximum time to wait for the peer to send an EAP Request when
354 acting as a client (authenticatee).  (Default is 20 seconds.)
355 .TP
356 .B hide-password
357 When logging the contents of PAP packets, this option causes pppd to
358 exclude the password string from the log.  This is the default.
359 .TP
360 .B holdoff \fIn
361 Specifies how many seconds to wait before re-initiating the link after
362 it terminates.  This option only has any effect if the \fIpersist\fR
363 or \fIdemand\fR option is used.  The holdoff period is not applied if
364 the link was terminated because it was idle.
365 .TP
366 .B idle \fIn
367 Specifies that pppd should disconnect if the link is idle for \fIn\fR
368 seconds.  The link is idle when no data packets (i.e. IP packets) are
369 being sent or received.  Note: it is not advisable to use this option
370 with the \fIpersist\fR option without the \fIdemand\fR option.
371 If the \fBactive-filter\fR
372 option is given, data packets which are rejected by the specified
373 activity filter also count as the link being idle.
374 .TP
375 .B ipcp-accept-local
376 With this option, pppd will accept the peer's idea of our local IP
377 address, even if the local IP address was specified in an option.
378 .TP
379 .B ipcp-accept-remote
380 With this option, pppd will accept the peer's idea of its (remote) IP
381 address, even if the remote IP address was specified in an option.
382 .TP
383 .B ipcp-max-configure \fIn
384 Set the maximum number of IPCP configure-request transmissions to
385 \fIn\fR (default 10).
386 .TP
387 .B ipcp-max-failure \fIn
388 Set the maximum number of IPCP configure-NAKs returned before starting
389 to send configure-Rejects instead to \fIn\fR (default 10).
390 .TP
391 .B ipcp-max-terminate \fIn
392 Set the maximum number of IPCP terminate-request transmissions to
393 \fIn\fR (default 3).
394 .TP
395 .B ipcp-restart \fIn
396 Set the IPCP restart interval (retransmission timeout) to \fIn\fR
397 seconds (default 3).
398 .TP
399 .B ipparam \fIstring
400 Provides an extra parameter to the ip-up and ip-down scripts.  If this
401 option is given, the \fIstring\fR supplied is given as the 6th
402 parameter to those scripts.
403 .TP
404 .B ipv6cp-max-configure \fIn
405 Set the maximum number of IPv6CP configure-request transmissions to
406 \fIn\fR (default 10).
407 .TP
408 .B ipv6cp-max-failure \fIn
409 Set the maximum number of IPv6CP configure-NAKs returned before starting
410 to send configure-Rejects instead to \fIn\fR (default 10).
411 .TP
412 .B ipv6cp-max-terminate \fIn
413 Set the maximum number of IPv6CP terminate-request transmissions to
414 \fIn\fR (default 3).
415 .TP
416 .B ipv6cp-restart \fIn
417 Set the IPv6CP restart interval (retransmission timeout) to \fIn\fR
418 seconds (default 3).
419 .TP
420 .B ipx
421 Enable the IPXCP and IPX protocols.  This option is presently only
422 supported under Linux, and only if your kernel has been configured to
423 include IPX support.
424 .TP
425 .B ipx-network \fIn
426 Set the IPX network number in the IPXCP configure request frame to
427 \fIn\fR, a hexadecimal number (without a leading 0x).  There is no
428 valid default.  If this option is not specified, the network number is
429 obtained from the peer.  If the peer does not have the network number,
430 the IPX protocol will not be started.
431 .TP
432 .B ipx-node \fIn\fB:\fIm
433 Set the IPX node numbers. The two node numbers are separated from each
434 other with a colon character. The first number \fIn\fR is the local
435 node number. The second number \fIm\fR is the peer's node number. Each
436 node number is a hexadecimal number, at most 10 digits long. The node
437 numbers on the ipx-network must be unique. There is no valid
438 default. If this option is not specified then the node numbers are
439 obtained from the peer.
440 .TP
441 .B ipx-router-name \fI<string>
442 Set the name of the router. This is a string and is sent to the peer
443 as information data.
444 .TP
445 .B ipx-routing \fIn
446 Set the routing protocol to be received by this option. More than one
447 instance of \fIipx-routing\fR may be specified. The '\fInone\fR'
448 option (0) may be specified as the only instance of ipx-routing. The
449 values may be \fI0\fR for \fINONE\fR, \fI2\fR for \fIRIP/SAP\fR, and
450 \fI4\fR for \fINLSP\fR.
451 .TP
452 .B ipxcp-accept-local
453 Accept the peer's NAK for the node number specified in the ipx-node
454 option. If a node number was specified, and non-zero, the default is
455 to insist that the value be used. If you include this option then you
456 will permit the peer to override the entry of the node number.
457 .TP
458 .B ipxcp-accept-network
459 Accept the peer's NAK for the network number specified in the
460 ipx-network option. If a network number was specified, and non-zero, the
461 default is to insist that the value be used. If you include this
462 option then you will permit the peer to override the entry of the node
463 number.
464 .TP
465 .B ipxcp-accept-remote
466 Use the peer's network number specified in the configure request
467 frame. If a node number was specified for the peer and this option was
468 not specified, the peer will be forced to use the value which you have
469 specified.
470 .TP
471 .B ipxcp-max-configure \fIn
472 Set the maximum number of IPXCP configure request frames which the
473 system will send to \fIn\fR. The default is 10.
474 .TP
475 .B ipxcp-max-failure \fIn
476 Set the maximum number of IPXCP NAK frames which the local system will
477 send before it rejects the options. The default value is 3.
478 .TP
479 .B ipxcp-max-terminate \fIn
480 Set the maximum nuber of IPXCP terminate request frames before the
481 local system considers that the peer is not listening to them. The
482 default value is 3.
483 .TP
484 .B kdebug \fIn
485 Enable debugging code in the kernel-level PPP driver.  The argument
486 values depend on the specific kernel driver, but in general a value of
487 1 will enable general kernel debug messages.  (Note that these
488 messages are usually only useful for debugging the kernel driver
489 itself.)  For the Linux 2.2.x kernel driver, the value is a sum of
490 bits: 1 to
491 enable general debug messages, 2 to request that the contents of
492 received packets be printed, and 4 to request that the contents of
493 transmitted packets be printed.  On most systems, messages printed by
494 the kernel are logged by syslog(1) to a file as directed in the
495 /etc/syslog.conf configuration file.
496 .TP
497 .B ktune
498 Enables pppd to alter kernel settings as appropriate.  Under Linux,
499 pppd will enable IP forwarding (i.e. set /proc/sys/net/ipv4/ip_forward
500 to 1) if the \fIproxyarp\fR option is used, and will enable the
501 dynamic IP address option (i.e. set /proc/sys/net/ipv4/ip_dynaddr to
502 1) in demand mode if the local address changes.
503 .TP
504 .B lcp-echo-failure \fIn
505 If this option is given, pppd will presume the peer to be dead
506 if \fIn\fR LCP echo-requests are sent without receiving a valid LCP
507 echo-reply.  If this happens, pppd will terminate the
508 connection.  Use of this option requires a non-zero value for the
509 \fIlcp-echo-interval\fR parameter.  This option can be used to enable
510 pppd to terminate after the physical connection has been broken
511 (e.g., the modem has hung up) in situations where no hardware modem
512 control lines are available.
513 .TP
514 .B lcp-echo-interval \fIn
515 If this option is given, pppd will send an LCP echo-request frame to
516 the peer every \fIn\fR seconds.  Normally the peer should respond to
517 the echo-request by sending an echo-reply.  This option can be used
518 with the \fIlcp-echo-failure\fR option to detect that the peer is no
519 longer connected.
520 .TP
521 .B lcp-max-configure \fIn
522 Set the maximum number of LCP configure-request transmissions to
523 \fIn\fR (default 10).
524 .TP
525 .B lcp-max-failure \fIn
526 Set the maximum number of LCP configure-NAKs returned before starting
527 to send configure-Rejects instead to \fIn\fR (default 10).
528 .TP
529 .B lcp-max-terminate \fIn
530 Set the maximum number of LCP terminate-request transmissions to
531 \fIn\fR (default 3).
532 .TP
533 .B lcp-restart \fIn
534 Set the LCP restart interval (retransmission timeout) to \fIn\fR
535 seconds (default 3).
536 .TP
537 .B linkname \fIname\fR
538 Sets the logical name of the link to \fIname\fR.  Pppd will create a
539 file named \fBppp-\fIname\fB.pid\fR in /var/run (or /etc/ppp on some
540 systems) containing its process ID.  This can be useful in determining
541 which instance of pppd is responsible for the link to a given peer
542 system.  This is a privileged option.
543 .TP
544 .B local
545 Don't use the modem control lines.  With this option, pppd will ignore
546 the state of the CD (Carrier Detect) signal from the modem and will
547 not change the state of the DTR (Data Terminal Ready) signal.
548 .TP
549 .B logfd \fIn
550 Send log messages to file descriptor \fIn\fR.  Pppd will send log
551 messages to at most one file or file descriptor (as well as sending
552 the log messages to syslog), so this option and the \fBlogfile\fR
553 option are mutually exclusive.  The default is for pppd to send log
554 messages to stdout (file descriptor 1), unless the serial port is
555 already open on stdout.
556 .TP
557 .B logfile \fIfilename
558 Append log messages to the file \fIfilename\fR (as well as sending the
559 log messages to syslog).  The file is opened with the privileges of
560 the user who invoked pppd, in append mode.
561 .TP
562 .B login
563 Use the system password database for authenticating the peer using
564 PAP, and record the user in the system wtmp file.  Note that the peer
565 must have an entry in the /etc/ppp/pap-secrets file as well as the
566 system password database to be allowed access.
567 .TP
568 .B maxconnect \fIn
569 Terminate the connection when it has been available for network
570 traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first
571 network control protocol comes up).
572 .TP
573 .B maxfail \fIn
574 Terminate after \fIn\fR consecutive failed connection attempts.  A
575 value of 0 means no limit.  The default value is 10.
576 .TP
577 .B modem
578 Use the modem control lines.  This option is the default.  With this
579 option, pppd will wait for the CD (Carrier Detect) signal from the
580 modem to be asserted when opening the serial device (unless a connect
581 script is specified), and it will drop the DTR (Data Terminal Ready)
582 signal briefly when the connection is terminated and before executing
583 the connect script.  On Ultrix, this option implies hardware flow
584 control, as for the \fIcrtscts\fR option.
585 .TP
586 .B mp
587 Enables the use of PPP multilink; this is an alias for the `multilink'
588 option.  This option is currently only available under Linux.
589 .TP
590 .B mppe-stateful
591 Allow MPPE to use stateful mode.  Stateless mode is still attempted first.
592 The default is to disallow stateful mode.  
593 .TP
594 .B mpshortseq
595 Enables the use of short (12-bit) sequence numbers in multilink
596 headers, as opposed to 24-bit sequence numbers.  This option is only
597 available under Linux, and only has any effect if multilink is
598 enabled (see the multilink option).
599 .TP
600 .B mrru \fIn
601 Sets the Maximum Reconstructed Receive Unit to \fIn\fR.  The MRRU is
602 the maximum size for a received packet on a multilink bundle, and is
603 analogous to the MRU for the individual links.  This option is
604 currently only available under Linux, and only has any effect if
605 multilink is enabled (see the multilink option).
606 .TP
607 .B ms-dns \fI<addr>
608 If pppd is acting as a server for Microsoft Windows clients, this
609 option allows pppd to supply one or two DNS (Domain Name Server)
610 addresses to the clients.  The first instance of this option specifies
611 the primary DNS address; the second instance (if given) specifies the
612 secondary DNS address.  (This option was present in some older
613 versions of pppd under the name \fBdns-addr\fR.)
614 .TP
615 .B ms-wins \fI<addr>
616 If pppd is acting as a server for Microsoft Windows or "Samba"
617 clients, this option allows pppd to supply one or two WINS (Windows
618 Internet Name Services) server addresses to the clients.  The first
619 instance of this option specifies the primary WINS address; the second
620 instance (if given) specifies the secondary WINS address.
621 .TP
622 .B multilink
623 Enables the use of the PPP multilink protocol.  If the peer also
624 supports multilink, then this link can become part of a bundle between
625 the local system and the peer.  If there is an existing bundle to the
626 peer, pppd will join this link to that bundle, otherwise pppd will
627 create a new bundle.  See the MULTILINK section below.  This option is
628 currently only available under Linux.
629 .TP
630 .B name \fIname
631 Set the name of the local system for authentication purposes to
632 \fIname\fR.  This is a privileged option.  With this option, pppd will
633 use lines in the secrets files which have \fIname\fR as the second
634 field when looking for a secret to use in authenticating the peer.  In
635 addition, unless overridden with the \fIuser\fR option, \fIname\fR
636 will be used as the name to send to the peer when authenticating the
637 local system to the peer.  (Note that pppd does not append the domain
638 name to \fIname\fR.)
639 .TP
640 .B netmask \fIn
641 Set the interface netmask to \fIn\fR, a 32 bit netmask in "decimal dot"
642 notation (e.g. 255.255.255.0).  If this option is given, the value
643 specified is ORed with the default netmask.  The default netmask is
644 chosen based on the negotiated remote IP address; it is the
645 appropriate network mask for the class of the remote IP address, ORed
646 with the netmasks for any non point-to-point network interfaces in the
647 system which are on the same network.  (Note: on some platforms, pppd
648 will always use 255.255.255.255 for the netmask, if that is the only
649 appropriate value for a point-to-point interface.)
650 .TP
651 .B noaccomp
652 Disable Address/Control compression in both directions (send and
653 receive).
654 .TP
655 .B noauth
656 Do not require the peer to authenticate itself.  This option is
657 privileged.
658 .TP
659 .B nobsdcomp
660 Disables BSD-Compress compression; \fBpppd\fR will not request or
661 agree to compress packets using the BSD-Compress scheme.
662 .TP
663 .B noccp
664 Disable CCP (Compression Control Protocol) negotiation.  This option
665 should only be required if the peer is buggy and gets confused by
666 requests from pppd for CCP negotiation.
667 .TP
668 .B nocrtscts
669 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
670 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the
671 \fIcdtrcts\fR nor the \fInocdtrcts\fR option is given, the hardware
672 flow control setting for the serial port is left unchanged.
673 .TP
674 .B nocdtrcts
675 This option is a synonym for \fInocrtscts\fR. Either of these options will
676 disable both forms of hardware flow control.
677 .TP
678 .B nodefaultroute
679 Disable the \fIdefaultroute\fR option.  The system administrator who
680 wishes to prevent users from creating default routes with pppd
681 can do so by placing this option in the /etc/ppp/options file.
682 .TP
683 .B nodeflate
684 Disables Deflate compression; pppd will not request or agree to
685 compress packets using the Deflate scheme.
686 .TP
687 .B nodetach
688 Don't detach from the controlling terminal.  Without this option, if a
689 serial device other than the terminal on the standard input is
690 specified, pppd will fork to become a background process.
691 .TP
692 .B noendpoint
693 Disables pppd from sending an endpoint discriminator to the peer or
694 accepting one from the peer (see the MULTILINK section below).  This
695 option should only be required if the peer is buggy.
696 .TP
697 .B noip
698 Disable IPCP negotiation and IP communication.  This option should
699 only be required if the peer is buggy and gets confused by requests
700 from pppd for IPCP negotiation.
701 .TP
702 .B noipv6
703 Disable IPv6CP negotiation and IPv6 communication. This option should
704 only be required if the peer is buggy and gets confused by requests
705 from pppd for IPv6CP negotiation.
706 .TP
707 .B noipdefault
708 Disables the default behaviour when no local IP address is specified,
709 which is to determine (if possible) the local IP address from the
710 hostname.  With this option, the peer will have to supply the local IP
711 address during IPCP negotiation (unless it specified explicitly on the
712 command line or in an options file).
713 .TP
714 .B noipx
715 Disable the IPXCP and IPX protocols.  This option should only be
716 required if the peer is buggy and gets confused by requests from pppd
717 for IPXCP negotiation.
718 .TP
719 .B noktune
720 Opposite of the \fIktune\fR option; disables pppd from changing system
721 settings.
722 .TP
723 .B nolog
724 Do not send log messages to a file or file descriptor.  This option
725 cancels the \fBlogfd\fR and \fBlogfile\fR options.
726 .TP
727 .B nomagic
728 Disable magic number negotiation.  With this option, pppd cannot
729 detect a looped-back line.  This option should only be needed if the
730 peer is buggy.
731 .TP
732 .B nomp
733 Disables the use of PPP multilink.  This option is currently only
734 available under Linux.
735 .TP
736 .B nomppe
737 Disables MPPE (Microsoft Point to Point Encryption).  This is the default.
738 .TP
739 .B nomppe-40
740 Disable 40\-bit encryption with MPPE.
741 .TP
742 .B nomppe-128
743 Disable 128\-bit encryption with MPPE.
744 .TP
745 .B nomppe-stateful
746 Disable MPPE stateful mode.  This is the default.
747 .TP
748 .B nompshortseq
749 Disables the use of short (12-bit) sequence numbers in the PPP
750 multilink protocol, forcing the use of 24-bit sequence numbers.  This
751 option is currently only available under Linux, and only has any
752 effect if multilink is enabled.
753 .TP
754 .B nomultilink
755 Disables the use of PPP multilink.  This option is currently only
756 available under Linux.
757 .TP
758 .B nopcomp
759 Disable protocol field compression negotiation in both the receive and
760 the transmit direction.
761 .TP
762 .B nopersist
763 Exit once a connection has been made and terminated.  This is the
764 default unless the \fIpersist\fR or \fIdemand\fR option has been
765 specified.
766 .TP
767 .B nopredictor1
768 Do not accept or agree to Predictor-1 compression.
769 .TP
770 .B noproxyarp
771 Disable the \fIproxyarp\fR option.  The system administrator who
772 wishes to prevent users from creating proxy ARP entries with pppd can
773 do so by placing this option in the /etc/ppp/options file.
774 .TP
775 .B notty
776 Normally, pppd requires a terminal device.  With this option, pppd
777 will allocate itself a pseudo-tty master/slave pair and use the slave
778 as its terminal device.  Pppd will create a child process to act as a
779 `character shunt' to transfer characters between the pseudo-tty master
780 and its standard input and output.  Thus pppd will transmit characters
781 on its standard output and receive characters on its standard input
782 even if they are not terminal devices.  This option increases the
783 latency and CPU overhead of transferring data over the ppp interface
784 as all of the characters sent and received must flow through the
785 character shunt process.  An explicit device name may not be given if
786 this option is used.
787 .TP
788 .B novj
789 Disable Van Jacobson style TCP/IP header compression in both the
790 transmit and the receive direction.
791 .TP
792 .B novjccomp
793 Disable the connection-ID compression option in Van Jacobson style
794 TCP/IP header compression.  With this option, pppd will not omit the
795 connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
796 ask the peer to do so.
797 .TP
798 .B papcrypt
799 Indicates that all secrets in the /etc/ppp/pap-secrets file which are
800 used for checking the identity of the peer are encrypted, and thus
801 pppd should not accept a password which, before encryption, is
802 identical to the secret from the /etc/ppp/pap-secrets file.
803 .TP
804 .B pap-max-authreq \fIn
805 Set the maximum number of PAP authenticate-request transmissions to
806 \fIn\fR (default 10).
807 .TP
808 .B pap-restart \fIn
809 Set the PAP restart interval (retransmission timeout) to \fIn\fR
810 seconds (default 3).
811 .TP
812 .B pap-timeout \fIn
813 Set the maximum time that pppd will wait for the peer to authenticate
814 itself with PAP to \fIn\fR seconds (0 means no limit).
815 .TP
816 .B pass-filter \fIfilter-expression
817 Specifies a packet filter to applied to data packets being sent or
818 received to determine which packets should be allowed to pass.
819 Packets which are rejected by the filter are silently discarded.  This
820 option can be used to prevent specific network daemons (such as
821 routed) using up link bandwidth, or to provide a basic firewall
822 capability.
823 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
824 except that qualifiers which are inappropriate for a PPP link, such as
825 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
826 expression should be enclosed in single-quotes to prevent whitespace
827 in the expression from being interpreted by the shell.  Note that it
828 is possible to apply different constraints to incoming and outgoing
829 packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. This
830 option is currently only available under NetBSD, and then only if both
831 the kernel and pppd were compiled with PPP_FILTER defined.
832 .TP
833 .B persist
834 Do not exit after a connection is terminated; instead try to reopen
835 the connection. The \fBmaxfail\fR option still has an effect on
836 persistent connections.
837 .TP
838 .B plugin \fIfilename
839 Load the shared library object file \fIfilename\fR as a plugin.  This
840 is a privileged option.  If \fIfilename\fR does not contain a slash
841 (/), pppd will look in the \fB/usr/lib/pppd/\fIversion\fR directory
842 for the plugin, where
843 \fIversion\fR is the version number of pppd (for example, 2.4.2).
844 .TP
845 .B predictor1
846 Request that the peer compress frames that it sends using Predictor-1
847 compression, and agree to compress transmitted frames with Predictor-1
848 if requested.  This option has no effect unless the kernel driver
849 supports Predictor-1 compression.
850 .TP
851 .B privgroup \fIgroup-name
852 Allows members of group \fIgroup-name\fR to use privileged options.
853 This is a privileged option.  Use of this option requires care as
854 there is no guarantee that members of \fIgroup-name\fR cannot use pppd
855 to become root themselves.  Consider it equivalent to putting the
856 members of \fIgroup-name\fR in the kmem or disk group.
857 .TP
858 .B proxyarp
859 Add an entry to this system's ARP [Address Resolution Protocol] table
860 with the IP address of the peer and the Ethernet address of this
861 system.  This will have the effect of making the peer appear to other
862 systems to be on the local ethernet.
863 .TP
864 .B pty \fIscript
865 Specifies that the command \fIscript\fR is to be used to communicate
866 rather than a specific terminal device.  Pppd will allocate itself a
867 pseudo-tty master/slave pair and use the slave as its terminal
868 device.  The \fIscript\fR will be run in a child process with the
869 pseudo-tty master as its standard input and output.  An explicit
870 device name may not be given if this option is used.  (Note: if the
871 \fIrecord\fR option is used in conjuction with the \fIpty\fR option,
872 the child process will have pipes on its standard input and output.)
873 .TP
874 .B receive-all
875 With this option, pppd will accept all control characters from the
876 peer, including those marked in the receive asyncmap.  Without this
877 option, pppd will discard those characters as specified in RFC1662.
878 This option should only be needed if the peer is buggy.
879 .TP
880 .B record \fIfilename
881 Specifies that pppd should record all characters sent and received to
882 a file named \fIfilename\fR.  This file is opened in append mode,
883 using the user's user-ID and permissions.  This option is implemented
884 using a pseudo-tty and a process to transfer characters between the
885 pseudo-tty and the real serial device, so it will increase the latency
886 and CPU overhead of transferring data over the ppp interface.  The
887 characters are stored in a tagged format with timestamps, which can be
888 displayed in readable form using the pppdump(8) program.
889 .TP
890 .B remotename \fIname
891 Set the assumed name of the remote system for authentication purposes
892 to \fIname\fR.
893 .TP
894 .B remotenumber \fInumber
895 Set the assumed telephone number of the remote system for authentication
896 purposes to \fInumber\fR.
897 .TP
898 .B refuse-chap
899 With this option, pppd will not agree to authenticate itself to the
900 peer using CHAP.
901 .TP
902 .B refuse-mschap
903 With this option, pppd will not agree to authenticate itself to the
904 peer using MS-CHAP.
905 .TP
906 .B refuse-mschap-v2
907 With this option, pppd will not agree to authenticate itself to the
908 peer using MS-CHAPv2.
909 .TP
910 .B refuse-eap
911 With this option, pppd will not agree to authenticate itself to the
912 peer using EAP.
913 .TP
914 .B refuse-pap
915 With this option, pppd will not agree to authenticate itself to the
916 peer using PAP.
917 .TP
918 .B require-chap
919 Require the peer to authenticate itself using CHAP [Challenge
920 Handshake Authentication Protocol] authentication.
921 .TP
922 .B require-mppe
923 Require the use of MPPE (Microsoft Point to Point Encryption).  This
924 option disables all other compression types.  This option enables
925 both 40\-bit and 128\-bit encryption.  In order for MPPE to successfully
926 come up, you must have authenticated with either MS-CHAP or MS-CHAPv2.
927 This option is presently only supported under Linux, and only if your
928 kernel has been configured to include MPPE support.
929 .TP
930 .B require-mppe-40
931 Require the use of MPPE, with 40\-bit encryption.
932 .TP
933 .B require-mppe-128
934 Require the use of MPPE, with 128\-bit encryption.
935 .TP
936 .B require-mschap
937 Require the peer to authenticate itself using MS-CHAP [Microsft Challenge
938 Handshake Authentication Protocol] authentication.
939 .TP
940 .B require-mschap-v2
941 Require the peer to authenticate itself using MS-CHAPv2 [Microsft Challenge
942 Handshake Authentication Protocol, Version 2] authentication.
943 .TP
944 .B require-eap
945 Require the peer to authenticate itself using EAP [Extensible
946 Authentication Protocol] authentication.
947 .TP
948 .B require-pap
949 Require the peer to authenticate itself using PAP [Password
950 Authentication Protocol] authentication.
951 .TP
952 .B show-password
953 When logging the contents of PAP packets, this option causes pppd to
954 show the password string in the log message.
955 .TP
956 .B silent
957 With this option, pppd will not transmit LCP packets to initiate a
958 connection until a valid LCP packet is received from the peer (as for
959 the `passive' option with ancient versions of pppd).
960 .TP
961 .B srp-interval \fIn
962 If this parameter is given and pppd uses EAP SRP-SHA1 to authenticate
963 the peer (i.e., is the server), then pppd will use the optional
964 lightweight SRP rechallenge mechanism at intervals of \fIn\fR
965 seconds.  This option is faster than \fBeap-interval\fR
966 reauthentication because it uses a hash-based mechanism and does not
967 derive a new session key.
968 .TP
969 .B srp-pn-secret \fIstring
970 Set the long-term pseudonym-generating secret for the server.  This
971 value is optional and if set, needs to be known at the server
972 (authenticator) side only, and should be different for each server (or
973 poll of identical servers).  It is used along with the current date to
974 generate a key to encrypt and decrypt the client's identity contained
975 in the pseudonym.
976 .TP
977 .B srp-use-pseudonym
978 When operating as an EAP SRP-SHA1 client, attempt to use the pseudonym
979 stored in ~/.ppp_psuedonym first as the identity, and save in this
980 file any pseudonym offered by the peer during authentication.
981 .TP
982 .B sync
983 Use synchronous HDLC serial encoding instead of asynchronous.
984 The device used by pppd with this option must have sync support.
985 Currently supports Microgate SyncLink adapters
986 under Linux and FreeBSD 2.2.8 and later.
987 .TP
988 .B updetach
989 With this option, pppd will detach from its controlling terminal once
990 it has successfully established the ppp connection (to the point where
991 the first network control protocol, usually the IP control protocol,
992 has come up).
993 .TP
994 .B usehostname
995 Enforce the use of the hostname (with domain name appended, if given)
996 as the name of the local system for authentication purposes (overrides
997 the \fIname\fR option).  This option is not normally needed since the
998 \fIname\fR option is privileged.
999 .TP
1000 .B usepeerdns
1001 Ask the peer for up to 2 DNS server addresses.  The addresses supplied
1002 by the peer (if any) are passed to the /etc/ppp/ip-up script in the
1003 environment variables DNS1 and DNS2.  In addition, pppd will create an
1004 /etc/ppp/resolv.conf file containing one or two nameserver lines with
1005 the address(es) supplied by the peer.
1006 .TP
1007 .B user \fIname
1008 Sets the name used for authenticating the local system to the peer to
1009 \fIname\fR.
1010 .TP
1011 .B vj-max-slots \fIn
1012 Sets the number of connection slots to be used by the Van Jacobson
1013 TCP/IP header compression and decompression code to \fIn\fR, which
1014 must be between 2 and 16 (inclusive).
1015 .TP
1016 .B welcome \fIscript
1017 Run the executable or shell command specified by \fIscript\fR before
1018 initiating PPP negotiation, after the connect script (if any) has
1019 completed.  A value for this option from a privileged source cannot be
1020 overridden by a non-privileged user.
1021 .TP
1022 .B xonxoff
1023 Use software flow control (i.e. XON/XOFF) to control the flow of data on
1024 the serial port.
1025 .SH OPTIONS FILES
1026 Options can be taken from files as well as the command line.  Pppd
1027 reads options from the files /etc/ppp/options, ~/.ppprc and
1028 /etc/ppp/options.\fIttyname\fR (in that order) before processing the
1029 options on the command line.  (In fact, the command-line options are
1030 scanned to find the terminal name before the options.\fIttyname\fR
1031 file is read.)  In forming the name of the options.\fIttyname\fR file,
1032 the initial /dev/ is removed from the terminal name, and any remaining
1033 / characters are replaced with dots.
1034 .PP
1035 An options file is parsed into a series of words, delimited by
1036 whitespace.  Whitespace can be included in a word by enclosing the
1037 word in double-quotes (").  A backslash (\\) quotes the following character.
1038 A hash (#) starts a comment, which continues until the end of the
1039 line.  There is no restriction on using the \fIfile\fR or \fIcall\fR
1040 options within an options file.
1041 .SH SECURITY
1042 .I pppd
1043 provides system administrators with sufficient access control that PPP
1044 access to a server machine can be provided to legitimate users without
1045 fear of compromising the security of the server or the network it's
1046 on.  This control is provided through restrictions on which IP
1047 addresses the peer may use, based on its authenticated identity (if
1048 any), and through restrictions on which options a non-privileged user
1049 may use.  Several of pppd's options are privileged, in particular
1050 those which permit potentially insecure configurations; these options
1051 are only accepted in files which are under the control of the system
1052 administrator, or if pppd is being run by root.
1053 .PP
1054 The default behaviour of pppd is to allow an unauthenticated peer to
1055 use a given IP address only if the system does not already have a
1056 route to that IP address.  For example, a system with a
1057 permanent connection to the wider internet will normally have a
1058 default route, and thus all peers will have to authenticate themselves
1059 in order to set up a connection.  On such a system, the \fIauth\fR
1060 option is the default.  On the other hand, a system where the
1061 PPP link is the only connection to the internet will not normally have
1062 a default route, so the peer will be able to use almost any IP address
1063 without authenticating itself.
1064 .PP
1065 As indicated above, some security-sensitive options are privileged,
1066 which means that they may not be used by an ordinary non-privileged
1067 user running a setuid-root pppd, either on the command line, in the
1068 user's ~/.ppprc file, or in an options file read using the \fIfile\fR
1069 option.  Privileged options may be used in /etc/ppp/options file or in
1070 an options file read using the \fIcall\fR option.  If pppd is being
1071 run by the root user, privileged options can be used without
1072 restriction.
1073 .PP
1074 When opening the device, pppd uses either the invoking user's user ID
1075 or the root UID (that is, 0), depending on whether the device name was
1076 specified by the user or the system administrator.  If the device name
1077 comes from a privileged source, that is, /etc/ppp/options or an
1078 options file read using the \fIcall\fR option, pppd uses full root
1079 privileges when opening the device.  Thus, by creating an appropriate
1080 file under /etc/ppp/peers, the system administrator can allow users to
1081 establish a ppp connection via a device which they would not normally
1082 have permission to access.  Otherwise pppd uses the invoking user's
1083 real UID when opening the device.
1084 .SH AUTHENTICATION
1085 Authentication is the process whereby one peer convinces the other of
1086 its identity.  This involves the first peer sending its name to the
1087 other, together with some kind of secret information which could only
1088 come from the genuine authorized user of that name.  In such an
1089 exchange, we will call the first peer the "client" and the other the
1090 "server".  The client has a name by which it identifies itself to the
1091 server, and the server also has a name by which it identifies itself
1092 to the client.  Generally the genuine client shares some secret (or
1093 password) with the server, and authenticates itself by proving that it
1094 knows that secret.  Very often, the names used for authentication
1095 correspond to the internet hostnames of the peers, but this is not
1096 essential.
1097 .LP
1098 At present, pppd supports three authentication protocols: the Password
1099 Authentication Protocol (PAP), Challenge Handshake Authentication
1100 Protocol (CHAP), and Extensible Authentication Protocol (EAP).  PAP
1101 involves the client sending its name and a cleartext password to the
1102 server to authenticate itself.  In contrast, the server initiates the
1103 CHAP authentication exchange by sending a challenge to the client (the
1104 challenge packet includes the server's name).  The client must respond
1105 with a response which includes its name plus a hash value derived from
1106 the shared secret and the challenge, in order to prove that it knows
1107 the secret.  EAP supports CHAP-style authentication, and also includes
1108 the SRP-SHA1 mechanism, which is resistant to dictionary-based attacks
1109 and does not require a cleartext password on the server side.
1110 .LP
1111 The PPP protocol, being symmetrical, allows both peers to require the
1112 other to authenticate itself.  In that case, two separate and
1113 independent authentication exchanges will occur.  The two exchanges
1114 could use different authentication protocols, and in principle,
1115 different names could be used in the two exchanges.
1116 .LP
1117 The default behaviour of pppd is to agree to authenticate if
1118 requested, and to not require authentication from the peer.  However,
1119 pppd will not agree to authenticate itself with a particular protocol
1120 if it has no secrets which could be used to do so.
1121 .LP
1122 Pppd stores secrets for use in authentication in secrets
1123 files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP,
1124 MS-CHAP, MS-CHAPv2, and EAP MD5-Challenge, and /etc/ppp/srp-secrets
1125 for EAP SRP-SHA1).
1126 All secrets files have the same format.  The secrets files can
1127 contain secrets for pppd to use in authenticating itself to other
1128 systems, as well as secrets for pppd to use when authenticating other
1129 systems to itself.
1130 .LP
1131 Each line in a secrets file contains one secret.  A given secret is
1132 specific to a particular combination of client and server - it can
1133 only be used by that client to authenticate itself to that server.
1134 Thus each line in a secrets file has at least 3 fields: the name of
1135 the client, the name of the server, and the secret.  These fields may
1136 be followed by a list of the IP addresses that the specified client
1137 may use when connecting to the specified server.
1138 .LP
1139 A secrets file is parsed into words as for a options file, so the
1140 client name, server name and secrets fields must each be one word,
1141 with any embedded spaces or other special characters quoted or
1142 escaped.  Note that case is significant in the client and server names
1143 and in the secret.
1144 .LP
1145 If the secret starts with an `@', what follows is assumed to be the
1146 name of a file from which to read the secret.  A "*" as the client or
1147 server name matches any name.  When selecting a secret, pppd takes the
1148 best match, i.e.  the match with the fewest wildcards.
1149 .LP
1150 Any following words on the same line are taken to be a list of
1151 acceptable IP addresses for that client.  If there are only 3 words on
1152 the line, or if the first word is "-", then all IP addresses are
1153 disallowed.  To allow any address, use "*".  A word starting with "!"
1154 indicates that the specified address is \fInot\fR acceptable.  An
1155 address may be followed by "/" and a number \fIn\fR, to indicate a
1156 whole subnet, i.e. all addresses which have the same value in the most
1157 significant \fIn\fR bits.  In this form, the address may be followed
1158 by a plus sign ("+") to indicate that one address from the subnet is
1159 authorized, based on the ppp network interface unit number in use.
1160 In this case, the host part of the address will be set to the unit
1161 number plus one.
1162 .LP
1163 Thus a secrets file contains both secrets for use in authenticating
1164 other hosts, plus secrets which we use for authenticating ourselves to
1165 others.  When pppd is authenticating the peer (checking the peer's
1166 identity), it chooses a secret with the peer's name in the first
1167 field and the name of the local system in the second field.  The
1168 name of the local system defaults to the hostname, with the domain
1169 name appended if the \fIdomain\fR option is used.  This default can be
1170 overridden with the \fIname\fR option, except when the
1171 \fIusehostname\fR option is used.  (For EAP SRP-SHA1, see the
1172 srp-entry(8) utility for generating proper validator entries to be
1173 used in the "secret" field.)
1174 .LP
1175 When pppd is choosing a secret to use in authenticating itself to the
1176 peer, it first determines what name it is going to use to identify
1177 itself to the peer.  This name can be specified by the user with the
1178 \fIuser\fR option.  If this option is not used, the name defaults to
1179 the name of the local system, determined as described in the previous
1180 paragraph.  Then pppd looks for a secret with this name in the first
1181 field and the peer's name in the second field.  Pppd will know the
1182 name of the peer if CHAP or EAP authentication is being used, because
1183 the peer will have sent it in the challenge packet.  However, if PAP
1184 is being used, pppd will have to determine the peer's name from the
1185 options specified by the user.  The user can specify the peer's name
1186 directly with the \fIremotename\fR option.  Otherwise, if the remote
1187 IP address was specified by a name (rather than in numeric form), that
1188 name will be used as the peer's name.  Failing that, pppd will use the
1189 null string as the peer's name.
1190 .LP
1191 When authenticating the peer with PAP, the supplied password is first
1192 compared with the secret from the secrets file.  If the password
1193 doesn't match the secret, the password is encrypted using crypt() and
1194 checked against the secret again.  Thus secrets for authenticating the
1195 peer can be stored in encrypted form if desired.  If the
1196 \fIpapcrypt\fR option is given, the first (unencrypted) comparison is
1197 omitted, for better security.
1198 .LP
1199 Furthermore, if the \fIlogin\fR option was specified, the username and
1200 password are also checked against the system password database.  Thus,
1201 the system administrator can set up the pap-secrets file to allow PPP
1202 access only to certain users, and to restrict the set of IP addresses
1203 that each user can use.  Typically, when using the \fIlogin\fR option,
1204 the secret in /etc/ppp/pap-secrets would be "", which will match any
1205 password supplied by the peer.  This avoids the need to have the same
1206 secret in two places.
1207 .LP
1208 Authentication must be satisfactorily completed before IPCP (or any
1209 other Network Control Protocol) can be started.  If the peer is
1210 required to authenticate itself, and fails to do so, pppd will
1211 terminated the link (by closing LCP).  If IPCP negotiates an
1212 unacceptable IP address for the remote host, IPCP will be closed.  IP
1213 packets can only be sent or received when IPCP is open.
1214 .LP
1215 In some cases it is desirable to allow some hosts which can't
1216 authenticate themselves to connect and use one of a restricted set of
1217 IP addresses, even when the local host generally requires
1218 authentication.  If the peer refuses to authenticate itself when
1219 requested, pppd takes that as equivalent to authenticating with PAP
1220 using the empty string for the username and password.  Thus, by adding
1221 a line to the pap-secrets file which specifies the empty string for
1222 the client and password, it is possible to allow restricted access to
1223 hosts which refuse to authenticate themselves.
1224 .SH ROUTING
1225 .LP
1226 When IPCP negotiation is completed successfully, pppd will inform the
1227 kernel of the local and remote IP addresses for the ppp interface.
1228 This is sufficient to create a host route to the remote end of the
1229 link, which will enable the peers to exchange IP packets.
1230 Communication with other machines generally requires further
1231 modification to routing tables and/or ARP (Address Resolution
1232 Protocol) tables.  In most cases the \fIdefaultroute\fR and/or
1233 \fIproxyarp\fR options are sufficient for this, but in some cases
1234 further intervention is required.  The /etc/ppp/ip-up script can be
1235 used for this.
1236 .LP
1237 Sometimes it is desirable to add a default route through the remote
1238 host, as in the case of a machine whose only connection to the
1239 Internet is through the ppp interface.  The \fIdefaultroute\fR option
1240 causes pppd to create such a default route when IPCP comes up, and
1241 delete it when the link is terminated.
1242 .LP
1243 In some cases it is desirable to use proxy ARP, for example on a
1244 server machine connected to a LAN, in order to allow other hosts to
1245 communicate with the remote host.  The \fIproxyarp\fR option causes
1246 pppd to look for a network interface on the same subnet as the remote
1247 host (an interface supporting broadcast and ARP, which is up and not a
1248 point-to-point or loopback interface).  If found, pppd creates a
1249 permanent, published ARP entry with the IP address of the remote host
1250 and the hardware address of the network interface found.
1251 .LP
1252 When the \fIdemand\fR option is used, the interface IP addresses have
1253 already been set at the point when IPCP comes up.  If pppd has not
1254 been able to negotiate the same addresses that it used to configure
1255 the interface (for example when the peer is an ISP that uses dynamic
1256 IP address assignment), pppd has to change the interface IP addresses
1257 to the negotiated addresses.  This may disrupt existing connections,
1258 and the use of demand dialling with peers that do dynamic IP address
1259 assignment is not recommended.
1260 .SH MULTILINK
1261 Multilink PPP provides the capability to combine two or more PPP links
1262 between a pair of machines into a single `bundle', which appears as a
1263 single virtual PPP link which has the combined bandwidth of the
1264 individual links.  Currently, multilink PPP is only supported under
1265 Linux.
1266 .LP
1267 Pppd detects that the link it is controlling is connected to the same
1268 peer as another link using the peer's endpoint discriminator and the
1269 authenticated identity of the peer (if it authenticates itself).  The
1270 endpoint discriminator is a block of data which is hopefully unique
1271 for each peer.  Several types of data can be used, including
1272 locally-assigned strings of bytes, IP addresses, MAC addresses,
1273 randomly strings of bytes, or E-164 phone numbers.  The endpoint
1274 discriminator sent to the peer by pppd can be set using the endpoint
1275 option.
1276 .LP
1277 In circumstances the peer may send no endpoint discriminator or a
1278 non-unique value.  The optional bundle option adds an extra string
1279 which is added to the peer's endpoint discriminator and authenticated
1280 identity when matching up links to be joined together in a bundle.
1281 The bundle option can also be used to allow the establishment of
1282 multiple bundles between the local system and the peer.  Pppd uses a
1283 TDB database in /var/run/pppd.tdb to match up links.
1284 .LP
1285 Assuming that multilink is enabled and the peer is willing to
1286 negotiate multilink, then when pppd is invoked to bring up the first
1287 link to the peer, it will detect that no other link is connected to
1288 the peer and create a new bundle, that is, another ppp network
1289 interface unit.  When another pppd is invoked to bring up another link
1290 to the peer, it will detect the existing bundle and join its link to
1291 it.  Currently, if the first pppd terminates (for example, because of
1292 a hangup or a received signal) the bundle is destroyed.
1293 .SH EXAMPLES
1294 .LP
1295 The following examples assume that the /etc/ppp/options file contains
1296 the \fIauth\fR option (as in the default /etc/ppp/options file in the
1297 ppp distribution).
1298 .LP
1299 Probably the most common use of pppd is to dial out to an ISP.  This
1300 can be done with a command such as
1301 .IP
1302 pppd call isp
1303 .LP
1304 where the /etc/ppp/peers/isp file is set up by the system
1305 administrator to contain something like this:
1306 .IP
1307 ttyS0 19200 crtscts
1308 .br
1309 connect '/usr/sbin/chat -v -f /etc/ppp/chat-isp'
1310 .br
1311 noauth
1312 .LP
1313 In this example, we are using chat to dial the ISP's modem and go
1314 through any logon sequence required.  The /etc/ppp/chat-isp file
1315 contains the script used by chat; it could for example contain
1316 something like this:
1317 .IP
1318 ABORT "NO CARRIER"
1319 .br
1320 ABORT "NO DIALTONE"
1321 .br
1322 ABORT "ERROR"
1323 .br
1324 ABORT "NO ANSWER"
1325 .br
1326 ABORT "BUSY"
1327 .br
1328 ABORT "Username/Password Incorrect"
1329 .br
1330 "" "at"
1331 .br
1332 OK "at&d0&c1"
1333 .br
1334 OK "atdt2468135"
1335 .br
1336 "name:" "^Umyuserid"
1337 .br
1338 "word:" "\\qmypassword"
1339 .br
1340 "ispts" "\\q^Uppp"
1341 .br
1342 "~-^Uppp-~"
1343 .LP
1344 See the chat(8) man page for details of chat scripts.
1345 .LP
1346 Pppd can also be used to provide a dial-in ppp service for users.  If
1347 the users already have login accounts, the simplest way to set up the
1348 ppp service is to let the users log in to their accounts and run pppd
1349 (installed setuid-root) with a command such as
1350 .IP
1351 pppd proxyarp
1352 .LP
1353 To allow a user to use the PPP facilities, you need to allocate an IP
1354 address for that user's machine and create an entry in
1355 /etc/ppp/pap-secrets, /etc/ppp/chap-secrets, or /etc/ppp/srp-secrets
1356 (depending on which authentication method the PPP implementation on
1357 the user's machine supports), so that the user's machine can
1358 authenticate itself.  For example, if Joe has a machine called
1359 "joespc" that is to be allowed to dial in to the machine called
1360 "server" and use the IP address joespc.my.net, you would add an entry
1361 like this to /etc/ppp/pap-secrets or /etc/ppp/chap-secrets:
1362 .IP
1363 joespc  server  "joe's secret"  joespc.my.net
1364 .LP
1365 (See srp-entry(8) for a means to generate the server's entry when
1366 SRP-SHA1 is in use.)
1367 Alternatively, you can create a username called (for example) "ppp",
1368 whose login shell is pppd and whose home directory is /etc/ppp.
1369 Options to be used when pppd is run this way can be put in
1370 /etc/ppp/.ppprc.
1371 .LP
1372 If your serial connection is any more complicated than a piece of
1373 wire, you may need to arrange for some control characters to be
1374 escaped.  In particular, it is often useful to escape XON (^Q) and
1375 XOFF (^S), using \fIasyncmap a0000\fR.  If the path includes a telnet,
1376 you probably should escape ^] as well (\fIasyncmap 200a0000\fR).  If
1377 the path includes an rlogin, you will need to use the \fIescape ff\fR
1378 option on the end which is running the rlogin client, since many
1379 rlogin implementations are not transparent; they will remove the
1380 sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the
1381 stream.
1382 .SH DIAGNOSTICS
1383 .LP
1384 Messages are sent to the syslog daemon using facility LOG_DAEMON.
1385 (This can be overriden by recompiling pppd with the macro
1386 LOG_PPP defined as the desired facility.)  In order to see the error
1387 and debug messages, you will need to edit your /etc/syslog.conf file
1388 to direct the messages to the desired output device or file.
1389 .LP
1390 The \fIdebug\fR option causes the contents of all control packets sent
1391 or received to be logged, that is, all LCP, PAP, CHAP, EAP, or IPCP packets.
1392 This can be useful if the PPP negotiation does not succeed or if
1393 authentication fails.
1394 If debugging is enabled at compile time, the \fIdebug\fR option also
1395 causes other debugging messages to be logged.
1396 .LP
1397 Debugging can also be enabled or disabled by sending a SIGUSR1 signal
1398 to the pppd process.  This signal acts as a toggle.
1399 .SH EXIT STATUS
1400 The exit status of pppd is set to indicate whether any error was
1401 detected, or the reason for the link being terminated.  The values
1402 used are:
1403 .TP
1404 .B 0
1405 Pppd has detached, or otherwise the connection was successfully
1406 established and terminated at the peer's request.
1407 .TP
1408 .B 1
1409 An immediately fatal error of some kind occurred, such as an essential
1410 system call failing, or running out of virtual memory.
1411 .TP
1412 .B 2
1413 An error was detected in processing the options given, such as two
1414 mutually exclusive options being used.
1415 .TP
1416 .B 3
1417 Pppd is not setuid-root and the invoking user is not root.
1418 .TP
1419 .B 4
1420 The kernel does not support PPP, for example, the PPP kernel driver is
1421 not included or cannot be loaded.
1422 .TP
1423 .B 5
1424 Pppd terminated because it was sent a SIGINT, SIGTERM or SIGHUP
1425 signal.
1426 .TP
1427 .B 6
1428 The serial port could not be locked.
1429 .TP
1430 .B 7
1431 The serial port could not be opened.
1432 .TP
1433 .B 8
1434 The connect script failed (returned a non-zero exit status).
1435 .TP
1436 .B 9
1437 The command specified as the argument to the \fIpty\fR option could
1438 not be run.
1439 .TP
1440 .B 10
1441 The PPP negotiation failed, that is, it didn't reach the point where
1442 at least one network protocol (e.g. IP) was running.
1443 .TP
1444 .B 11
1445 The peer system failed (or refused) to authenticate itself.
1446 .TP
1447 .B 12
1448 The link was established successfully and terminated because it was
1449 idle.
1450 .TP
1451 .B 13
1452 The link was established successfully and terminated because the
1453 connect time limit was reached.
1454 .TP
1455 .B 14
1456 Callback was negotiated and an incoming call should arrive shortly.
1457 .TP
1458 .B 15
1459 The link was terminated because the peer is not responding to echo
1460 requests.
1461 .TP
1462 .B 16
1463 The link was terminated by the modem hanging up.
1464 .TP
1465 .B 17
1466 The PPP negotiation failed because serial loopback was detected.
1467 .TP
1468 .B 18
1469 The init script failed (returned a non-zero exit status).
1470 .TP
1471 .B 19
1472 We failed to authenticate ourselves to the peer.
1473 .SH SCRIPTS
1474 Pppd invokes scripts at various stages in its processing which can be
1475 used to perform site-specific ancillary processing.  These scripts are
1476 usually shell scripts, but could be executable code files instead.
1477 Pppd does not wait for the scripts to finish.  The scripts are
1478 executed as root (with the real and effective user-id set to 0), so
1479 that they can do things such as update routing tables or run
1480 privileged daemons.  Be careful that the contents of these scripts do
1481 not compromise your system's security.  Pppd runs the scripts with
1482 standard input, output and error redirected to /dev/null, and with an
1483 environment that is empty except for some environment variables that
1484 give information about the link.  The environment variables that pppd
1485 sets are:
1486 .TP
1487 .B DEVICE
1488 The name of the serial tty device being used.
1489 .TP
1490 .B IFNAME
1491 The name of the network interface being used.
1492 .TP
1493 .B IPLOCAL
1494 The IP address for the local end of the link.  This is only set when
1495 IPCP has come up.
1496 .TP
1497 .B IPREMOTE
1498 The IP address for the remote end of the link.  This is only set when
1499 IPCP has come up.
1500 .TP
1501 .B PEERNAME
1502 The authenticated name of the peer.  This is only set if the peer
1503 authenticates itself.
1504 .TP
1505 .B SPEED
1506 The baud rate of the tty device.
1507 .TP
1508 .B ORIG_UID
1509 The real user-id of the user who invoked pppd.
1510 .TP
1511 .B PPPLOGNAME
1512 The username of the real user-id that invoked pppd. This is always set.
1513 .P
1514 For the ip-down and auth-down scripts, pppd also sets the following
1515 variables giving statistics for the connection:
1516 .TP
1517 .B CONNECT_TIME
1518 The number of seconds from when the PPP negotiation started until the
1519 connection was terminated.
1520 .TP
1521 .B BYTES_SENT
1522 The number of bytes sent (at the level of the serial port) during the
1523 connection.
1524 .TP
1525 .B BYTES_RCVD
1526 The number of bytes received (at the level of the serial port) during
1527 the connection.
1528 .TP
1529 .B LINKNAME
1530 The logical name of the link, set with the \fIlinkname\fR option.
1531 .P
1532 Pppd invokes the following scripts, if they exist.  It is not an error
1533 if they don't exist.
1534 .TP
1535 .B /etc/ppp/auth-up
1536 A program or script which is executed after the remote system
1537 successfully authenticates itself.  It is executed with the parameters
1538 .IP
1539 \fIinterface-name peer-name user-name tty-device speed\fR
1540 .IP
1541 Note that this script is not executed if the peer doesn't authenticate
1542 itself, for example when the \fInoauth\fR option is used.
1543 .TP
1544 .B /etc/ppp/auth-down
1545 A program or script which is executed when the link goes down, if
1546 /etc/ppp/auth-up was previously executed.  It is executed in the same
1547 manner with the same parameters as /etc/ppp/auth-up.
1548 .TP
1549 .B /etc/ppp/ip-up
1550 A program or script which is executed when the link is available for
1551 sending and receiving IP packets (that is, IPCP has come up).  It is
1552 executed with the parameters
1553 .IP
1554 \fIinterface-name tty-device speed local-IP-address
1555 remote-IP-address ipparam\fR
1556 .TP
1557 .B /etc/ppp/ip-down
1558 A program or script which is executed when the link is no longer
1559 available for sending and receiving IP packets.  This script can be
1560 used for undoing the effects of the /etc/ppp/ip-up script.  It is
1561 invoked in the same manner and with the same parameters as the ip-up
1562 script.
1563 .TP
1564 .B /etc/ppp/ipv6-up
1565 Like /etc/ppp/ip-up, except that it is executed when the link is available 
1566 for sending and receiving IPv6 packets. It is executed with the parameters
1567 .IP
1568 \fIinterface-name tty-device speed local-link-local-address
1569 remote-link-local-address ipparam\fR
1570 .TP
1571 .B /etc/ppp/ipv6-down
1572 Similar to /etc/ppp/ip-down, but it is executed when IPv6 packets can no
1573 longer be transmitted on the link. It is executed with the same parameters 
1574 as the ipv6-up script.
1575 .TP
1576 .B /etc/ppp/ipx-up
1577 A program or script which is executed when the link is available for
1578 sending and receiving IPX packets (that is, IPXCP has come up).  It is
1579 executed with the parameters
1580 .IP
1581 \fIinterface-name tty-device speed network-number local-IPX-node-address
1582 remote-IPX-node-address local-IPX-routing-protocol remote-IPX-routing-protocol
1583 local-IPX-router-name remote-IPX-router-name ipparam pppd-pid\fR 
1584 .IP
1585 The local-IPX-routing-protocol and remote-IPX-routing-protocol field
1586 may be one of the following:
1587 .IP
1588 NONE      to indicate that there is no routing protocol
1589 .br
1590 RIP       to indicate that RIP/SAP should be used
1591 .br
1592 NLSP      to indicate that Novell NLSP should be used
1593 .br
1594 RIP NLSP  to indicate that both RIP/SAP and NLSP should be used
1595 .TP
1596 .B /etc/ppp/ipx-down
1597 A program or script which is executed when the link is no longer
1598 available for sending and receiving IPX packets.  This script can be
1599 used for undoing the effects of the /etc/ppp/ipx-up script.  It is
1600 invoked in the same manner and with the same parameters as the ipx-up
1601 script.
1602 .SH FILES
1603 .TP
1604 .B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others)
1605 Process-ID for pppd process on ppp interface unit \fIn\fR.
1606 .TP
1607 .B /var/run/ppp-\fIname\fB.pid \fR(BSD or Linux),
1608 \fB/etc/ppp/ppp-\fIname\fB.pid \fR(others)
1609 Process-ID for pppd process for logical link \fIname\fR (see the
1610 \fIlinkname\fR option).
1611 .TP
1612 .B /etc/ppp/pap-secrets
1613 Usernames, passwords and IP addresses for PAP authentication.  This
1614 file should be owned by root and not readable or writable by any other
1615 user.  Pppd will log a warning if this is not the case.
1616 .TP
1617 .B /etc/ppp/chap-secrets
1618 Names, secrets and IP addresses for CHAP/MS-CHAP/MS-CHAPv2 authentication.
1619 As for /etc/ppp/pap-secrets, this file should be owned by root and not
1620 readable or writable by any other user.  Pppd will log a warning if
1621 this is not the case.
1622 .TP
1623 .B /etc/ppp/srp-secrets
1624 Names, secrets, and IP addresses for EAP authentication.  As for
1625 /etc/ppp/pap-secrets, this file should be owned by root and not
1626 readable or writable by any other user.  Pppd will log a warning if
1627 this is not the case.
1628 .TP
1629 .B ~/.ppp_pseudonym
1630 Saved client-side SRP-SHA1 pseudonym.  See the \fIsrp-use-pseudonym\fR
1631 option for details.
1632 .TP
1633 .B /etc/ppp/options
1634 System default options for pppd, read before user default options or
1635 command-line options.
1636 .TP
1637 .B ~/.ppprc
1638 User default options, read before /etc/ppp/options.\fIttyname\fR.
1639 .TP
1640 .B /etc/ppp/options.\fIttyname
1641 System default options for the serial port being used, read after
1642 ~/.ppprc.  In forming the \fIttyname\fR part of this
1643 filename, an initial /dev/ is stripped from the port name (if
1644 present), and any slashes in the remaining part are converted to
1645 dots.
1646 .TP
1647 .B /etc/ppp/peers
1648 A directory containing options files which may contain privileged
1649 options, even if pppd was invoked by a user other than root.  The
1650 system administrator can create options files in this directory to
1651 permit non-privileged users to dial out without requiring the peer to
1652 authenticate, but only to certain trusted peers.
1653 .SH SEE ALSO
1654 .TP
1655 .B RFC1144
1656 Jacobson, V.
1657 \fICompressing TCP/IP headers for low-speed serial links.\fR
1658 February 1990.
1659 .TP
1660 .B RFC1321
1661 Rivest, R.
1662 .I The MD5 Message-Digest Algorithm.
1663 April 1992.
1664 .TP
1665 .B RFC1332
1666 McGregor, G.
1667 .I PPP Internet Protocol Control Protocol (IPCP).
1668 May 1992.
1669 .TP
1670 .B RFC1334
1671 Lloyd, B.; Simpson, W.A.
1672 .I PPP authentication protocols.
1673 October 1992.
1674 .TP
1675 .B RFC1661
1676 Simpson, W.A.
1677 .I The Point\-to\-Point Protocol (PPP).
1678 July 1994.
1679 .TP
1680 .B RFC1662
1681 Simpson, W.A.
1682 .I PPP in HDLC-like Framing.
1683 July 1994.
1684 .TP
1685 .B RFC2284
1686 Blunk, L.; Vollbrecht, J.,
1687 .I PPP Extensible Authentication Protocol (EAP).
1688 March 1998.
1689 .TP
1690 .B RFC2472
1691 Haskin, D.
1692 .I IP Version 6 over PPP
1693 December 1998.
1694 .TP
1695 .B RFC2945
1696 Wu, T.,
1697 .I The SRP Authentication and Key Exchange System
1698 September 2000.
1699 .TP
1700 .B draft-ietf-pppext-eap-srp-03.txt
1701 Carlson, J.; et al.,
1702 .I EAP SRP-SHA1 Authentication Protocol.
1703 July 2001.
1704 .SH NOTES
1705 The following signals have the specified effect when sent to pppd.
1706 .TP
1707 .B SIGINT, SIGTERM
1708 These signals cause pppd to terminate the link (by closing LCP),
1709 restore the serial device settings, and exit.
1710 .TP
1711 .B SIGHUP
1712 This signal causes pppd to terminate the link, restore the serial
1713 device settings, and close the serial device.  If the \fIpersist\fR or
1714 \fIdemand\fR option has been specified, pppd will try to reopen the
1715 serial device and start another connection (after the holdoff period).
1716 Otherwise pppd will exit.  If this signal is received during the
1717 holdoff period, it causes pppd to end the holdoff period immediately.
1718 .TP
1719 .B SIGUSR1
1720 This signal toggles the state of the \fIdebug\fR option.
1721 .TP
1722 .B SIGUSR2
1723 This signal causes pppd to renegotiate compression.  This can be
1724 useful to re-enable compression after it has been disabled as a result
1725 of a fatal decompression error.  (Fatal decompression errors generally
1726 indicate a bug in one or other implementation.)
1727
1728 .SH AUTHORS
1729 Paul Mackerras (Paul.Mackerras@cs.anu.edu.au), based on earlier work by
1730 Drew Perkins,
1731 Brad Clements,
1732 Karl Fox,
1733 Greg Christy,
1734 and
1735 Brad Parker.