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