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