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