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