pppd: Add master_detach option
[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 master_detach
628 If multilink is enabled and this pppd process is the multilink bundle
629 master, and the link controlled by this pppd process terminates, this
630 pppd process continues to run in order to maintain the bundle.  If the
631 \fBmaster_detach\fR option has been given, pppd will detach from its
632 controlling terminal in this situation, even if the \fBnodetach\fR
633 option has been given.
634 .TP
635 .B maxconnect \fIn
636 Terminate the connection when it has been available for network
637 traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first
638 network control protocol comes up).
639 .TP
640 .B maxfail \fIn
641 Terminate after \fIn\fR consecutive failed connection attempts.  A
642 value of 0 means no limit.  The default value is 10.
643 .TP
644 .B modem
645 Use the modem control lines.  This option is the default.  With this
646 option, pppd will wait for the CD (Carrier Detect) signal from the
647 modem to be asserted when opening the serial device (unless a connect
648 script is specified), and it will drop the DTR (Data Terminal Ready)
649 signal briefly when the connection is terminated and before executing
650 the connect script.  On Ultrix, this option implies hardware flow
651 control, as for the \fIcrtscts\fR option.  This is the opposite of the
652 \fBlocal\fR option.
653 .TP
654 .B mp
655 Enables the use of PPP multilink; this is an alias for the `multilink'
656 option.  This option is currently only available under Linux.
657 .TP
658 .B mppe\-stateful
659 Allow MPPE to use stateful mode.  Stateless mode is still attempted first.
660 The default is to disallow stateful mode.  
661 .TP
662 .B mpshortseq
663 Enables the use of short (12-bit) sequence numbers in multilink
664 headers, as opposed to 24-bit sequence numbers.  This option is only
665 available under Linux, and only has any effect if multilink is
666 enabled (see the multilink option).
667 .TP
668 .B mrru \fIn
669 Sets the Maximum Reconstructed Receive Unit to \fIn\fR.  The MRRU is
670 the maximum size for a received packet on a multilink bundle, and is
671 analogous to the MRU for the individual links.  This option is
672 currently only available under Linux, and only has any effect if
673 multilink is enabled (see the multilink option).
674 .TP
675 .B ms\-dns \fI<addr>
676 If pppd is acting as a server for Microsoft Windows clients, this
677 option allows pppd to supply one or two DNS (Domain Name Server)
678 addresses to the clients.  The first instance of this option specifies
679 the primary DNS address; the second instance (if given) specifies the
680 secondary DNS address.  (This option was present in some older
681 versions of pppd under the name \fBdns\-addr\fR.)
682 .TP
683 .B ms\-wins \fI<addr>
684 If pppd is acting as a server for Microsoft Windows or "Samba"
685 clients, this option allows pppd to supply one or two WINS (Windows
686 Internet Name Services) server addresses to the clients.  The first
687 instance of this option specifies the primary WINS address; the second
688 instance (if given) specifies the secondary WINS address.
689 .TP
690 .B multilink
691 Enables the use of the PPP multilink protocol.  If the peer also
692 supports multilink, then this link can become part of a bundle between
693 the local system and the peer.  If there is an existing bundle to the
694 peer, pppd will join this link to that bundle, otherwise pppd will
695 create a new bundle.  See the MULTILINK section below.  This option is
696 currently only available under Linux.
697 .TP
698 .B name \fIname
699 Set the name of the local system for authentication purposes to
700 \fIname\fR.  This is a privileged option.  With this option, pppd will
701 use lines in the secrets files which have \fIname\fR as the second
702 field when looking for a secret to use in authenticating the peer.  In
703 addition, unless overridden with the \fIuser\fR option, \fIname\fR
704 will be used as the name to send to the peer when authenticating the
705 local system to the peer.  (Note that pppd does not append the domain
706 name to \fIname\fR.)
707 .TP
708 .B noaccomp
709 Disable Address/Control compression in both directions (send and
710 receive).
711 .TP
712 .B noauth
713 Do not require the peer to authenticate itself.  This option is
714 privileged.
715 .TP
716 .B nobsdcomp
717 Disables BSD-Compress compression; \fBpppd\fR will not request or
718 agree to compress packets using the BSD-Compress scheme.
719 .TP
720 .B noccp
721 Disable CCP (Compression Control Protocol) negotiation.  This option
722 should only be required if the peer is buggy and gets confused by
723 requests from pppd for CCP negotiation.
724 .TP
725 .B nocrtscts
726 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
727 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the
728 \fIcdtrcts\fR nor the \fInocdtrcts\fR option is given, the hardware
729 flow control setting for the serial port is left unchanged.
730 .TP
731 .B nocdtrcts
732 This option is a synonym for \fInocrtscts\fR. Either of these options will
733 disable both forms of hardware flow control.
734 .TP
735 .B nodefaultroute
736 Disable the \fIdefaultroute\fR option.  The system administrator who
737 wishes to prevent users from creating default routes with pppd
738 can do so by placing this option in the /etc/ppp/options file.
739 .TP
740 .B nodeflate
741 Disables Deflate compression; pppd will not request or agree to
742 compress packets using the Deflate scheme.
743 .TP
744 .B nodetach
745 Don't detach from the controlling terminal.  Without this option, if a
746 serial device other than the terminal on the standard input is
747 specified, pppd will fork to become a background process.
748 .TP
749 .B noendpoint
750 Disables pppd from sending an endpoint discriminator to the peer or
751 accepting one from the peer (see the MULTILINK section below).  This
752 option should only be required if the peer is buggy.
753 .TP
754 .B noip
755 Disable IPCP negotiation and IP communication.  This option should
756 only be required if the peer is buggy and gets confused by requests
757 from pppd for IPCP negotiation.
758 .TP
759 .B noipv6
760 Disable IPv6CP negotiation and IPv6 communication. This option should
761 only be required if the peer is buggy and gets confused by requests
762 from pppd for IPv6CP negotiation.
763 .TP
764 .B noipdefault
765 Disables the default behaviour when no local IP address is specified,
766 which is to determine (if possible) the local IP address from the
767 hostname.  With this option, the peer will have to supply the local IP
768 address during IPCP negotiation (unless it specified explicitly on the
769 command line or in an options file).
770 .TP
771 .B noipx
772 Disable the IPXCP and IPX protocols.  This option should only be
773 required if the peer is buggy and gets confused by requests from pppd
774 for IPXCP negotiation.
775 .TP
776 .B noktune
777 Opposite of the \fIktune\fR option; disables pppd from changing system
778 settings.
779 .TP
780 .B nolock
781 Opposite of the \fIlock\fR option; specifies that pppd should not
782 create a UUCP-style lock file for the serial device.  This option is
783 privileged.
784 .TP
785 .B nolog
786 Do not send log messages to a file or file descriptor.  This option
787 cancels the \fBlogfd\fR and \fBlogfile\fR options.
788 .TP
789 .B nomagic
790 Disable magic number negotiation.  With this option, pppd cannot
791 detect a looped-back line.  This option should only be needed if the
792 peer is buggy.
793 .TP
794 .B nomp
795 Disables the use of PPP multilink.  This option is currently only
796 available under Linux.
797 .TP
798 .B nomppe
799 Disables MPPE (Microsoft Point to Point Encryption).  This is the default.
800 .TP
801 .B nomppe\-40
802 Disable 40-bit encryption with MPPE.
803 .TP
804 .B nomppe\-128
805 Disable 128-bit encryption with MPPE.
806 .TP
807 .B nomppe\-stateful
808 Disable MPPE stateful mode.  This is the default.
809 .TP
810 .B nompshortseq
811 Disables the use of short (12-bit) sequence numbers in the PPP
812 multilink protocol, forcing the use of 24-bit sequence numbers.  This
813 option is currently only available under Linux, and only has any
814 effect if multilink is enabled.
815 .TP
816 .B nomultilink
817 Disables the use of PPP multilink.  This option is currently only
818 available under Linux.
819 .TP
820 .B nopcomp
821 Disable protocol field compression negotiation in both the receive and
822 the transmit direction.
823 .TP
824 .B nopersist
825 Exit once a connection has been made and terminated.  This is the
826 default unless the \fIpersist\fR or \fIdemand\fR option has been
827 specified.
828 .TP
829 .B nopredictor1
830 Do not accept or agree to Predictor\-1 compression.
831 .TP
832 .B noproxyarp
833 Disable the \fIproxyarp\fR option.  The system administrator who
834 wishes to prevent users from creating proxy ARP entries with pppd can
835 do so by placing this option in the /etc/ppp/options file.
836 .TP
837 .B noremoteip
838 Allow pppd to operate without having an IP address for the peer.  This
839 option is only available under Linux.  Normally, pppd will request the
840 peer's IP address, and if the peer does not supply it, pppd will use
841 an arbitrary address in the 10.x.x.x subnet.
842 With this option, if the peer does
843 not supply its IP address, pppd will not ask the peer for it, and will
844 not set the destination address of the ppp interface.  In this
845 situation, the ppp interface can be used for routing by creating
846 device routes, but the peer itself cannot be addressed directly for IP
847 traffic.
848 .TP
849 .B notty
850 Normally, pppd requires a terminal device.  With this option, pppd
851 will allocate itself a pseudo-tty master/slave pair and use the slave
852 as its terminal device.  Pppd will create a child process to act as a
853 `character shunt' to transfer characters between the pseudo-tty master
854 and its standard input and output.  Thus pppd will transmit characters
855 on its standard output and receive characters on its standard input
856 even if they are not terminal devices.  This option increases the
857 latency and CPU overhead of transferring data over the ppp interface
858 as all of the characters sent and received must flow through the
859 character shunt process.  An explicit device name may not be given if
860 this option is used.
861 .TP
862 .B novj
863 Disable Van Jacobson style TCP/IP header compression in both the
864 transmit and the receive direction.
865 .TP
866 .B novjccomp
867 Disable the connection-ID compression option in Van Jacobson style
868 TCP/IP header compression.  With this option, pppd will not omit the
869 connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
870 ask the peer to do so.
871 .TP
872 .B papcrypt
873 Indicates that all secrets in the /etc/ppp/pap\-secrets file which are
874 used for checking the identity of the peer are encrypted, and thus
875 pppd should not accept a password which, before encryption, is
876 identical to the secret from the /etc/ppp/pap\-secrets file.
877 .TP
878 .B pap\-max\-authreq \fIn
879 Set the maximum number of PAP authenticate-request transmissions to
880 \fIn\fR (default 10).
881 .TP
882 .B pap\-restart \fIn
883 Set the PAP restart interval (retransmission timeout) to \fIn\fR
884 seconds (default 3).
885 .TP
886 .B pap\-timeout \fIn
887 Set the maximum time that pppd will wait for the peer to authenticate
888 itself with PAP to \fIn\fR seconds (0 means no limit).
889 .TP
890 .B pass\-filter \fIfilter\-expression
891 Specifies a packet filter to applied to data packets being sent or
892 received to determine which packets should be allowed to pass.
893 Packets which are rejected by the filter are silently discarded.  This
894 option can be used to prevent specific network daemons (such as
895 routed) using up link bandwidth, or to provide a very basic firewall
896 capability.
897 The \fIfilter\-expression\fR syntax is as described for tcpdump(1),
898 except that qualifiers which are inappropriate for a PPP link, such as
899 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
900 expression should be enclosed in single-quotes to prevent whitespace
901 in the expression from being interpreted by the shell.  Note that it
902 is possible to apply different constraints to incoming and outgoing
903 packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. This
904 option is currently only available under Linux, and requires that the
905 kernel was configured to include PPP filtering support (CONFIG_PPP_FILTER).
906 .TP
907 .B password \fIpassword\-string
908 Specifies the password to use for authenticating to the peer.  Use
909 of this option is discouraged, as the password is likely to be visible
910 to other users on the system (for example, by using ps(1)).
911 .TP
912 .B persist
913 Do not exit after a connection is terminated; instead try to reopen
914 the connection. The \fBmaxfail\fR option still has an effect on
915 persistent connections.
916 .TP
917 .B plugin \fIfilename
918 Load the shared library object file \fIfilename\fR as a plugin.  This
919 is a privileged option.  If \fIfilename\fR does not contain a slash
920 (/), pppd will look in the \fB/usr/lib/pppd/\fIversion\fR directory
921 for the plugin, where
922 \fIversion\fR is the version number of pppd (for example, 2.4.2).
923 .TP
924 .B predictor1
925 Request that the peer compress frames that it sends using Predictor-1
926 compression, and agree to compress transmitted frames with Predictor-1
927 if requested.  This option has no effect unless the kernel driver
928 supports Predictor-1 compression.
929 .TP
930 .B privgroup \fIgroup\-name
931 Allows members of group \fIgroup\-name\fR to use privileged options.
932 This is a privileged option.  Use of this option requires care as
933 there is no guarantee that members of \fIgroup\-name\fR cannot use pppd
934 to become root themselves.  Consider it equivalent to putting the
935 members of \fIgroup\-name\fR in the kmem or disk group.
936 .TP
937 .B proxyarp
938 Add an entry to this system's ARP [Address Resolution Protocol] table
939 with the IP address of the peer and the Ethernet address of this
940 system.  This will have the effect of making the peer appear to other
941 systems to be on the local ethernet.
942 .TP
943 .B pty \fIscript
944 Specifies that the command \fIscript\fR is to be used to communicate
945 rather than a specific terminal device.  Pppd will allocate itself a
946 pseudo-tty master/slave pair and use the slave as its terminal
947 device.  The \fIscript\fR will be run in a child process with the
948 pseudo-tty master as its standard input and output.  An explicit
949 device name may not be given if this option is used.  (Note: if the
950 \fIrecord\fR option is used in conjunction with the \fIpty\fR option,
951 the child process will have pipes on its standard input and output.)
952 .TP
953 .B receive\-all
954 With this option, pppd will accept all control characters from the
955 peer, including those marked in the receive asyncmap.  Without this
956 option, pppd will discard those characters as specified in RFC1662.
957 This option should only be needed if the peer is buggy.
958 .TP
959 .B record \fIfilename
960 Specifies that pppd should record all characters sent and received to
961 a file named \fIfilename\fR.  This file is opened in append mode,
962 using the user's user-ID and permissions.  This option is implemented
963 using a pseudo-tty and a process to transfer characters between the
964 pseudo-tty and the real serial device, so it will increase the latency
965 and CPU overhead of transferring data over the ppp interface.  The
966 characters are stored in a tagged format with timestamps, which can be
967 displayed in readable form using the pppdump(8) program.
968 .TP
969 .B remotename \fIname
970 Set the assumed name of the remote system for authentication purposes
971 to \fIname\fR.
972 .TP
973 .B remotenumber \fInumber
974 Set the assumed telephone number of the remote system for authentication
975 purposes to \fInumber\fR.
976 .TP
977 .B refuse\-chap
978 With this option, pppd will not agree to authenticate itself to the
979 peer using CHAP.
980 .TP
981 .B refuse\-mschap
982 With this option, pppd will not agree to authenticate itself to the
983 peer using MS\-CHAP.
984 .TP
985 .B refuse\-mschap\-v2
986 With this option, pppd will not agree to authenticate itself to the
987 peer using MS\-CHAPv2.
988 .TP
989 .B refuse\-eap
990 With this option, pppd will not agree to authenticate itself to the
991 peer using EAP.
992 .TP
993 .B refuse\-pap
994 With this option, pppd will not agree to authenticate itself to the
995 peer using PAP.
996 .TP
997 .B require\-chap
998 Require the peer to authenticate itself using CHAP [Challenge
999 Handshake Authentication Protocol] authentication.
1000 .TP
1001 .B require\-mppe
1002 Require the use of MPPE (Microsoft Point to Point Encryption).  This
1003 option disables all other compression types.  This option enables
1004 both 40-bit and 128-bit encryption.  In order for MPPE to successfully
1005 come up, you must have authenticated with either MS\-CHAP or MS\-CHAPv2.
1006 This option is presently only supported under Linux, and only if your
1007 kernel has been configured to include MPPE support.
1008 .TP
1009 .B require\-mppe\-40
1010 Require the use of MPPE, with 40-bit encryption.
1011 .TP
1012 .B require\-mppe\-128
1013 Require the use of MPPE, with 128-bit encryption.
1014 .TP
1015 .B require\-mschap
1016 Require the peer to authenticate itself using MS\-CHAP [Microsoft Challenge
1017 Handshake Authentication Protocol] authentication.
1018 .TP
1019 .B require\-mschap\-v2
1020 Require the peer to authenticate itself using MS\-CHAPv2 [Microsoft Challenge
1021 Handshake Authentication Protocol, Version 2] authentication.
1022 .TP
1023 .B require\-eap
1024 Require the peer to authenticate itself using EAP [Extensible
1025 Authentication Protocol] authentication.
1026 .TP
1027 .B require\-pap
1028 Require the peer to authenticate itself using PAP [Password
1029 Authentication Protocol] authentication.
1030 .TP
1031 .B set \fIname\fR=\fIvalue
1032 Set an environment variable for scripts that are invoked by pppd.
1033 When set by a privileged source, the variable specified by \fIname\fR
1034 cannot be changed by options contained in an unprivileged source.  See
1035 also the \fIunset\fR option and the environment described in
1036 \fISCRIPTS\fR.
1037 .TP
1038 .B show\-password
1039 When logging the contents of PAP packets, this option causes pppd to
1040 show the password string in the log message.
1041 .TP
1042 .B silent
1043 With this option, pppd will not transmit LCP packets to initiate a
1044 connection until a valid LCP packet is received from the peer (as for
1045 the `passive' option with ancient versions of pppd).
1046 .TP
1047 .B srp\-interval \fIn
1048 If this parameter is given and pppd uses EAP SRP\-SHA1 to authenticate
1049 the peer (i.e., is the server), then pppd will use the optional
1050 lightweight SRP rechallenge mechanism at intervals of \fIn\fR
1051 seconds.  This option is faster than \fBeap\-interval\fR
1052 reauthentication because it uses a hash\-based mechanism and does not
1053 derive a new session key.
1054 .TP
1055 .B srp\-pn\-secret \fIstring
1056 Set the long-term pseudonym-generating secret for the server.  This
1057 value is optional and if set, needs to be known at the server
1058 (authenticator) side only, and should be different for each server (or
1059 poll of identical servers).  It is used along with the current date to
1060 generate a key to encrypt and decrypt the client's identity contained
1061 in the pseudonym.
1062 .TP
1063 .B srp\-use\-pseudonym
1064 When operating as an EAP SRP\-SHA1 client, attempt to use the pseudonym
1065 stored in ~/.ppp_pseudonym first as the identity, and save in this
1066 file any pseudonym offered by the peer during authentication.
1067 .TP
1068 .B sync
1069 Use synchronous HDLC serial encoding instead of asynchronous.
1070 The device used by pppd with this option must have sync support.
1071 Currently supports Microgate SyncLink adapters
1072 under Linux and FreeBSD 2.2.8 and later.
1073 .TP
1074 .B unit \fInum
1075 Sets the ppp unit number (for a ppp0 or ppp1 etc interface name) for outbound
1076 connections.
1077 .TP
1078 .B unset \fIname
1079 Remove a variable from the environment variable for scripts that are
1080 invoked by pppd.  When specified by a privileged source, the variable
1081 \fIname\fR cannot be set by options contained in an unprivileged
1082 source.  See also the \fIset\fR option and the environment described
1083 in \fISCRIPTS\fR.
1084 .TP
1085 .B updetach
1086 With this option, pppd will detach from its controlling terminal once
1087 it has successfully established the ppp connection (to the point where
1088 the first network control protocol, usually the IP control protocol,
1089 has come up).
1090 .TP
1091 .B usehostname
1092 Enforce the use of the hostname (with domain name appended, if given)
1093 as the name of the local system for authentication purposes (overrides
1094 the \fIname\fR option).  This option is not normally needed since the
1095 \fIname\fR option is privileged.
1096 .TP
1097 .B usepeerdns
1098 Ask the peer for up to 2 DNS server addresses.  The addresses supplied
1099 by the peer (if any) are passed to the /etc/ppp/ip\-up script in the
1100 environment variables DNS1 and DNS2, and the environment variable
1101 USEPEERDNS will be set to 1.  In addition, pppd will create an
1102 /etc/ppp/resolv.conf file containing one or two nameserver lines with
1103 the address(es) supplied by the peer.
1104 .TP
1105 .B user \fIname
1106 Sets the name used for authenticating the local system to the peer to
1107 \fIname\fR.
1108 .TP
1109 .B vj\-max\-slots \fIn
1110 Sets the number of connection slots to be used by the Van Jacobson
1111 TCP/IP header compression and decompression code to \fIn\fR, which
1112 must be between 2 and 16 (inclusive).
1113 .TP
1114 .B welcome \fIscript
1115 Run the executable or shell command specified by \fIscript\fR before
1116 initiating PPP negotiation, after the connect script (if any) has
1117 completed.  A value for this option from a privileged source cannot be
1118 overridden by a non-privileged user.
1119 .TP
1120 .B xonxoff
1121 Use software flow control (i.e. XON/XOFF) to control the flow of data on
1122 the serial port.
1123 .SH OPTIONS FILES
1124 Options can be taken from files as well as the command line.  Pppd
1125 reads options from the files /etc/ppp/options, ~/.ppprc and
1126 /etc/ppp/options.\fIttyname\fR (in that order) before processing the
1127 options on the command line.  (In fact, the command-line options are
1128 scanned to find the terminal name before the options.\fIttyname\fR
1129 file is read.)  In forming the name of the options.\fIttyname\fR file,
1130 the initial /dev/ is removed from the terminal name, and any remaining
1131 / characters are replaced with dots.
1132 .PP
1133 An options file is parsed into a series of words, delimited by
1134 whitespace.  Whitespace can be included in a word by enclosing the
1135 word in double-quotes (").  A backslash (\\) quotes the following character.
1136 A hash (#) starts a comment, which continues until the end of the
1137 line.  There is no restriction on using the \fIfile\fR or \fIcall\fR
1138 options within an options file.
1139 .SH SECURITY
1140 .I pppd
1141 provides system administrators with sufficient access control that PPP
1142 access to a server machine can be provided to legitimate users without
1143 fear of compromising the security of the server or the network it's
1144 on.  This control is provided through restrictions on which IP
1145 addresses the peer may use, based on its authenticated identity (if
1146 any), and through restrictions on which options a non-privileged user
1147 may use.  Several of pppd's options are privileged, in particular
1148 those which permit potentially insecure configurations; these options
1149 are only accepted in files which are under the control of the system
1150 administrator, or if pppd is being run by root.
1151 .PP
1152 The default behaviour of pppd is to allow an unauthenticated peer to
1153 use a given IP address only if the system does not already have a
1154 route to that IP address.  For example, a system with a
1155 permanent connection to the wider internet will normally have a
1156 default route, and thus all peers will have to authenticate themselves
1157 in order to set up a connection.  On such a system, the \fIauth\fR
1158 option is the default.  On the other hand, a system where the
1159 PPP link is the only connection to the internet will not normally have
1160 a default route, so the peer will be able to use almost any IP address
1161 without authenticating itself.
1162 .PP
1163 As indicated above, some security-sensitive options are privileged,
1164 which means that they may not be used by an ordinary non-privileged
1165 user running a setuid-root pppd, either on the command line, in the
1166 user's ~/.ppprc file, or in an options file read using the \fIfile\fR
1167 option.  Privileged options may be used in /etc/ppp/options file or in
1168 an options file read using the \fIcall\fR option.  If pppd is being
1169 run by the root user, privileged options can be used without
1170 restriction.
1171 .PP
1172 When opening the device, pppd uses either the invoking user's user ID
1173 or the root UID (that is, 0), depending on whether the device name was
1174 specified by the user or the system administrator.  If the device name
1175 comes from a privileged source, that is, /etc/ppp/options or an
1176 options file read using the \fIcall\fR option, pppd uses full root
1177 privileges when opening the device.  Thus, by creating an appropriate
1178 file under /etc/ppp/peers, the system administrator can allow users to
1179 establish a ppp connection via a device which they would not normally
1180 have permission to access.  Otherwise pppd uses the invoking user's
1181 real UID when opening the device.
1182 .SH AUTHENTICATION
1183 Authentication is the process whereby one peer convinces the other of
1184 its identity.  This involves the first peer sending its name to the
1185 other, together with some kind of secret information which could only
1186 come from the genuine authorized user of that name.  In such an
1187 exchange, we will call the first peer the "client" and the other the
1188 "server".  The client has a name by which it identifies itself to the
1189 server, and the server also has a name by which it identifies itself
1190 to the client.  Generally the genuine client shares some secret (or
1191 password) with the server, and authenticates itself by proving that it
1192 knows that secret.  Very often, the names used for authentication
1193 correspond to the internet hostnames of the peers, but this is not
1194 essential.
1195 .LP
1196 At present, pppd supports three authentication protocols: the Password
1197 Authentication Protocol (PAP), Challenge Handshake Authentication
1198 Protocol (CHAP), and Extensible Authentication Protocol (EAP).  PAP
1199 involves the client sending its name and a cleartext password to the
1200 server to authenticate itself.  In contrast, the server initiates the
1201 CHAP authentication exchange by sending a challenge to the client (the
1202 challenge packet includes the server's name).  The client must respond
1203 with a response which includes its name plus a hash value derived from
1204 the shared secret and the challenge, in order to prove that it knows
1205 the secret.  EAP supports CHAP-style authentication, and also includes
1206 the SRP\-SHA1 mechanism, which is resistant to dictionary-based attacks
1207 and does not require a cleartext password on the server side.
1208 .LP
1209 The PPP protocol, being symmetrical, allows both peers to require the
1210 other to authenticate itself.  In that case, two separate and
1211 independent authentication exchanges will occur.  The two exchanges
1212 could use different authentication protocols, and in principle,
1213 different names could be used in the two exchanges.
1214 .LP
1215 The default behaviour of pppd is to agree to authenticate if
1216 requested, and to not require authentication from the peer.  However,
1217 pppd will not agree to authenticate itself with a particular protocol
1218 if it has no secrets which could be used to do so.
1219 .LP
1220 Pppd stores secrets for use in authentication in secrets
1221 files (/etc/ppp/pap\-secrets for PAP, /etc/ppp/chap\-secrets for CHAP,
1222 MS\-CHAP, MS\-CHAPv2, and EAP MD5-Challenge, and /etc/ppp/srp\-secrets
1223 for EAP SRP\-SHA1).
1224 All secrets files have the same format.  The secrets files can
1225 contain secrets for pppd to use in authenticating itself to other
1226 systems, as well as secrets for pppd to use when authenticating other
1227 systems to itself.
1228 .LP
1229 Each line in a secrets file contains one secret.  A given secret is
1230 specific to a particular combination of client and server - it can
1231 only be used by that client to authenticate itself to that server.
1232 Thus each line in a secrets file has at least 3 fields: the name of
1233 the client, the name of the server, and the secret.  These fields may
1234 be followed by a list of the IP addresses that the specified client
1235 may use when connecting to the specified server.
1236 .LP
1237 A secrets file is parsed into words as for a options file, so the
1238 client name, server name and secrets fields must each be one word,
1239 with any embedded spaces or other special characters quoted or
1240 escaped.  Note that case is significant in the client and server names
1241 and in the secret.
1242 .LP
1243 If the secret starts with an `@', what follows is assumed to be the
1244 name of a file from which to read the secret.  A "*" as the client or
1245 server name matches any name.  When selecting a secret, pppd takes the
1246 best match, i.e.  the match with the fewest wildcards.
1247 .LP
1248 Any following words on the same line are taken to be a list of
1249 acceptable IP addresses for that client.  If there are only 3 words on
1250 the line, or if the first word is "\-", then all IP addresses are
1251 disallowed.  To allow any address, use "*".  A word starting with "!"
1252 indicates that the specified address is \fInot\fR acceptable.  An
1253 address may be followed by "/" and a number \fIn\fR, to indicate a
1254 whole subnet, i.e. all addresses which have the same value in the most
1255 significant \fIn\fR bits.  In this form, the address may be followed
1256 by a plus sign ("+") to indicate that one address from the subnet is
1257 authorized, based on the ppp network interface unit number in use.
1258 In this case, the host part of the address will be set to the unit
1259 number plus one.
1260 .LP
1261 Thus a secrets file contains both secrets for use in authenticating
1262 other hosts, plus secrets which we use for authenticating ourselves to
1263 others.  When pppd is authenticating the peer (checking the peer's
1264 identity), it chooses a secret with the peer's name in the first
1265 field and the name of the local system in the second field.  The
1266 name of the local system defaults to the hostname, with the domain
1267 name appended if the \fIdomain\fR option is used.  This default can be
1268 overridden with the \fIname\fR option, except when the
1269 \fIusehostname\fR option is used.  (For EAP SRP\-SHA1, see the
1270 srp\-entry(8) utility for generating proper validator entries to be
1271 used in the "secret" field.)
1272 .LP
1273 When pppd is choosing a secret to use in authenticating itself to the
1274 peer, it first determines what name it is going to use to identify
1275 itself to the peer.  This name can be specified by the user with the
1276 \fIuser\fR option.  If this option is not used, the name defaults to
1277 the name of the local system, determined as described in the previous
1278 paragraph.  Then pppd looks for a secret with this name in the first
1279 field and the peer's name in the second field.  Pppd will know the
1280 name of the peer if CHAP or EAP authentication is being used, because
1281 the peer will have sent it in the challenge packet.  However, if PAP
1282 is being used, pppd will have to determine the peer's name from the
1283 options specified by the user.  The user can specify the peer's name
1284 directly with the \fIremotename\fR option.  Otherwise, if the remote
1285 IP address was specified by a name (rather than in numeric form), that
1286 name will be used as the peer's name.  Failing that, pppd will use the
1287 null string as the peer's name.
1288 .LP
1289 When authenticating the peer with PAP, the supplied password is first
1290 compared with the secret from the secrets file.  If the password
1291 doesn't match the secret, the password is encrypted using crypt() and
1292 checked against the secret again.  Thus secrets for authenticating the
1293 peer can be stored in encrypted form if desired.  If the
1294 \fIpapcrypt\fR option is given, the first (unencrypted) comparison is
1295 omitted, for better security.
1296 .LP
1297 Furthermore, if the \fIlogin\fR option was specified, the username and
1298 password are also checked against the system password database.  Thus,
1299 the system administrator can set up the pap\-secrets file to allow PPP
1300 access only to certain users, and to restrict the set of IP addresses
1301 that each user can use.  Typically, when using the \fIlogin\fR option,
1302 the secret in /etc/ppp/pap\-secrets would be "", which will match any
1303 password supplied by the peer.  This avoids the need to have the same
1304 secret in two places.
1305 .LP
1306 Authentication must be satisfactorily completed before IPCP (or any
1307 other Network Control Protocol) can be started.  If the peer is
1308 required to authenticate itself, and fails to do so, pppd will
1309 terminated the link (by closing LCP).  If IPCP negotiates an
1310 unacceptable IP address for the remote host, IPCP will be closed.  IP
1311 packets can only be sent or received when IPCP is open.
1312 .LP
1313 In some cases it is desirable to allow some hosts which can't
1314 authenticate themselves to connect and use one of a restricted set of
1315 IP addresses, even when the local host generally requires
1316 authentication.  If the peer refuses to authenticate itself when
1317 requested, pppd takes that as equivalent to authenticating with PAP
1318 using the empty string for the username and password.  Thus, by adding
1319 a line to the pap\-secrets file which specifies the empty string for
1320 the client and password, it is possible to allow restricted access to
1321 hosts which refuse to authenticate themselves.
1322 .SH ROUTING
1323 .LP
1324 When IPCP negotiation is completed successfully, pppd will inform the
1325 kernel of the local and remote IP addresses for the ppp interface.
1326 This is sufficient to create a host route to the remote end of the
1327 link, which will enable the peers to exchange IP packets.
1328 Communication with other machines generally requires further
1329 modification to routing tables and/or ARP (Address Resolution
1330 Protocol) tables.  In most cases the \fIdefaultroute\fR and/or
1331 \fIproxyarp\fR options are sufficient for this, but in some cases
1332 further intervention is required.  The /etc/ppp/ip\-up script can be
1333 used for this.
1334 .LP
1335 Sometimes it is desirable to add a default route through the remote
1336 host, as in the case of a machine whose only connection to the
1337 Internet is through the ppp interface.  The \fIdefaultroute\fR option
1338 causes pppd to create such a default route when IPCP comes up, and
1339 delete it when the link is terminated.
1340 .LP
1341 In some cases it is desirable to use proxy ARP, for example on a
1342 server machine connected to a LAN, in order to allow other hosts to
1343 communicate with the remote host.  The \fIproxyarp\fR option causes
1344 pppd to look for a network interface on the same subnet as the remote
1345 host (an interface supporting broadcast and ARP, which is up and not a
1346 point-to-point or loopback interface).  If found, pppd creates a
1347 permanent, published ARP entry with the IP address of the remote host
1348 and the hardware address of the network interface found.
1349 .LP
1350 When the \fIdemand\fR option is used, the interface IP addresses have
1351 already been set at the point when IPCP comes up.  If pppd has not
1352 been able to negotiate the same addresses that it used to configure
1353 the interface (for example when the peer is an ISP that uses dynamic
1354 IP address assignment), pppd has to change the interface IP addresses
1355 to the negotiated addresses.  This may disrupt existing connections,
1356 and the use of demand dialling with peers that do dynamic IP address
1357 assignment is not recommended.
1358 .SH MULTILINK
1359 Multilink PPP provides the capability to combine two or more PPP links
1360 between a pair of machines into a single `bundle', which appears as a
1361 single virtual PPP link which has the combined bandwidth of the
1362 individual links.  Currently, multilink PPP is only supported under
1363 Linux.
1364 .LP
1365 Pppd detects that the link it is controlling is connected to the same
1366 peer as another link using the peer's endpoint discriminator and the
1367 authenticated identity of the peer (if it authenticates itself).  The
1368 endpoint discriminator is a block of data which is hopefully unique
1369 for each peer.  Several types of data can be used, including
1370 locally-assigned strings of bytes, IP addresses, MAC addresses,
1371 randomly strings of bytes, or E\-164 phone numbers.  The endpoint
1372 discriminator sent to the peer by pppd can be set using the endpoint
1373 option.
1374 .LP
1375 In some circumstances the peer may send no endpoint discriminator or a
1376 non-unique value.  The bundle option adds an extra string which is
1377 added to the peer's endpoint discriminator and authenticated identity
1378 when matching up links to be joined together in a bundle.  The bundle
1379 option can also be used to allow the establishment of multiple bundles
1380 between the local system and the peer.  Pppd uses a TDB database in
1381 /var/run/pppd2.tdb to match up links.
1382 .LP
1383 Assuming that multilink is enabled and the peer is willing to
1384 negotiate multilink, then when pppd is invoked to bring up the first
1385 link to the peer, it will detect that no other link is connected to
1386 the peer and create a new bundle, that is, another ppp network
1387 interface unit.  When another pppd is invoked to bring up another link
1388 to the peer, it will detect the existing bundle and join its link to
1389 it.
1390 .LP
1391 If the first link terminates (for example, because of a hangup or a
1392 received LCP terminate-request) the bundle is not destroyed unless
1393 there are no other links remaining in the bundle.  Rather than
1394 exiting, the first pppd keeps running after its link terminates, until
1395 all the links in the bundle have terminated.  If the first pppd
1396 receives a SIGTERM or SIGINT signal, it will destroy the bundle and
1397 send a SIGHUP to the pppd processes for each of the links in the
1398 bundle.  If the first pppd receives a SIGHUP signal, it will terminate
1399 its link but not the bundle.
1400 .LP
1401 Note: demand mode is not currently supported with multilink.
1402 .SH EXAMPLES
1403 .LP
1404 The following examples assume that the /etc/ppp/options file contains
1405 the \fIauth\fR option (as in the default /etc/ppp/options file in the
1406 ppp distribution).
1407 .LP
1408 Probably the most common use of pppd is to dial out to an ISP.  This
1409 can be done with a command such as
1410 .IP
1411 pppd call isp
1412 .LP
1413 where the /etc/ppp/peers/isp file is set up by the system
1414 administrator to contain something like this:
1415 .IP
1416 ttyS0 19200 crtscts
1417 .br
1418 connect '/usr/sbin/chat \-v \-f /etc/ppp/chat\-isp'
1419 .br
1420 noauth
1421 .LP
1422 In this example, we are using chat to dial the ISP's modem and go
1423 through any logon sequence required.  The /etc/ppp/chat\-isp file
1424 contains the script used by chat; it could for example contain
1425 something like this:
1426 .IP
1427 ABORT "NO CARRIER"
1428 .br
1429 ABORT "NO DIALTONE"
1430 .br
1431 ABORT "ERROR"
1432 .br
1433 ABORT "NO ANSWER"
1434 .br
1435 ABORT "BUSY"
1436 .br
1437 ABORT "Username/Password Incorrect"
1438 .br
1439 "" "at"
1440 .br
1441 OK "at&d0&c1"
1442 .br
1443 OK "atdt2468135"
1444 .br
1445 "name:" "^Umyuserid"
1446 .br
1447 "word:" "\\qmypassword"
1448 .br
1449 "ispts" "\\q^Uppp"
1450 .br
1451 "~\-^Uppp\-~"
1452 .LP
1453 See the chat(8) man page for details of chat scripts.
1454 .LP
1455 Pppd can also be used to provide a dial-in ppp service for users.  If
1456 the users already have login accounts, the simplest way to set up the
1457 ppp service is to let the users log in to their accounts and run pppd
1458 (installed setuid-root) with a command such as
1459 .IP
1460 pppd proxyarp
1461 .LP
1462 To allow a user to use the PPP facilities, you need to allocate an IP
1463 address for that user's machine and create an entry in
1464 /etc/ppp/pap\-secrets, /etc/ppp/chap\-secrets, or /etc/ppp/srp\-secrets
1465 (depending on which authentication method the PPP implementation on
1466 the user's machine supports), so that the user's machine can
1467 authenticate itself.  For example, if Joe has a machine called
1468 "joespc" that is to be allowed to dial in to the machine called
1469 "server" and use the IP address joespc.my.net, you would add an entry
1470 like this to /etc/ppp/pap\-secrets or /etc/ppp/chap\-secrets:
1471 .IP
1472 joespc  server  "joe's secret"  joespc.my.net
1473 .LP
1474 (See srp\-entry(8) for a means to generate the server's entry when
1475 SRP\-SHA1 is in use.)
1476 Alternatively, you can create a username called (for example) "ppp",
1477 whose login shell is pppd and whose home directory is /etc/ppp.
1478 Options to be used when pppd is run this way can be put in
1479 /etc/ppp/.ppprc.
1480 .LP
1481 If your serial connection is any more complicated than a piece of
1482 wire, you may need to arrange for some control characters to be
1483 escaped.  In particular, it is often useful to escape XON (^Q) and
1484 XOFF (^S), using \fIasyncmap a0000\fR.  If the path includes a telnet,
1485 you probably should escape ^] as well (\fIasyncmap 200a0000\fR).  If
1486 the path includes an rlogin, you will need to use the \fIescape ff\fR
1487 option on the end which is running the rlogin client, since many
1488 rlogin implementations are not transparent; they will remove the
1489 sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the
1490 stream.
1491 .SH DIAGNOSTICS
1492 .LP
1493 Messages are sent to the syslog daemon using facility LOG_DAEMON.
1494 (This can be overridden by recompiling pppd with the macro
1495 LOG_PPP defined as the desired facility.)  See the syslog(8)
1496 documentation for details of where the syslog daemon will write the
1497 messages.  On most systems, the syslog daemon uses the
1498 /etc/syslog.conf file to specify the destination(s) for syslog
1499 messages.  You may need to edit that file to suit.
1500 .LP
1501 The \fIdebug\fR option causes the contents of all control packets sent
1502 or received to be logged, that is, all LCP, PAP, CHAP, EAP, or IPCP packets.
1503 This can be useful if the PPP negotiation does not succeed or if
1504 authentication fails.
1505 If debugging is enabled at compile time, the \fIdebug\fR option also
1506 causes other debugging messages to be logged.
1507 .LP
1508 Debugging can also be enabled or disabled by sending a SIGUSR1 signal
1509 to the pppd process.  This signal acts as a toggle.
1510 .SH EXIT STATUS
1511 The exit status of pppd is set to indicate whether any error was
1512 detected, or the reason for the link being terminated.  The values
1513 used are:
1514 .TP
1515 .B 0
1516 Pppd has detached, or otherwise the connection was successfully
1517 established and terminated at the peer's request.
1518 .TP
1519 .B 1
1520 An immediately fatal error of some kind occurred, such as an essential
1521 system call failing, or running out of virtual memory.
1522 .TP
1523 .B 2
1524 An error was detected in processing the options given, such as two
1525 mutually exclusive options being used.
1526 .TP
1527 .B 3
1528 Pppd is not setuid-root and the invoking user is not root.
1529 .TP
1530 .B 4
1531 The kernel does not support PPP, for example, the PPP kernel driver is
1532 not included or cannot be loaded.
1533 .TP
1534 .B 5
1535 Pppd terminated because it was sent a SIGINT, SIGTERM or SIGHUP
1536 signal.
1537 .TP
1538 .B 6
1539 The serial port could not be locked.
1540 .TP
1541 .B 7
1542 The serial port could not be opened.
1543 .TP
1544 .B 8
1545 The connect script failed (returned a non-zero exit status).
1546 .TP
1547 .B 9
1548 The command specified as the argument to the \fIpty\fR option could
1549 not be run.
1550 .TP
1551 .B 10
1552 The PPP negotiation failed, that is, it didn't reach the point where
1553 at least one network protocol (e.g. IP) was running.
1554 .TP
1555 .B 11
1556 The peer system failed (or refused) to authenticate itself.
1557 .TP
1558 .B 12
1559 The link was established successfully and terminated because it was
1560 idle.
1561 .TP
1562 .B 13
1563 The link was established successfully and terminated because the
1564 connect time limit was reached.
1565 .TP
1566 .B 14
1567 Callback was negotiated and an incoming call should arrive shortly.
1568 .TP
1569 .B 15
1570 The link was terminated because the peer is not responding to echo
1571 requests.
1572 .TP
1573 .B 16
1574 The link was terminated by the modem hanging up.
1575 .TP
1576 .B 17
1577 The PPP negotiation failed because serial loopback was detected.
1578 .TP
1579 .B 18
1580 The init script failed (returned a non-zero exit status).
1581 .TP
1582 .B 19
1583 We failed to authenticate ourselves to the peer.
1584 .SH SCRIPTS
1585 Pppd invokes scripts at various stages in its processing which can be
1586 used to perform site-specific ancillary processing.  These scripts are
1587 usually shell scripts, but could be executable code files instead.
1588 Pppd does not wait for the scripts to finish (except for the ip-pre-up
1589 script).  The scripts are
1590 executed as root (with the real and effective user-id set to 0), so
1591 that they can do things such as update routing tables or run
1592 privileged daemons.  Be careful that the contents of these scripts do
1593 not compromise your system's security.  Pppd runs the scripts with
1594 standard input, output and error redirected to /dev/null, and with an
1595 environment that is empty except for some environment variables that
1596 give information about the link.  The environment variables that pppd
1597 sets are:
1598 .TP
1599 .B DEVICE
1600 The name of the serial tty device being used.
1601 .TP
1602 .B IFNAME
1603 The name of the network interface being used.
1604 .TP
1605 .B IPLOCAL
1606 The IP address for the local end of the link.  This is only set when
1607 IPCP has come up.
1608 .TP
1609 .B IPREMOTE
1610 The IP address for the remote end of the link.  This is only set when
1611 IPCP has come up.
1612 .TP
1613 .B PEERNAME
1614 The authenticated name of the peer.  This is only set if the peer
1615 authenticates itself.
1616 .TP
1617 .B SPEED
1618 The baud rate of the tty device.
1619 .TP
1620 .B ORIG_UID
1621 The real user-id of the user who invoked pppd.
1622 .TP
1623 .B PPPLOGNAME
1624 The username of the real user-id that invoked pppd. This is always set.
1625 .P
1626 For the ip-down and auth-down scripts, pppd also sets the following
1627 variables giving statistics for the connection:
1628 .TP
1629 .B CONNECT_TIME
1630 The number of seconds from when the PPP negotiation started until the
1631 connection was terminated.
1632 .TP
1633 .B BYTES_SENT
1634 The number of bytes sent (at the level of the serial port) during the
1635 connection.
1636 .TP
1637 .B BYTES_RCVD
1638 The number of bytes received (at the level of the serial port) during
1639 the connection.
1640 .TP
1641 .B LINKNAME
1642 The logical name of the link, set with the \fIlinkname\fR option.
1643 .TP
1644 .B DNS1
1645 If the peer supplies DNS server addresses, this variable is set to the
1646 first DNS server address supplied (whether or not the usepeerdns
1647 option was given).
1648 .TP
1649 .B DNS2
1650 If the peer supplies DNS server addresses, this variable is set to the
1651 second DNS server address supplied (whether or not the usepeerdns
1652 option was given).
1653 .P
1654 Pppd invokes the following scripts, if they exist.  It is not an error
1655 if they don't exist.
1656 .TP
1657 .B /etc/ppp/auth\-up
1658 A program or script which is executed after the remote system
1659 successfully authenticates itself.  It is executed with the parameters
1660 .IP
1661 \fIinterface\-name peer\-name user\-name tty\-device speed\fR
1662 .IP
1663 Note that this script is not executed if the peer doesn't authenticate
1664 itself, for example when the \fInoauth\fR option is used.
1665 .TP
1666 .B /etc/ppp/auth\-down
1667 A program or script which is executed when the link goes down, if
1668 /etc/ppp/auth\-up was previously executed.  It is executed in the same
1669 manner with the same parameters as /etc/ppp/auth\-up.
1670 .TP
1671 .B /etc/ppp/ip\-pre\-up
1672 A program or script which is executed just before the ppp network
1673 interface is brought up.  It is executed with the same parameters as
1674 the ip\-up script (below).  At this point the interface exists and has
1675 IP addresses assigned but is still down.  This can be used to
1676 add firewall rules before any IP traffic can pass through the
1677 interface.  Pppd will wait for this script to finish before bringing
1678 the interface up, so this script should run quickly.
1679 .TP
1680 .B /etc/ppp/ip\-up
1681 A program or script which is executed when the link is available for
1682 sending and receiving IP packets (that is, IPCP has come up).  It is
1683 executed with the parameters
1684 .IP
1685 \fIinterface\-name tty\-device speed local\-IP\-address
1686 remote\-IP\-address ipparam\fR
1687 .TP
1688 .B /etc/ppp/ip\-down
1689 A program or script which is executed when the link is no longer
1690 available for sending and receiving IP packets.  This script can be
1691 used for undoing the effects of the /etc/ppp/ip\-up and
1692 /etc/ppp/ip\-pre\-up scripts.  It is
1693 invoked in the same manner and with the same parameters as the ip\-up
1694 script.
1695 .TP
1696 .B /etc/ppp/ipv6\-up
1697 Like /etc/ppp/ip\-up, except that it is executed when the link is available 
1698 for sending and receiving IPv6 packets. It is executed with the parameters
1699 .IP
1700 \fIinterface\-name tty\-device speed local\-link\-local\-address
1701 remote\-link\-local\-address ipparam\fR
1702 .TP
1703 .B /etc/ppp/ipv6\-down
1704 Similar to /etc/ppp/ip\-down, but it is executed when IPv6 packets can no
1705 longer be transmitted on the link. It is executed with the same parameters 
1706 as the ipv6\-up script.
1707 .TP
1708 .B /etc/ppp/ipx\-up
1709 A program or script which is executed when the link is available for
1710 sending and receiving IPX packets (that is, IPXCP has come up).  It is
1711 executed with the parameters
1712 .IP
1713 \fIinterface\-name tty\-device speed network\-number local\-IPX\-node\-address
1714 remote\-IPX\-node\-address local\-IPX\-routing\-protocol remote\-IPX\-routing\-protocol
1715 local\-IPX\-router\-name remote\-IPX\-router\-name ipparam pppd\-pid\fR 
1716 .IP
1717 The local\-IPX\-routing\-protocol and remote\-IPX\-routing\-protocol field
1718 may be one of the following:
1719 .IP
1720 NONE      to indicate that there is no routing protocol
1721 .br
1722 RIP       to indicate that RIP/SAP should be used
1723 .br
1724 NLSP      to indicate that Novell NLSP should be used
1725 .br
1726 RIP NLSP  to indicate that both RIP/SAP and NLSP should be used
1727 .TP
1728 .B /etc/ppp/ipx\-down
1729 A program or script which is executed when the link is no longer
1730 available for sending and receiving IPX packets.  This script can be
1731 used for undoing the effects of the /etc/ppp/ipx\-up script.  It is
1732 invoked in the same manner and with the same parameters as the ipx\-up
1733 script.
1734 .SH FILES
1735 .TP
1736 .B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others)
1737 Process-ID for pppd process on ppp interface unit \fIn\fR.
1738 .TP
1739 .B /var/run/ppp\-\fIname\fB.pid \fR(BSD or Linux),
1740 \fB/etc/ppp/ppp\-\fIname\fB.pid \fR(others)
1741 Process-ID for pppd process for logical link \fIname\fR (see the
1742 \fIlinkname\fR option).
1743 .TP
1744 .B /var/run/pppd2.tdb
1745 Database containing information about pppd processes, interfaces and
1746 links, used for matching links to bundles in multilink operation.  May
1747 be examined by external programs to obtain information about running
1748 pppd instances, the interfaces and devices they are using, IP address
1749 assignments, etc.
1750 .B /etc/ppp/pap\-secrets
1751 Usernames, passwords and IP addresses for PAP authentication.  This
1752 file should be owned by root and not readable or writable by any other
1753 user.  Pppd will log a warning if this is not the case.
1754 .TP
1755 .B /etc/ppp/chap\-secrets
1756 Names, secrets and IP addresses for CHAP/MS\-CHAP/MS\-CHAPv2 authentication.
1757 As for /etc/ppp/pap\-secrets, this file should be owned by root and not
1758 readable or writable by any other user.  Pppd will log a warning if
1759 this is not the case.
1760 .TP
1761 .B /etc/ppp/srp\-secrets
1762 Names, secrets, and IP addresses for EAP authentication.  As for
1763 /etc/ppp/pap\-secrets, this file should be owned by root and not
1764 readable or writable by any other user.  Pppd will log a warning if
1765 this is not the case.
1766 .TP
1767 .B ~/.ppp_pseudonym
1768 Saved client-side SRP\-SHA1 pseudonym.  See the \fIsrp\-use\-pseudonym\fR
1769 option for details.
1770 .TP
1771 .B /etc/ppp/options
1772 System default options for pppd, read before user default options or
1773 command-line options.
1774 .TP
1775 .B ~/.ppprc
1776 User default options, read before /etc/ppp/options.\fIttyname\fR.
1777 .TP
1778 .B /etc/ppp/options.\fIttyname
1779 System default options for the serial port being used, read after
1780 ~/.ppprc.  In forming the \fIttyname\fR part of this
1781 filename, an initial /dev/ is stripped from the port name (if
1782 present), and any slashes in the remaining part are converted to
1783 dots.
1784 .TP
1785 .B /etc/ppp/peers
1786 A directory containing options files which may contain privileged
1787 options, even if pppd was invoked by a user other than root.  The
1788 system administrator can create options files in this directory to
1789 permit non-privileged users to dial out without requiring the peer to
1790 authenticate, but only to certain trusted peers.
1791 .SH SEE ALSO
1792 .BR chat (8),
1793 .BR pppstats (8)
1794 .TP
1795 .B RFC1144
1796 Jacobson, V.
1797 \fICompressing TCP/IP headers for low-speed serial links.\fR
1798 February 1990.
1799 .TP
1800 .B RFC1321
1801 Rivest, R.
1802 .I The MD5 Message-Digest Algorithm.
1803 April 1992.
1804 .TP
1805 .B RFC1332
1806 McGregor, G.
1807 .I PPP Internet Protocol Control Protocol (IPCP).
1808 May 1992.
1809 .TP
1810 .B RFC1334
1811 Lloyd, B.; Simpson, W.A.
1812 .I PPP authentication protocols.
1813 October 1992.
1814 .TP
1815 .B RFC1661
1816 Simpson, W.A.
1817 .I The Point-to-Point Protocol (PPP).
1818 July 1994.
1819 .TP
1820 .B RFC1662
1821 Simpson, W.A.
1822 .I PPP in HDLC-like Framing.
1823 July 1994.
1824 .TP
1825 .B RFC2284
1826 Blunk, L.; Vollbrecht, J.,
1827 .I PPP Extensible Authentication Protocol (EAP).
1828 March 1998.
1829 .TP
1830 .B RFC2472
1831 Haskin, D.
1832 .I IP Version 6 over PPP
1833 December 1998.
1834 .TP
1835 .B RFC2945
1836 Wu, T.,
1837 .I The SRP Authentication and Key Exchange System
1838 September 2000.
1839 .TP
1840 .B draft\-ietf\-pppext\-eap\-srp\-03.txt
1841 Carlson, J.; et al.,
1842 .I EAP SRP\-SHA1 Authentication Protocol.
1843 July 2001.
1844 .SH NOTES
1845 Some limited degree of control can be exercised over a running pppd
1846 process by sending it a signal from the list below.
1847 .TP
1848 .B SIGINT, SIGTERM
1849 These signals cause pppd to terminate the link (by closing LCP),
1850 restore the serial device settings, and exit.  If a connector or
1851 disconnector process is currently running, pppd will send the same
1852 signal to its process group, so as to terminate the connector or
1853 disconnector process.
1854 .TP
1855 .B SIGHUP
1856 This signal causes pppd to terminate the link, restore the serial
1857 device settings, and close the serial device.  If the \fIpersist\fR or
1858 \fIdemand\fR option has been specified, pppd will try to reopen the
1859 serial device and start another connection (after the holdoff period).
1860 Otherwise pppd will exit.  If this signal is received during the
1861 holdoff period, it causes pppd to end the holdoff period immediately.
1862 If a connector or disconnector process is running, pppd will send the
1863 same signal to its process group.
1864 .TP
1865 .B SIGUSR1
1866 This signal toggles the state of the \fIdebug\fR option.
1867 .TP
1868 .B SIGUSR2
1869 This signal causes pppd to renegotiate compression.  This can be
1870 useful to re-enable compression after it has been disabled as a result
1871 of a fatal decompression error.  (Fatal decompression errors generally
1872 indicate a bug in one or other implementation.)
1873
1874 .SH AUTHORS
1875 Paul Mackerras (paulus@samba.org), based on earlier work by
1876 Drew Perkins,
1877 Brad Clements,
1878 Karl Fox,
1879 Greg Christy,
1880 and
1881 Brad Parker.
1882
1883 .SH COPYRIGHT
1884 Pppd is copyrighted and made available under conditions which provide
1885 that it may be copied and used in source or binary forms provided that
1886 the conditions listed below are met.  Portions of pppd are covered by
1887 the following copyright notices:
1888 .LP
1889 Copyright (c) 1984-2000 Carnegie Mellon University. All rights
1890 reserved.
1891 .br
1892 Copyright (c) 1993-2004 Paul Mackerras. All rights reserved.
1893 .br
1894 Copyright (c) 1995 Pedro Roque Marques.  All rights reserved.
1895 .br
1896 Copyright (c) 1995 Eric Rosenquist.  All rights reserved.
1897 .br
1898 Copyright (c) 1999 Tommi Komulainen.  All rights reserved.
1899 .br
1900 Copyright (C) Andrew Tridgell 1999
1901 .br
1902 Copyright (c) 2000 by Sun Microsystems, Inc.  All rights reserved.
1903 .br
1904 Copyright (c) 2001 by Sun Microsystems, Inc.  All rights reserved.
1905 .br
1906 Copyright (c) 2002 Google, Inc.  All rights reserved.
1907 .LP
1908 The copyright notices contain the following statements.
1909 .LP
1910 Redistribution and use in source and binary forms, with or without
1911 modification, are permitted provided that the following conditions
1912 are met:
1913 .LP
1914 1. Redistributions of source code must retain the above copyright
1915    notice, this list of conditions and the following disclaimer.
1916 .LP
1917 2. Redistributions in binary form must reproduce the above copyright
1918    notice, this list of conditions and the following disclaimer in
1919    the documentation and/or other materials provided with the
1920    distribution.
1921 .LP
1922 3. The name "Carnegie Mellon University" must not be used to
1923    endorse or promote products derived from this software without
1924    prior written permission. For permission or any legal
1925    details, please contact
1926 .br
1927      Office of Technology Transfer
1928 .br
1929      Carnegie Mellon University
1930 .br
1931      5000 Forbes Avenue
1932 .br
1933      Pittsburgh, PA  15213-3890
1934 .br
1935      (412) 268-4387, fax: (412) 268-7395
1936 .br
1937      tech-transfer@andrew.cmu.edu
1938 .LP
1939 3b. The name(s) of the authors of this software must not be used to
1940    endorse or promote products derived from this software without
1941    prior written permission.
1942 .LP
1943 4. Redistributions of any form whatsoever must retain the following
1944    acknowledgements:
1945 .br
1946    "This product includes software developed by Computing Services
1947     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
1948 .br
1949    "This product includes software developed by Paul Mackerras
1950     <paulus@samba.org>".
1951 .br
1952    "This product includes software developed by Pedro Roque Marques
1953     <pedro_m@yahoo.com>".
1954 .br
1955    "This product includes software developed by Tommi Komulainen
1956     <Tommi.Komulainen@iki.fi>".
1957 .LP
1958 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
1959 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1960 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
1961 FOR ANY 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.
1965 .LP
1966 THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
1967 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1968 AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
1969 SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1970 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
1971 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
1972 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.