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