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