Debian Codegraph @

upstream/mageia-cauldron/man8/pppd.8

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