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