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