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