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