Because of a bug in zlib, restrict deflate parameter to 9..15 for now.
[ppp.git] / pppd / pppd.8
1 .\" manual page [] for pppd 2.4
2 .\" $Id: pppd.8,v 1.55 2001/02/22 03:10:05 paulus Exp $
3 .\" SH section heading
4 .\" SS subsection heading
5 .\" LP paragraph
6 .\" IP indented paragraph
7 .\" TP hanging label
8 .TH PPPD 8
10 pppd \- Point to Point Protocol daemon
12 .B pppd
13 [
14 .I tty_name
15 ] [
16 .I speed
17 ] [
18 .I options
19 ]
21 .LP
22 The Point-to-Point Protocol (PPP) provides a method for transmitting
23 datagrams over serial point-to-point links.  PPP
24 is composed of three parts: a method for encapsulating datagrams over
25 serial links, an extensible Link Control Protocol (LCP), and
26 a family of Network Control Protocols (NCP) for establishing
27 and configuring different network-layer protocols.
28 .LP
29 The encapsulation scheme is provided by driver code in the kernel.
30 Pppd provides the basic LCP, authentication support, and an NCP for
31 establishing and configuring the Internet Protocol (IP) (called the IP
32 Control Protocol, IPCP).
34 .TP
35 .I <tty_name>
36 Communicate over the named device.  The string "/dev/" is prepended if
37 necessary.  If no device name is given, or if the name of the terminal
38 connected to the standard input is given, pppd will use that terminal,
39 and will not fork to put itself in the background.  A value for this
40 option from a privileged source cannot be overridden by a
41 non-privileged user.
42 .TP
43 .I <speed>
44 Set the baud rate to <speed> (a decimal number).  On systems such as
45 4.4BSD and NetBSD, any speed can be specified.  Other systems
46 (e.g. SunOS) allow only a limited set of speeds.
47 .TP
48 .B asyncmap \fI<map>
49 Set the async character map to <map>.  This map describes which
50 control characters cannot be successfully received over the serial
51 line.  Pppd will ask the peer to send these characters as a 2-byte
52 escape sequence.  The argument is a 32 bit hex number with each bit
53 representing a character to escape.  Bit 0 (00000001) represents the
54 character 0x00; bit 31 (80000000) represents the character 0x1f or ^_.
55 If multiple \fIasyncmap\fR options are given, the values are ORed
56 together.  If no \fIasyncmap\fR option is given, no async character
57 map will be negotiated for the receive direction; the peer should then
58 escape \fIall\fR control characters.  To escape transmitted
59 characters, use the \fIescape\fR option.
60 .TP
61 .B auth
62 Require the peer to authenticate itself before allowing network
63 packets to be sent or received.  This option is the default if the
64 system has a default route.  If neither this option nor the
65 \fInoauth\fR option is specified, pppd will only allow the peer to use
66 IP addresses to which the system does not already have a route.
67 .TP
68 .B call \fIname
69 Read options from the file /etc/ppp/peers/\fIname\fR.  This file may
70 contain privileged options, such as \fInoauth\fR, even if pppd
71 is not being run by root.  The \fIname\fR string may not begin with /
72 or include .. as a pathname component.  The format of the options file
73 is described below.
74 .TP
75 .B connect \fIscript
76 Use the executable or shell command specified by \fIscript\fR to set
77 up the serial line.  This script would typically use the chat(8)
78 program to dial the modem and start the remote ppp session.  A value
79 for this option from a privileged source cannot be overridden by a
80 non-privileged user.
81 .TP
82 .B crtscts
83 Use hardware flow control (i.e. RTS/CTS) to control the flow of
84 data on the serial port.  If neither the \fIcrtscts\fR, the
85 \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR option
86 is given, the hardware flow control setting for the serial port is
87 left unchanged.
88 Some serial ports (such as Macintosh serial ports) lack a true
89 RTS output. Such serial ports use this mode to implement
90 unidirectional flow control. The serial port will
91 suspend transmission when requested by the modem (via CTS)
92 but will be unable to request the modem stop sending to the
93 computer. This mode retains the ability to use DTR as
94 a modem control line.
95 .TP
96 .B defaultroute
97 Add a default route to the system routing tables, using the peer as
98 the gateway, when IPCP negotiation is successfully completed.
99 This entry is removed when the PPP connection is broken.  This option
100 is privileged if the \fInodefaultroute\fR option has been specified.
101 .TP
102 .B disconnect \fIscript
103 Run the executable or shell command specified by \fIscript\fR after
104 pppd has terminated the link.  This script could, for example, issue
105 commands to the modem to cause it to hang up if hardware modem control
106 signals were not available.  The disconnect script is not run if the
107 modem has already hung up.  A value for this option from a privileged
108 source cannot be overridden by a non-privileged user.
109 .TP
110 .B escape \fIxx,yy,...
111 Specifies that certain characters should be escaped on transmission
112 (regardless of whether the peer requests them to be escaped with its
113 async control character map).  The characters to be escaped are
114 specified as a list of hex numbers separated by commas.  Note that
115 almost any character can be specified for the \fIescape\fR option,
116 unlike the \fIasyncmap\fR option which only allows control characters
117 to be specified.  The characters which may not be escaped are those
118 with hex values 0x20 - 0x3f or 0x5e.
119 .TP
120 .B file \fIname
121 Read options from file \fIname\fR (the format is described below).
122 The file must be readable by the user who has invoked pppd.
123 .TP
124 .B init \fIscript
125 Run the executable or shell command specified by \fIscript\fR to
126 initialize the serial line.  This script would typically use the
127 chat(8) program to configure the modem to enable auto answer.  A value
128 for this option from a privileged source cannot be overridden by a
129 non-privileged user.
130 .TP
131 .B lock
132 Specifies that pppd should create a UUCP-style lock file for the
133 serial device to ensure exclusive access to the device.
134 .TP
135 .B mru \fIn
136 Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd
137 will ask the peer to send packets of no more than \fIn\fR bytes.  The
138 minimum MRU value is 128.  The default MRU value is 1500.  A value of
139 296 is recommended for slow links (40 bytes for TCP/IP header + 256
140 bytes of data).  (Note that for IPv6 MRU must be at least 1280)
141 .TP
142 .B mtu \fIn
143 Set the MTU [Maximum Transmit Unit] value to \fIn\fR.  Unless the
144 peer requests a smaller value via MRU negotiation, pppd will
145 request that the kernel networking code send data packets of no more
146 than \fIn\fR bytes through the PPP network interface.  (Note that for 
147 IPv6 MTU must be at least 1280)
148 .TP
149 .B passive
150 Enables the "passive" option in the LCP.  With this option, pppd will
151 attempt to initiate a connection; if no reply is received from the
152 peer, pppd will then just wait passively for a valid LCP packet from
153 the peer, instead of exiting, as it would without this option.
155 .TP
156 .I <local_IP_address>\fB:\fI<remote_IP_address>
157 Set the local and/or remote interface IP addresses.  Either one may be
158 omitted.  The IP addresses can be specified with a host name or in
159 decimal dot notation (e.g.  The default local
160 address is the (first) IP address of the system (unless the
161 \fInoipdefault\fR
162 option is given).  The remote address will be obtained from the peer
163 if not specified in any option.  Thus, in simple cases, this option is
164 not required.  If a local and/or remote IP address is specified with
165 this option, pppd
166 will not accept a different value from the peer in the IPCP
167 negotiation, unless the \fIipcp-accept-local\fR and/or
168 \fIipcp-accept-remote\fR options are given, respectively.
169 .TP
170 .B ipv6 \fI<local_interface_identifier>\fR,\fI<remote_interface_identifier>
171 Set the local and/or remote 64-bit interface identifier. Either one may be
172 omitted. The identifier must be specified in standard ascii notation of
173 IPv6 addresses (e.g. ::dead:beef). If the
174 \fIipv6cp-use-ipaddr\fR
175 option is given, the local identifier is the local IPv4 address (see above).
176 On systems which supports a unique persistent id, such as EUI-48 derived
177 from the Ethernet MAC address, \fIipv6cp-use-persistent\fR option can be
178 used to replace the \fIipv6 <local>,<remote>\fR option. Otherwise the 
179 identifier is randomized.
180 .TP
181 .B active-filter \fIfilter-expression
182 Specifies a packet filter to be applied to data packets to determine
183 which packets are to be regarded as link activity, and therefore reset
184 the idle timer, or cause the link to be brought up in demand-dialling
185 mode.  This option is useful in conjunction with the
186 \fBidle\fR option if there are packets being sent or received
187 regularly over the link (for example, routing information packets)
188 which would otherwise prevent the link from ever appearing to be idle.
189 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
190 except that qualifiers which are inappropriate for a PPP link, such as
191 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
192 expression should be enclosed in single-quotes to prevent whitespace
193 in the expression from being interpreted by the shell. This option
194 is currently only available under NetBSD, and then only
195 if both the kernel and pppd were compiled with PPP_FILTER defined.
196 .TP
197 .B allow-ip \fIaddress(es)
198 Allow peers to use the given IP address or subnet without
199 authenticating themselves.  The parameter is parsed as for each
200 element of the list of allowed IP addresses in the secrets files (see
201 the AUTHENTICATION section below).
202 .TP
203 .B bsdcomp \fInr,nt
204 Request that the peer compress packets that it sends, using the
205 BSD-Compress scheme, with a maximum code size of \fInr\fR bits, and
206 agree to compress packets sent to the peer with a maximum code size of
207 \fInt\fR bits.  If \fInt\fR is not specified, it defaults to the value
208 given for \fInr\fR.  Values in the range 9 to 15 may be used for
209 \fInr\fR and \fInt\fR; larger values give better compression but
210 consume more kernel memory for compression dictionaries.
211 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
212 compression in the corresponding direction.  Use \fInobsdcomp\fR or
213 \fIbsdcomp 0\fR to disable BSD-Compress compression entirely.
214 .TP
215 .B cdtrcts
216 Use a non-standard hardware flow control (i.e. DTR/CTS) to control
217 the flow of data on the serial port.  If neither the \fIcrtscts\fR,
218 the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR
219 option is given, the hardware flow control setting for the serial
220 port is left unchanged.
221 Some serial ports (such as Macintosh serial ports) lack a true
222 RTS output. Such serial ports use this mode to implement true
223 bi-directional flow control. The sacrifice is that this flow
224 control mode does not permit using DTR as a modem control line.
225 .TP
226 .B chap-interval \fIn
227 If this option is given, pppd will rechallenge the peer every \fIn\fR
228 seconds.
229 .TP
230 .B chap-max-challenge \fIn
231 Set the maximum number of CHAP challenge transmissions to \fIn\fR
232 (default 10).
233 .TP
234 .B chap-restart \fIn
235 Set the CHAP restart interval (retransmission timeout for challenges)
236 to \fIn\fR seconds (default 3).
237 .TP
238 .B connect-delay \fIn
239 Wait for up \fIn\fR milliseconds after the connect script finishes for
240 a valid PPP packet from the peer.  At the end of this time, or when a
241 valid PPP packet is received from the peer, pppd will commence
242 negotiation by sending its first LCP packet.  The default value is
243 1000 (1 second).  This wait period only applies if the \fBconnect\fR
244 or \fBpty\fR option is used.
245 .TP
246 .B debug
247 Enables connection debugging facilities.
248 If this option is given, pppd will log the contents of all
249 control packets sent or received in a readable form.  The packets are
250 logged through syslog with facility \fIdaemon\fR and level
251 \fIdebug\fR.  This information can be directed to a file by setting up
252 /etc/syslog.conf appropriately (see syslog.conf(5)).
253 .TP
254 .B default-asyncmap
255 Disable asyncmap negotiation, forcing all control characters to be
256 escaped for both the transmit and the receive direction.
257 .TP
258 .B default-mru
259 Disable MRU [Maximum Receive Unit] negotiation.  With this option,
260 pppd will use the default MRU value of 1500 bytes for both the
261 transmit and receive direction.
262 .TP
263 .B deflate \fInr,nt
264 Request that the peer compress packets that it sends, using the
265 Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
266 agree to compress packets sent to the peer with a maximum window size
267 of \fI2**nt\fR bytes.  If \fInt\fR is not specified, it defaults to
268 the value given for \fInr\fR.  Values in the range 9 to 15 may be used
269 for \fInr\fR and \fInt\fR; larger values give better compression but
270 consume more kernel memory for compression dictionaries.
271 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
272 compression in the corresponding direction.  Use \fInodeflate\fR or
273 \fIdeflate 0\fR to disable Deflate compression entirely.  (Note: pppd
274 requests Deflate compression in preference to BSD-Compress if the peer
275 can do either.)
276 .TP
277 .B demand
278 Initiate the link only on demand, i.e. when data traffic is present.
279 With this option, the remote IP address must be specified by the user
280 on the command line or in an options file.  Pppd will initially
281 configure the interface and enable it for IP traffic without
282 connecting to the peer.  When traffic is available, pppd will
283 connect to the peer and perform negotiation, authentication, etc.
284 When this is completed, pppd will commence passing data packets
285 (i.e., IP packets) across the link.
287 The \fIdemand\fR option implies the \fIpersist\fR option.  If this
288 behaviour is not desired, use the \fInopersist\fR option after the
289 \fIdemand\fR option.  The \fIidle\fR and \fIholdoff\fR
290 options are also useful in conjuction with the \fIdemand\fR option.
291 .TP
292 .B domain \fId
293 Append the domain name \fId\fR to the local host name for authentication
294 purposes.  For example, if gethostname() returns the name porsche, but
295 the fully qualified domain name is porsche.Quotron.COM, you could
296 specify \fIdomain Quotron.COM\fR.  Pppd would then use the name
297 \fIporsche.Quotron.COM\fR for looking up secrets in the secrets file,
298 and as the default name to send to the peer when authenticating itself
299 to the peer.  This option is privileged.
300 .TP
301 .B endpoint \fI<epdisc>
302 Sets the endpoint discriminator sent by the local machine to the peer
303 during multilink negotiation to \fI<epdisc>\fR.  The default is to use
304 the MAC address of the first ethernet interface on the system, if any,
305 otherwise the IPv4 address corresponding to the hostname, if any,
306 provided it is not in the multicast or locally-assigned IP address
307 ranges, or the localhost address.  The endpoint discriminator can be
308 the string \fBnull\fR or of the form \fItype\fR:\fIvalue\fR, where
309 type is a decimal number or one of the strings \fBlocal\fR, \fBIP\fR,
310 \fBMAC\fR, \fBmagic\fR, or \fBphone\fR.  The value is an IP address in
311 dotted-decimal notation for the \fBIP\fR type, or a string of bytes in
312 hexadecimal, separated by periods or colons for the other types.  For
313 the MAC type, the value may also be the name of an ethernet or similar
314 network interface.  This option is currently only available under
315 Linux.
316 .TP
317 .B hide-password
318 When logging the contents of PAP packets, this option causes pppd to
319 exclude the password string from the log.  This is the default.
320 .TP
321 .B holdoff \fIn
322 Specifies how many seconds to wait before re-initiating the link after
323 it terminates.  This option only has any effect if the \fIpersist\fR
324 or \fIdemand\fR option is used.  The holdoff period is not applied if
325 the link was terminated because it was idle.
326 .TP
327 .B idle \fIn
328 Specifies that pppd should disconnect if the link is idle for \fIn\fR
329 seconds.  The link is idle when no data packets (i.e. IP packets) are
330 being sent or received.  Note: it is not advisable to use this option
331 with the \fIpersist\fR option without the \fIdemand\fR option.
332 If the \fBactive-filter\fR
333 option is given, data packets which are rejected by the specified
334 activity filter also count as the link being idle.
335 .TP
336 .B ipcp-accept-local
337 With this option, pppd will accept the peer's idea of our local IP
338 address, even if the local IP address was specified in an option.
339 .TP
340 .B ipcp-accept-remote
341 With this option, pppd will accept the peer's idea of its (remote) IP
342 address, even if the remote IP address was specified in an option.
343 .TP
344 .B ipcp-max-configure \fIn
345 Set the maximum number of IPCP configure-request transmissions to
346 \fIn\fR (default 10).
347 .TP
348 .B ipcp-max-failure \fIn
349 Set the maximum number of IPCP configure-NAKs returned before starting
350 to send configure-Rejects instead to \fIn\fR (default 10).
351 .TP
352 .B ipcp-max-terminate \fIn
353 Set the maximum number of IPCP terminate-request transmissions to
354 \fIn\fR (default 3).
355 .TP
356 .B ipcp-restart \fIn
357 Set the IPCP restart interval (retransmission timeout) to \fIn\fR
358 seconds (default 3).
359 .TP
360 .B ipparam \fIstring
361 Provides an extra parameter to the ip-up and ip-down scripts.  If this
362 option is given, the \fIstring\fR supplied is given as the 6th
363 parameter to those scripts.
364 .TP
365 .B ipv6cp-max-configure \fIn
366 Set the maximum number of IPv6CP configure-request transmissions to
367 \fIn\fR (default 10).
368 .TP
369 .B ipv6cp-max-failure \fIn
370 Set the maximum number of IPv6CP configure-NAKs returned before starting
371 to send configure-Rejects instead to \fIn\fR (default 10).
372 .TP
373 .B ipv6cp-max-terminate \fIn
374 Set the maximum number of IPv6CP terminate-request transmissions to
375 \fIn\fR (default 3).
376 .TP
377 .B ipv6cp-restart \fIn
378 Set the IPv6CP restart interval (retransmission timeout) to \fIn\fR
379 seconds (default 3).
380 .TP
381 .B ipx
382 Enable the IPXCP and IPX protocols.  This option is presently only
383 supported under Linux, and only if your kernel has been configured to
384 include IPX support.
385 .TP
386 .B ipx-network \fIn
387 Set the IPX network number in the IPXCP configure request frame to
388 \fIn\fR, a hexadecimal number (without a leading 0x).  There is no
389 valid default.  If this option is not specified, the network number is
390 obtained from the peer.  If the peer does not have the network number,
391 the IPX protocol will not be started.
392 .TP
393 .B ipx-node \fIn\fB:\fIm
394 Set the IPX node numbers. The two node numbers are separated from each
395 other with a colon character. The first number \fIn\fR is the local
396 node number. The second number \fIm\fR is the peer's node number. Each
397 node number is a hexadecimal number, at most 10 digits long. The node
398 numbers on the ipx-network must be unique. There is no valid
399 default. If this option is not specified then the node numbers are
400 obtained from the peer.
401 .TP
402 .B ipx-router-name \fI<string>
403 Set the name of the router. This is a string and is sent to the peer
404 as information data.
405 .TP
406 .B ipx-routing \fIn
407 Set the routing protocol to be received by this option. More than one
408 instance of \fIipx-routing\fR may be specified. The '\fInone\fR'
409 option (0) may be specified as the only instance of ipx-routing. The
410 values may be \fI0\fR for \fINONE\fR, \fI2\fR for \fIRIP/SAP\fR, and
411 \fI4\fR for \fINLSP\fR.
412 .TP
413 .B ipxcp-accept-local
414 Accept the peer's NAK for the node number specified in the ipx-node
415 option. If a node number was specified, and non-zero, the default is
416 to insist that the value be used. If you include this option then you
417 will permit the peer to override the entry of the node number.
418 .TP
419 .B ipxcp-accept-network
420 Accept the peer's NAK for the network number specified in the
421 ipx-network option. If a network number was specified, and non-zero, the
422 default is to insist that the value be used. If you include this
423 option then you will permit the peer to override the entry of the node
424 number.
425 .TP
426 .B ipxcp-accept-remote
427 Use the peer's network number specified in the configure request
428 frame. If a node number was specified for the peer and this option was
429 not specified, the peer will be forced to use the value which you have
430 specified.
431 .TP
432 .B ipxcp-max-configure \fIn
433 Set the maximum number of IPXCP configure request frames which the
434 system will send to \fIn\fR. The default is 10.
435 .TP
436 .B ipxcp-max-failure \fIn
437 Set the maximum number of IPXCP NAK frames which the local system will
438 send before it rejects the options. The default value is 3.
439 .TP
440 .B ipxcp-max-terminate \fIn
441 Set the maximum nuber of IPXCP terminate request frames before the
442 local system considers that the peer is not listening to them. The
443 default value is 3.
444 .TP
445 .B kdebug \fIn
446 Enable debugging code in the kernel-level PPP driver.  The argument
447 \fIn\fR is a number which is the sum of the following values: 1 to
448 enable general debug messages, 2 to request that the contents of
449 received packets be printed, and 4 to request that the contents of
450 transmitted packets be printed.  On most systems, messages printed by
451 the kernel are logged by syslog(1) to a file as directed in the
452 /etc/syslog.conf configuration file.
453 .TP
454 .B ktune
455 Enables pppd to alter kernel settings as appropriate.  Under Linux,
456 pppd will enable IP forwarding (i.e. set /proc/sys/net/ipv4/ip_forward
457 to 1) if the \fIproxyarp\fR option is used, and will enable the
458 dynamic IP address option (i.e. set /proc/sys/net/ipv4/ip_dynaddr to
459 1) in demand mode if the local address changes.
460 .TP
461 .B lcp-echo-failure \fIn
462 If this option is given, pppd will presume the peer to be dead
463 if \fIn\fR LCP echo-requests are sent without receiving a valid LCP
464 echo-reply.  If this happens, pppd will terminate the
465 connection.  Use of this option requires a non-zero value for the
466 \fIlcp-echo-interval\fR parameter.  This option can be used to enable
467 pppd to terminate after the physical connection has been broken
468 (e.g., the modem has hung up) in situations where no hardware modem
469 control lines are available.
470 .TP
471 .B lcp-echo-interval \fIn
472 If this option is given, pppd will send an LCP echo-request frame to
473 the peer every \fIn\fR seconds.  Normally the peer should respond to
474 the echo-request by sending an echo-reply.  This option can be used
475 with the \fIlcp-echo-failure\fR option to detect that the peer is no
476 longer connected.
477 .TP
478 .B lcp-max-configure \fIn
479 Set the maximum number of LCP configure-request transmissions to
480 \fIn\fR (default 10).
481 .TP
482 .B lcp-max-failure \fIn
483 Set the maximum number of LCP configure-NAKs returned before starting
484 to send configure-Rejects instead to \fIn\fR (default 10).
485 .TP
486 .B lcp-max-terminate \fIn
487 Set the maximum number of LCP terminate-request transmissions to
488 \fIn\fR (default 3).
489 .TP
490 .B lcp-restart \fIn
491 Set the LCP restart interval (retransmission timeout) to \fIn\fR
492 seconds (default 3).
493 .TP
494 .B linkname \fIname\fR
495 Sets the logical name of the link to \fIname\fR.  Pppd will create a
496 file named \fBppp-\fIname\\fR in /var/run (or /etc/ppp on some
497 systems) containing its process ID.  This can be useful in determining
498 which instance of pppd is responsible for the link to a given peer
499 system.  This is a privileged option.
500 .TP
501 .B local
502 Don't use the modem control lines.  With this option, pppd will ignore
503 the state of the CD (Carrier Detect) signal from the modem and will
504 not change the state of the DTR (Data Terminal Ready) signal.
505 .TP
506 .B logfd \fIn
507 Send log messages to file descriptor \fIn\fR.  Pppd will send log
508 messages to at most one file or file descriptor (as well as sending
509 the log messages to syslog), so this option and the \fBlogfile\fR
510 option are mutually exclusive.  The default is for pppd to send log
511 messages to stdout (file descriptor 1), unless the serial port is
512 already open on stdout.
513 .TP
514 .B logfile \fIfilename
515 Append log messages to the file \fIfilename\fR (as well as sending the
516 log messages to syslog).  The file is opened with the privileges of
517 the user who invoked pppd, in append mode.
518 .TP
519 .B login
520 Use the system password database for authenticating the peer using
521 PAP, and record the user in the system wtmp file.  Note that the peer
522 must have an entry in the /etc/ppp/pap-secrets file as well as the
523 system password database to be allowed access.
524 .TP
525 .B maxconnect \fIn
526 Terminate the connection when it has been available for network
527 traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first
528 network control protocol comes up).
529 .TP
530 .B maxfail \fIn
531 Terminate after \fIn\fR consecutive failed connection attempts.  A
532 value of 0 means no limit.  The default value is 10.
533 .TP
534 .B modem
535 Use the modem control lines.  This option is the default.  With this
536 option, pppd will wait for the CD (Carrier Detect) signal from the
537 modem to be asserted when opening the serial device (unless a connect
538 script is specified), and it will drop the DTR (Data Terminal Ready)
539 signal briefly when the connection is terminated and before executing
540 the connect script.  On Ultrix, this option implies hardware flow
541 control, as for the \fIcrtscts\fR option.
542 .TP
543 .B mp
544 Enables the use of PPP multilink; this is an alias for the `multilink'
545 option.  This option is currently only available under Linux.
546 .TP
547 .B mpshortseq
548 Enables the use of short (12-bit) sequence numbers in multilink
549 headers, as opposed to 24-bit sequence numbers.  This option is only
550 available under Linux, and only has any effect if multilink is
551 enabled (see the multilink option).
552 .TP
553 .B mrru \fIn
554 Sets the Maximum Reconstructed Receive Unit to \fIn\fR.  The MRRU is
555 the maximum size for a received packet on a multilink bundle, and is
556 analogous to the MRU for the individual links.  This option is
557 currently only available under Linux, and only has any effect if
558 multilink is enabled (see the multilink option).
559 .TP
560 .B ms-dns \fI<addr>
561 If pppd is acting as a server for Microsoft Windows clients, this
562 option allows pppd to supply one or two DNS (Domain Name Server)
563 addresses to the clients.  The first instance of this option specifies
564 the primary DNS address; the second instance (if given) specifies the
565 secondary DNS address.  (This option was present in some older
566 versions of pppd under the name \fBdns-addr\fR.)
567 .TP
568 .B ms-wins \fI<addr>
569 If pppd is acting as a server for Microsoft Windows or "Samba"
570 clients, this option allows pppd to supply one or two WINS (Windows
571 Internet Name Services) server addresses to the clients.  The first
572 instance of this option specifies the primary WINS address; the second
573 instance (if given) specifies the secondary WINS address.
574 .TP
575 .B multilink
576 Enables the use of the PPP multilink protocol.  If the peer also
577 supports multilink, then this link can become part of a bundle between
578 the local system and the peer.  If there is an existing bundle to the
579 peer, pppd will join this link to that bundle, otherwise pppd will
580 create a new bundle.  See the MULTILINK section below.  This option is
581 currently only available under Linux.
582 .TP
583 .B name \fIname
584 Set the name of the local system for authentication purposes to
585 \fIname\fR.  This is a privileged option.  With this option, pppd will
586 use lines in the secrets files which have \fIname\fR as the second
587 field when looking for a secret to use in authenticating the peer.  In
588 addition, unless overridden with the \fIuser\fR option, \fIname\fR
589 will be used as the name to send to the peer when authenticating the
590 local system to the peer.  (Note that pppd does not append the domain
591 name to \fIname\fR.)
592 .TP
593 .B netmask \fIn
594 Set the interface netmask to \fIn\fR, a 32 bit netmask in "decimal dot"
595 notation (e.g.  If this option is given, the value
596 specified is ORed with the default netmask.  The default netmask is
597 chosen based on the negotiated remote IP address; it is the
598 appropriate network mask for the class of the remote IP address, ORed
599 with the netmasks for any non point-to-point network interfaces in the
600 system which are on the same network.  (Note: on some platforms, pppd
601 will always use for the netmask, if that is the only
602 appropriate value for a point-to-point interface.)
603 .TP
604 .B noaccomp
605 Disable Address/Control compression in both directions (send and
606 receive).
607 .TP
608 .B noauth
609 Do not require the peer to authenticate itself.  This option is
610 privileged.
611 .TP
612 .B nobsdcomp
613 Disables BSD-Compress compression; \fBpppd\fR will not request or
614 agree to compress packets using the BSD-Compress scheme.
615 .TP
616 .B noccp
617 Disable CCP (Compression Control Protocol) negotiation.  This option
618 should only be required if the peer is buggy and gets confused by
619 requests from pppd for CCP negotiation.
620 .TP
621 .B nocrtscts
622 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
623 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the
624 \fIcdtrcts\fR nor the \fInocdtrcts\fR option is given, the hardware
625 flow control setting for the serial port is left unchanged.
626 .TP
627 .B nocdtrcts
628 This option is a synonym for \fInocrtscts\fR. Either of these options will
629 disable both forms of hardware flow control.
630 .TP
631 .B nodefaultroute
632 Disable the \fIdefaultroute\fR option.  The system administrator who
633 wishes to prevent users from creating default routes with pppd
634 can do so by placing this option in the /etc/ppp/options file.
635 .TP
636 .B nodeflate
637 Disables Deflate compression; pppd will not request or agree to
638 compress packets using the Deflate scheme.
639 .TP
640 .B nodetach
641 Don't detach from the controlling terminal.  Without this option, if a
642 serial device other than the terminal on the standard input is
643 specified, pppd will fork to become a background process.
644 .TP
645 .B noendpoint
646 Disables pppd from sending an endpoint discriminator to the peer or
647 accepting one from the peer (see the MULTILINK section below).  This
648 option should only be required if the peer is buggy.
649 .TP
650 .B noip
651 Disable IPCP negotiation and IP communication.  This option should
652 only be required if the peer is buggy and gets confused by requests
653 from pppd for IPCP negotiation.
654 .TP
655 .B noipv6
656 Disable IPv6CP negotiation and IPv6 communication. This option should
657 only be required if the peer is buggy and gets confused by requests
658 from pppd for IPv6CP negotiation.
659 .TP
660 .B noipdefault
661 Disables the default behaviour when no local IP address is specified,
662 which is to determine (if possible) the local IP address from the
663 hostname.  With this option, the peer will have to supply the local IP
664 address during IPCP negotiation (unless it specified explicitly on the
665 command line or in an options file).
666 .TP
667 .B noipx
668 Disable the IPXCP and IPX protocols.  This option should only be
669 required if the peer is buggy and gets confused by requests from pppd
670 for IPXCP negotiation.
671 .TP
672 .B noktune
673 Opposite of the \fIktune\fR option; disables pppd from changing system
674 settings.
675 .TP
676 .B nolog
677 Do not send log messages to a file or file descriptor.  This option
678 cancels the \fBlogfd\fR and \fBlogfile\fR options.
679 .TP
680 .B nomagic
681 Disable magic number negotiation.  With this option, pppd cannot
682 detect a looped-back line.  This option should only be needed if the
683 peer is buggy.
684 .TP
685 .B nomp
686 Disables the use of PPP multilink.  This option is currently only
687 available under Linux.
688 .TP
689 .B nompshortseq
690 Disables the use of short (12-bit) sequence numbers in the PPP
691 multilink protocol, forcing the use of 24-bit sequence numbers.  This
692 option is currently only available under Linux, and only has any
693 effect if multilink is enabled.
694 .TP
695 .B nomultilink
696 Disables the use of PPP multilink.  This option is currently only
697 available under Linux.
698 .TP
699 .B nopcomp
700 Disable protocol field compression negotiation in both the receive and
701 the transmit direction.
702 .TP
703 .B nopersist
704 Exit once a connection has been made and terminated.  This is the
705 default unless the \fIpersist\fR or \fIdemand\fR option has been
706 specified.
707 .TP
708 .B nopredictor1
709 Do not accept or agree to Predictor-1 compression.
710 .TP
711 .B noproxyarp
712 Disable the \fIproxyarp\fR option.  The system administrator who
713 wishes to prevent users from creating proxy ARP entries with pppd can
714 do so by placing this option in the /etc/ppp/options file.
715 .TP
716 .B notty
717 Normally, pppd requires a terminal device.  With this option, pppd
718 will allocate itself a pseudo-tty master/slave pair and use the slave
719 as its terminal device.  Pppd will create a child process to act as a
720 `character shunt' to transfer characters between the pseudo-tty master
721 and its standard input and output.  Thus pppd will transmit characters
722 on its standard output and receive characters on its standard input
723 even if they are not terminal devices.  This option increases the
724 latency and CPU overhead of transferring data over the ppp interface
725 as all of the characters sent and received must flow through the
726 character shunt process.  An explicit device name may not be given if
727 this option is used.
728 .TP
729 .B novj
730 Disable Van Jacobson style TCP/IP header compression in both the
731 transmit and the receive direction.
732 .TP
733 .B novjccomp
734 Disable the connection-ID compression option in Van Jacobson style
735 TCP/IP header compression.  With this option, pppd will not omit the
736 connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
737 ask the peer to do so.
738 .TP
739 .B papcrypt
740 Indicates that all secrets in the /etc/ppp/pap-secrets file which are
741 used for checking the identity of the peer are encrypted, and thus
742 pppd should not accept a password which, before encryption, is
743 identical to the secret from the /etc/ppp/pap-secrets file.
744 .TP
745 .B pap-max-authreq \fIn
746 Set the maximum number of PAP authenticate-request transmissions to
747 \fIn\fR (default 10).
748 .TP
749 .B pap-restart \fIn
750 Set the PAP restart interval (retransmission timeout) to \fIn\fR
751 seconds (default 3).
752 .TP
753 .B pap-timeout \fIn
754 Set the maximum time that pppd will wait for the peer to authenticate
755 itself with PAP to \fIn\fR seconds (0 means no limit).
756 .TP
757 .B pass-filter \fIfilter-expression
758 Specifies a packet filter to applied to data packets being sent or
759 received to determine which packets should be allowed to pass.
760 Packets which are rejected by the filter are silently discarded.  This
761 option can be used to prevent specific network daemons (such as
762 routed) using up link bandwidth, or to provide a basic firewall
763 capability.
764 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
765 except that qualifiers which are inappropriate for a PPP link, such as
766 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
767 expression should be enclosed in single-quotes to prevent whitespace
768 in the expression from being interpreted by the shell.  Note that it
769 is possible to apply different constraints to incoming and outgoing
770 packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. This
771 option is currently only available under NetBSD, and then only if both
772 the kernel and pppd were compiled with PPP_FILTER defined.
773 .TP
774 .B persist
775 Do not exit after a connection is terminated; instead try to reopen
776 the connection.
777 .TP
778 .B plugin \fIfilename
779 Load the shared library object file \fIfilename\fR as a plugin.  This
780 is a privileged option.
781 .TP
782 .B predictor1
783 Request that the peer compress frames that it sends using Predictor-1
784 compression, and agree to compress transmitted frames with Predictor-1
785 if requested.  This option has no effect unless the kernel driver
786 supports Predictor-1 compression.
787 .TP
788 .B privgroup \fIgroup-name
789 Allows members of group \fIgroup-name\fR to use privileged options.
790 This is a privileged option.  Use of this option requires care as
791 there is no guarantee that members of \fIgroup-name\fR cannot use pppd
792 to become root themselves.  Consider it equivalent to putting the
793 members of \fIgroup-name\fR in the kmem or disk group.
794 .TP
795 .B proxyarp
796 Add an entry to this system's ARP [Address Resolution Protocol] table
797 with the IP address of the peer and the Ethernet address of this
798 system.  This will have the effect of making the peer appear to other
799 systems to be on the local ethernet.
800 .TP
801 .B pty \fIscript
802 Specifies that the command \fIscript\fR is to be used to communicate
803 rather than a specific terminal device.  Pppd will allocate itself a
804 pseudo-tty master/slave pair and use the slave as its terminal
805 device.  The \fIscript\fR will be run in a child process with the
806 pseudo-tty master as its standard input and output.  An explicit
807 device name may not be given if this option is used.  (Note: if the
808 \fIrecord\fR option is used in conjuction with the \fIpty\fR option,
809 the child process will have pipes on its standard input and output.)
810 .TP
811 .B receive-all
812 With this option, pppd will accept all control characters from the
813 peer, including those marked in the receive asyncmap.  Without this
814 option, pppd will discard those characters as specified in RFC1662.
815 This option should only be needed if the peer is buggy.
816 .TP
817 .B record \fIfilename
818 Specifies that pppd should record all characters sent and received to
819 a file named \fIfilename\fR.  This file is opened in append mode,
820 using the user's user-ID and permissions.  This option is implemented
821 using a pseudo-tty and a process to transfer characters between the
822 pseudo-tty and the real serial device, so it will increase the latency
823 and CPU overhead of transferring data over the ppp interface.  The
824 characters are stored in a tagged format with timestamps, which can be
825 displayed in readable form using the pppdump(8) program.
826 .TP
827 .B remotename \fIname
828 Set the assumed name of the remote system for authentication purposes
829 to \fIname\fR.
830 .TP
831 .B refuse-chap
832 With this option, pppd will not agree to authenticate itself to the
833 peer using CHAP.
834 .TP
835 .B refuse-pap
836 With this option, pppd will not agree to authenticate itself to the
837 peer using PAP.
838 .TP
839 .B require-chap
840 Require the peer to authenticate itself using CHAP [Challenge
841 Handshake Authentication Protocol] authentication.
842 .TP
843 .B require-pap
844 Require the peer to authenticate itself using PAP [Password
845 Authentication Protocol] authentication.
846 .TP
847 .B show-password
848 When logging the contents of PAP packets, this option causes pppd to
849 show the password string in the log message.
850 .TP
851 .B silent
852 With this option, pppd will not transmit LCP packets to initiate a
853 connection until a valid LCP packet is received from the peer (as for
854 the `passive' option with ancient versions of pppd).
855 .TP
856 .B sync
857 Use synchronous HDLC serial encoding instead of asynchronous.
858 The device used by pppd with this option must have sync support.
859 Currently supports Microgate SyncLink adapters
860 under Linux and FreeBSD 2.2.8 and later.
861 .TP
862 .B updetach
863 With this option, pppd will detach from its controlling terminal once
864 it has successfully established the ppp connection (to the point where
865 the first network control protocol, usually the IP control protocol,
866 has come up).
867 .TP
868 .B usehostname
869 Enforce the use of the hostname (with domain name appended, if given)
870 as the name of the local system for authentication purposes (overrides
871 the \fIname\fR option).  This option is not normally needed since the
872 \fIname\fR option is privileged.
873 .TP
874 .B usepeerdns
875 Ask the peer for up to 2 DNS server addresses.  The addresses supplied
876 by the peer (if any) are passed to the /etc/ppp/ip-up script in the
877 environment variables DNS1 and DNS2.  In addition, pppd will create an
878 /etc/ppp/resolv.conf file containing one or two nameserver lines with
879 the address(es) supplied by the peer.
880 .TP
881 .B user \fIname
882 Sets the name used for authenticating the local system to the peer to
883 \fIname\fR.
884 .TP
885 .B vj-max-slots \fIn
886 Sets the number of connection slots to be used by the Van Jacobson
887 TCP/IP header compression and decompression code to \fIn\fR, which
888 must be between 2 and 16 (inclusive).
889 .TP
890 .B welcome \fIscript
891 Run the executable or shell command specified by \fIscript\fR before
892 initiating PPP negotiation, after the connect script (if any) has
893 completed.  A value for this option from a privileged source cannot be
894 overridden by a non-privileged user.
895 .TP
896 .B xonxoff
897 Use software flow control (i.e. XON/XOFF) to control the flow of data on
898 the serial port.
900 Options can be taken from files as well as the command line.  Pppd
901 reads options from the files /etc/ppp/options, ~/.ppprc and
902 /etc/ppp/options.\fIttyname\fR (in that order) before processing the
903 options on the command line.  (In fact, the command-line options are
904 scanned to find the terminal name before the options.\fIttyname\fR
905 file is read.)  In forming the name of the options.\fIttyname\fR file,
906 the initial /dev/ is removed from the terminal name, and any remaining
907 / characters are replaced with dots.
908 .PP
909 An options file is parsed into a series of words, delimited by
910 whitespace.  Whitespace can be included in a word by enclosing the
911 word in double-quotes (").  A backslash (\\) quotes the following character.
912 A hash (#) starts a comment, which continues until the end of the
913 line.  There is no restriction on using the \fIfile\fR or \fIcall\fR
914 options within an options file.
916 .I pppd
917 provides system administrators with sufficient access control that PPP
918 access to a server machine can be provided to legitimate users without
919 fear of compromising the security of the server or the network it's
920 on.  This control is provided through restrictions on which IP
921 addresses the peer may use, based on its authenticated identity (if
922 any), and through restrictions on which options a non-privileged user
923 may use.  Several of pppd's options are privileged, in particular
924 those which permit potentially insecure configurations; these options
925 are only accepted in files which are under the control of the system
926 administrator, or if pppd is being run by root.
927 .PP
928 The default behaviour of pppd is to allow an unauthenticated peer to
929 use a given IP address only if the system does not already have a
930 route to that IP address.  For example, a system with a
931 permanent connection to the wider internet will normally have a
932 default route, and thus all peers will have to authenticate themselves
933 in order to set up a connection.  On such a system, the \fIauth\fR
934 option is the default.  On the other hand, a system where the
935 PPP link is the only connection to the internet will not normally have
936 a default route, so the peer will be able to use almost any IP address
937 without authenticating itself.
938 .PP
939 As indicated above, some security-sensitive options are privileged,
940 which means that they may not be used by an ordinary non-privileged
941 user running a setuid-root pppd, either on the command line, in the
942 user's ~/.ppprc file, or in an options file read using the \fIfile\fR
943 option.  Privileged options may be used in /etc/ppp/options file or in
944 an options file read using the \fIcall\fR option.  If pppd is being
945 run by the root user, privileged options can be used without
946 restriction.
947 .PP
948 When opening the device, pppd uses either the invoking user's user ID
949 or the root UID (that is, 0), depending on whether the device name was
950 specified by the user or the system administrator.  If the device name
951 comes from a privileged source, that is, /etc/ppp/options or an
952 options file read using the \fIcall\fR option, pppd uses full root
953 privileges when opening the device.  Thus, by creating an appropriate
954 file under /etc/ppp/peers, the system administrator can allow users to
955 establish a ppp connection via a device which they would not normally
956 have permission to access.  Otherwise pppd uses the invoking user's
957 real UID when opening the device.
959 Authentication is the process whereby one peer convinces the other of
960 its identity.  This involves the first peer sending its name to the
961 other, together with some kind of secret information which could only
962 come from the genuine authorized user of that name.  In such an
963 exchange, we will call the first peer the "client" and the other the
964 "server".  The client has a name by which it identifies itself to the
965 server, and the server also has a name by which it identifies itself
966 to the client.  Generally the genuine client shares some secret (or
967 password) with the server, and authenticates itself by proving that it
968 knows that secret.  Very often, the names used for authentication
969 correspond to the internet hostnames of the peers, but this is not
970 essential.
971 .LP
972 At present, pppd supports two authentication protocols: the Password
973 Authentication Protocol (PAP) and the Challenge Handshake
974 Authentication Protocol (CHAP).  PAP involves the client sending its
975 name and a cleartext password to the server to authenticate itself.
976 In contrast, the server initiates the CHAP authentication exchange by
977 sending a challenge to the client (the challenge packet includes the
978 server's name).  The client must respond with a response which
979 includes its name plus a hash value derived from the shared secret and
980 the challenge, in order to prove that it knows the secret.
981 .LP
982 The PPP protocol, being symmetrical, allows both peers to require the
983 other to authenticate itself.  In that case, two separate and
984 independent authentication exchanges will occur.  The two exchanges
985 could use different authentication protocols, and in principle,
986 different names could be used in the two exchanges.
987 .LP
988 The default behaviour of pppd is to agree to authenticate if
989 requested, and to not require authentication from the peer.  However,
990 pppd will not agree to authenticate itself with a particular protocol
991 if it has no secrets which could be used to do so.
992 .LP
993 Pppd stores secrets for use in authentication in secrets
994 files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP).
995 Both secrets files have the same format.  The secrets files can
996 contain secrets for pppd to use in authenticating itself to other
997 systems, as well as secrets for pppd to use when authenticating other
998 systems to itself.
999 .LP
1000 Each line in a secrets file contains one secret.  A given secret is
1001 specific to a particular combination of client and server - it can
1002 only be used by that client to authenticate itself to that server.
1003 Thus each line in a secrets file has at least 3 fields: the name of
1004 the client, the name of the server, and the secret.  These fields may
1005 be followed by a list of the IP addresses that the specified client
1006 may use when connecting to the specified server.
1007 .LP
1008 A secrets file is parsed into words as for a options file, so the
1009 client name, server name and secrets fields must each be one word,
1010 with any embedded spaces or other special characters quoted or
1011 escaped.  Note that case is significant in the client and server names
1012 and in the secret.
1013 .LP
1014 If the secret starts with an `@', what follows is assumed to be the
1015 name of a file from which to read the secret.  A "*" as the client or
1016 server name matches any name.  When selecting a secret, pppd takes the
1017 best match, i.e.  the match with the fewest wildcards.
1018 .LP
1019 Any following words on the same line are taken to be a list of
1020 acceptable IP addresses for that client.  If there are only 3 words on
1021 the line, or if the first word is "-", then all IP addresses are
1022 disallowed.  To allow any address, use "*".  A word starting with "!"
1023 indicates that the specified address is \fInot\fR acceptable.  An
1024 address may be followed by "/" and a number \fIn\fR, to indicate a
1025 whole subnet, i.e. all addresses which have the same value in the most
1026 significant \fIn\fR bits.  In this form, the address may be followed
1027 by a plus sign ("+") to indicate that one address from the subnet is
1028 authorized, based on the ppp network interface unit number in use.
1029 In this case, the host part of the address will be set to the unit
1030 number plus one.
1031 .LP
1032 Thus a secrets file contains both secrets for use in authenticating
1033 other hosts, plus secrets which we use for authenticating ourselves to
1034 others.  When pppd is authenticating the peer (checking the peer's
1035 identity), it chooses a secret with the peer's name in the first
1036 field and the name of the local system in the second field.  The
1037 name of the local system defaults to the hostname, with the domain
1038 name appended if the \fIdomain\fR option is used.  This default can be
1039 overridden with the \fIname\fR option, except when the
1040 \fIusehostname\fR option is used.
1041 .LP
1042 When pppd is choosing a secret to use in authenticating itself to the
1043 peer, it first determines what name it is going to use to identify
1044 itself to the peer.  This name can be specified by the user with the
1045 \fIuser\fR option.  If this option is not used, the name defaults to
1046 the name of the local system, determined as described in the previous
1047 paragraph.  Then pppd looks for a secret with this name in the first
1048 field and the peer's name in the second field.  Pppd will know the
1049 name of the peer if CHAP authentication is being used, because the
1050 peer will have sent it in the challenge packet.  However, if PAP is being
1051 used, pppd will have to determine the peer's name from the options
1052 specified by the user.  The user can specify the peer's name directly
1053 with the \fIremotename\fR option.  Otherwise, if the remote IP address
1054 was specified by a name (rather than in numeric form), that name will
1055 be used as the peer's name.  Failing that, pppd will use the null
1056 string as the peer's name.
1057 .LP
1058 When authenticating the peer with PAP, the supplied password is first
1059 compared with the secret from the secrets file.  If the password
1060 doesn't match the secret, the password is encrypted using crypt() and
1061 checked against the secret again.  Thus secrets for authenticating the
1062 peer can be stored in encrypted form if desired.  If the
1063 \fIpapcrypt\fR option is given, the first (unencrypted) comparison is
1064 omitted, for better security.
1065 .LP
1066 Furthermore, if the \fIlogin\fR option was specified, the username and
1067 password are also checked against the system password database.  Thus,
1068 the system administrator can set up the pap-secrets file to allow PPP
1069 access only to certain users, and to restrict the set of IP addresses
1070 that each user can use.  Typically, when using the \fIlogin\fR option,
1071 the secret in /etc/ppp/pap-secrets would be "", which will match any
1072 password supplied by the peer.  This avoids the need to have the same
1073 secret in two places.
1074 .LP
1075 Authentication must be satisfactorily completed before IPCP (or any
1076 other Network Control Protocol) can be started.  If the peer is
1077 required to authenticate itself, and fails to do so, pppd will
1078 terminated the link (by closing LCP).  If IPCP negotiates an
1079 unacceptable IP address for the remote host, IPCP will be closed.  IP
1080 packets can only be sent or received when IPCP is open.
1081 .LP
1082 In some cases it is desirable to allow some hosts which can't
1083 authenticate themselves to connect and use one of a restricted set of
1084 IP addresses, even when the local host generally requires
1085 authentication.  If the peer refuses to authenticate itself when
1086 requested, pppd takes that as equivalent to authenticating with PAP
1087 using the empty string for the username and password.  Thus, by adding
1088 a line to the pap-secrets file which specifies the empty string for
1089 the client and password, it is possible to allow restricted access to
1090 hosts which refuse to authenticate themselves.
1092 .LP
1093 When IPCP negotiation is completed successfully, pppd will inform the
1094 kernel of the local and remote IP addresses for the ppp interface.
1095 This is sufficient to create a host route to the remote end of the
1096 link, which will enable the peers to exchange IP packets.
1097 Communication with other machines generally requires further
1098 modification to routing tables and/or ARP (Address Resolution
1099 Protocol) tables.  In most cases the \fIdefaultroute\fR and/or
1100 \fIproxyarp\fR options are sufficient for this, but in some cases
1101 further intervention is required.  The /etc/ppp/ip-up script can be
1102 used for this.
1103 .LP
1104 Sometimes it is desirable to add a default route through the remote
1105 host, as in the case of a machine whose only connection to the
1106 Internet is through the ppp interface.  The \fIdefaultroute\fR option
1107 causes pppd to create such a default route when IPCP comes up, and
1108 delete it when the link is terminated.
1109 .LP
1110 In some cases it is desirable to use proxy ARP, for example on a
1111 server machine connected to a LAN, in order to allow other hosts to
1112 communicate with the remote host.  The \fIproxyarp\fR option causes
1113 pppd to look for a network interface on the same subnet as the remote
1114 host (an interface supporting broadcast and ARP, which is up and not a
1115 point-to-point or loopback interface).  If found, pppd creates a
1116 permanent, published ARP entry with the IP address of the remote host
1117 and the hardware address of the network interface found.
1118 .LP
1119 When the \fIdemand\fR option is used, the interface IP addresses have
1120 already been set at the point when IPCP comes up.  If pppd has not
1121 been able to negotiate the same addresses that it used to configure
1122 the interface (for example when the peer is an ISP that uses dynamic
1123 IP address assignment), pppd has to change the interface IP addresses
1124 to the negotiated addresses.  This may disrupt existing connections,
1125 and the use of demand dialling with peers that do dynamic IP address
1126 assignment is not recommended.
1128 Multilink PPP provides the capability to combine two or more PPP links
1129 between a pair of machines into a single `bundle', which appears as a
1130 single virtual PPP link which has the combined bandwidth of the
1131 individual links.  Currently, multilink PPP is only supported under
1132 Linux.
1133 .LP
1134 Pppd detects that the link it is controlling is connected to the same
1135 peer as another link using the peer's endpoint discriminator and the
1136 authenticated identity of the peer (if it authenticates itself).  The
1137 endpoint discriminator is a block of data which is hopefully unique
1138 for each peer.  Several types of data can be used, including
1139 locally-assigned strings of bytes, IP addresses, MAC addresses,
1140 randomly strings of bytes, or E-164 phone numbers.  The endpoint
1141 discriminator sent to the peer by pppd can be set using the endpoint
1142 option.
1143 .LP
1144 In circumstances the peer may send no endpoint discriminator or a
1145 non-unique value.  The optional bundle option adds an extra string
1146 which is added to the peer's endpoint discriminator and authenticated
1147 identity when matching up links to be joined together in a bundle.
1148 The bundle option can also be used to allow the establishment of
1149 multiple bundles between the local system and the peer.  Pppd uses a
1150 TDB database in /var/run/pppd.tdb to match up links.
1151 .LP
1152 Assuming that multilink is enabled and the peer is willing to
1153 negotiate multilink, then when pppd is invoked to bring up the first
1154 link to the peer, it will detect that no other link is connected to
1155 the peer and create a new bundle, that is, another ppp network
1156 interface unit.  When another pppd is invoked to bring up another link
1157 to the peer, it will detect the existing bundle and join its link to
1158 it.  Currently, if the first pppd terminates (for example, because of
1159 a hangup or a received signal) the bundle is destroyed.
1161 .LP
1162 The following examples assume that the /etc/ppp/options file contains
1163 the \fIauth\fR option (as in the default /etc/ppp/options file in the
1164 ppp distribution).
1165 .LP
1166 Probably the most common use of pppd is to dial out to an ISP.  This
1167 can be done with a command such as
1168 .IP
1169 pppd call isp
1170 .LP
1171 where the /etc/ppp/peers/isp file is set up by the system
1172 administrator to contain something like this:
1173 .IP
1174 ttyS0 19200 crtscts
1175 .br
1176 connect '/usr/sbin/chat -v -f /etc/ppp/chat-isp'
1177 .br
1178 noauth
1179 .LP
1180 In this example, we are using chat to dial the ISP's modem and go
1181 through any logon sequence required.  The /etc/ppp/chat-isp file
1182 contains the script used by chat; it could for example contain
1183 something like this:
1184 .IP
1186 .br
1188 .br
1190 .br
1192 .br
1194 .br
1195 ABORT "Username/Password Incorrect"
1196 .br
1197 "" "at"
1198 .br
1199 OK "at&d0&c1"
1200 .br
1201 OK "atdt2468135"
1202 .br
1203 "name:" "^Umyuserid"
1204 .br
1205 "word:" "\\qmypassword"
1206 .br
1207 "ispts" "\\q^Uppp"
1208 .br
1209 "~-^Uppp-~"
1210 .LP
1211 See the chat(8) man page for details of chat scripts.
1212 .LP
1213 Pppd can also be used to provide a dial-in ppp service for users.  If
1214 the users already have login accounts, the simplest way to set up the
1215 ppp service is to let the users log in to their accounts and run pppd
1216 (installed setuid-root) with a command such as
1217 .IP
1218 pppd proxyarp
1219 .LP
1220 To allow a user to use the PPP facilities, you need to allocate an IP
1221 address for that user's machine and create an entry in
1222 /etc/ppp/pap-secrets or /etc/ppp/chap-secrets (depending on which
1223 authentication method the PPP implementation on the user's machine
1224 supports), so that the user's
1225 machine can authenticate itself.  For example, if Joe has a machine
1226 called "joespc" which is to be allowed to dial in to the machine
1227 called "server" and use the IP address, you would add an
1228 entry like this to /etc/ppp/pap-secrets or /etc/ppp/chap-secrets:
1229 .IP
1230 joespc  server  "joe's secret"
1231 .LP
1232 Alternatively, you can create a username called (for example) "ppp",
1233 whose login shell is pppd and whose home directory is /etc/ppp.
1234 Options to be used when pppd is run this way can be put in
1235 /etc/ppp/.ppprc.
1236 .LP
1237 If your serial connection is any more complicated than a piece of
1238 wire, you may need to arrange for some control characters to be
1239 escaped.  In particular, it is often useful to escape XON (^Q) and
1240 XOFF (^S), using \fIasyncmap a0000\fR.  If the path includes a telnet,
1241 you probably should escape ^] as well (\fIasyncmap 200a0000\fR).  If
1242 the path includes an rlogin, you will need to use the \fIescape ff\fR
1243 option on the end which is running the rlogin client, since many
1244 rlogin implementations are not transparent; they will remove the
1245 sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the
1246 stream.
1248 .LP
1249 Messages are sent to the syslog daemon using facility LOG_DAEMON.
1250 (This can be overriden by recompiling pppd with the macro
1251 LOG_PPP defined as the desired facility.)  In order to see the error
1252 and debug messages, you will need to edit your /etc/syslog.conf file
1253 to direct the messages to the desired output device or file.
1254 .LP
1255 The \fIdebug\fR option causes the contents of all control packets sent
1256 or received to be logged, that is, all LCP, PAP, CHAP or IPCP packets.
1257 This can be useful if the PPP negotiation does not succeed or if
1258 authentication fails.
1259 If debugging is enabled at compile time, the \fIdebug\fR option also
1260 causes other debugging messages to be logged.
1261 .LP
1262 Debugging can also be enabled or disabled by sending a SIGUSR1 signal
1263 to the pppd process.  This signal acts as a toggle.
1265 The exit status of pppd is set to indicate whether any error was
1266 detected, or the reason for the link being terminated.  The values
1267 used are:
1268 .TP
1269 .B 0
1270 Pppd has detached, or otherwise the connection was successfully
1271 established and terminated at the peer's request.
1272 .TP
1273 .B 1
1274 An immediately fatal error of some kind occurred, such as an essential
1275 system call failing, or running out of virtual memory.
1276 .TP
1277 .B 2
1278 An error was detected in processing the options given, such as two
1279 mutually exclusive options being used.
1280 .TP
1281 .B 3
1282 Pppd is not setuid-root and the invoking user is not root.
1283 .TP
1284 .B 4
1285 The kernel does not support PPP, for example, the PPP kernel driver is
1286 not included or cannot be loaded.
1287 .TP
1288 .B 5
1289 Pppd terminated because it was sent a SIGINT, SIGTERM or SIGHUP
1290 signal.
1291 .TP
1292 .B 6
1293 The serial port could not be locked.
1294 .TP
1295 .B 7
1296 The serial port could not be opened.
1297 .TP
1298 .B 8
1299 The connect script failed (returned a non-zero exit status).
1300 .TP
1301 .B 9
1302 The command specified as the argument to the \fIpty\fR option could
1303 not be run.
1304 .TP
1305 .B 10
1306 The PPP negotiation failed, that is, it didn't reach the point where
1307 at least one network protocol (e.g. IP) was running.
1308 .TP
1309 .B 11
1310 The peer system failed (or refused) to authenticate itself.
1311 .TP
1312 .B 12
1313 The link was established successfully and terminated because it was
1314 idle.
1315 .TP
1316 .B 13
1317 The link was established successfully and terminated because the
1318 connect time limit was reached.
1319 .TP
1320 .B 14
1321 Callback was negotiated and an incoming call should arrive shortly.
1322 .TP
1323 .B 15
1324 The link was terminated because the peer is not responding to echo
1325 requests.
1326 .TP
1327 .B 16
1328 The link was terminated by the modem hanging up.
1329 .TP
1330 .B 17
1331 The PPP negotiation failed because serial loopback was detected.
1332 .TP
1333 .B 18
1334 The init script failed (returned a non-zero exit status).
1335 .TP
1336 .B 19
1337 We failed to authenticate ourselves to the peer.
1339 Pppd invokes scripts at various stages in its processing which can be
1340 used to perform site-specific ancillary processing.  These scripts are
1341 usually shell scripts, but could be executable code files instead.
1342 Pppd does not wait for the scripts to finish.  The scripts are
1343 executed as root (with the real and effective user-id set to 0), so
1344 that they can do things such as update routing tables or run
1345 privileged daemons.  Be careful that the contents of these scripts do
1346 not compromise your system's security.  Pppd runs the scripts with
1347 standard input, output and error redirected to /dev/null, and with an
1348 environment that is empty except for some environment variables that
1349 give information about the link.  The environment variables that pppd
1350 sets are:
1351 .TP
1352 .B DEVICE
1353 The name of the serial tty device being used.
1354 .TP
1355 .B IFNAME
1356 The name of the network interface being used.
1357 .TP
1359 The IP address for the local end of the link.  This is only set when
1360 IPCP has come up.
1361 .TP
1363 The IP address for the remote end of the link.  This is only set when
1364 IPCP has come up.
1365 .TP
1367 The authenticated name of the peer.  This is only set if the peer
1368 authenticates itself.
1369 .TP
1370 .B SPEED
1371 The baud rate of the tty device.
1372 .TP
1373 .B ORIG_UID
1374 The real user-id of the user who invoked pppd.
1375 .TP
1377 The username of the real user-id that invoked pppd. This is always set.
1378 .P
1379 For the ip-down and auth-down scripts, pppd also sets the following
1380 variables giving statistics for the connection:
1381 .TP
1383 The number of seconds from when the PPP negotiation started until the
1384 connection was terminated.
1385 .TP
1387 The number of bytes sent (at the level of the serial port) during the
1388 connection.
1389 .TP
1391 The number of bytes received (at the level of the serial port) during
1392 the connection.
1393 .TP
1395 The logical name of the link, set with the \fIlinkname\fR option.
1396 .P
1397 Pppd invokes the following scripts, if they exist.  It is not an error
1398 if they don't exist.
1399 .TP
1400 .B /etc/ppp/auth-up
1401 A program or script which is executed after the remote system
1402 successfully authenticates itself.  It is executed with the parameters
1403 .IP
1404 \fIinterface-name peer-name user-name tty-device speed\fR
1405 .IP
1406 Note that this script is not executed if the peer doesn't authenticate
1407 itself, for example when the \fInoauth\fR option is used.
1408 .TP
1409 .B /etc/ppp/auth-down
1410 A program or script which is executed when the link goes down, if
1411 /etc/ppp/auth-up was previously executed.  It is executed in the same
1412 manner with the same parameters as /etc/ppp/auth-up.
1413 .TP
1414 .B /etc/ppp/ip-up
1415 A program or script which is executed when the link is available for
1416 sending and receiving IP packets (that is, IPCP has come up).  It is
1417 executed with the parameters
1418 .IP
1419 \fIinterface-name tty-device speed local-IP-address
1420 remote-IP-address ipparam\fR
1421 .TP
1422 .B /etc/ppp/ip-down
1423 A program or script which is executed when the link is no longer
1424 available for sending and receiving IP packets.  This script can be
1425 used for undoing the effects of the /etc/ppp/ip-up script.  It is
1426 invoked in the same manner and with the same parameters as the ip-up
1427 script.
1428 .TP
1429 .B /etc/ppp/ipv6-up
1430 Like /etc/ppp/ip-up, except that it is executed when the link is available 
1431 for sending and receiving IPv6 packets. It is executed with the parameters
1432 .IP
1433 \fIinterface-name tty-device speed local-link-local-address
1434 remote-link-local-address ipparam\fR
1435 .TP
1436 .B /etc/ppp/ipv6-down
1437 Similar to /etc/ppp/ip-down, but it is executed when IPv6 packets can no
1438 longer be transmitted on the link. It is executed with the same parameters 
1439 as the ipv6-up script.
1440 .TP
1441 .B /etc/ppp/ipx-up
1442 A program or script which is executed when the link is available for
1443 sending and receiving IPX packets (that is, IPXCP has come up).  It is
1444 executed with the parameters
1445 .IP
1446 \fIinterface-name tty-device speed network-number local-IPX-node-address
1447 remote-IPX-node-address local-IPX-routing-protocol remote-IPX-routing-protocol
1448 local-IPX-router-name remote-IPX-router-name ipparam pppd-pid\fR 
1449 .IP
1450 The local-IPX-routing-protocol and remote-IPX-routing-protocol field
1451 may be one of the following:
1452 .IP
1453 NONE      to indicate that there is no routing protocol
1454 .br
1455 RIP       to indicate that RIP/SAP should be used
1456 .br
1457 NLSP      to indicate that Novell NLSP should be used
1458 .br
1459 RIP NLSP  to indicate that both RIP/SAP and NLSP should be used
1460 .TP
1461 .B /etc/ppp/ipx-down
1462 A program or script which is executed when the link is no longer
1463 available for sending and receiving IPX packets.  This script can be
1464 used for undoing the effects of the /etc/ppp/ipx-up script.  It is
1465 invoked in the same manner and with the same parameters as the ipx-up
1466 script.
1467 .SH FILES
1468 .TP
1469 .B /var/run/ppp\fIn\ \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\ \fR(others)
1470 Process-ID for pppd process on ppp interface unit \fIn\fR.
1471 .TP
1472 .B /var/run/ppp-\fIname\ \fR(BSD or Linux), \fB/etc/ppp/ppp-\fIname\ \fR(others)
1473 Process-ID for pppd process for logical link \fIname\fR (see the
1474 \fIlinkname\fR option).
1475 .TP
1476 .B /etc/ppp/pap-secrets
1477 Usernames, passwords and IP addresses for PAP authentication.  This
1478 file should be owned by root and not readable or writable by any other
1479 user.  Pppd will log a warning if this is not the case.
1480 .TP
1481 .B /etc/ppp/chap-secrets
1482 Names, secrets and IP addresses for CHAP authentication.  As for
1483 /etc/ppp/pap-secrets, this file should be owned by root and not
1484 readable or writable by any other user.  Pppd will log a warning if
1485 this is not the case.
1486 .TP
1487 .B /etc/ppp/options
1488 System default options for pppd, read before user default options or
1489 command-line options.
1490 .TP
1491 .B ~/.ppprc
1492 User default options, read before /etc/ppp/options.\fIttyname\fR.
1493 .TP
1494 .B /etc/ppp/options.\fIttyname
1495 System default options for the serial port being used, read after
1496 ~/.ppprc.  In forming the \fIttyname\fR part of this
1497 filename, an initial /dev/ is stripped from the port name (if
1498 present), and any slashes in the remaining part are converted to
1499 dots.
1500 .TP
1501 .B /etc/ppp/peers
1502 A directory containing options files which may contain privileged
1503 options, even if pppd was invoked by a user other than root.  The
1504 system administrator can create options files in this directory to
1505 permit non-privileged users to dial out without requiring the peer to
1506 authenticate, but only to certain trusted peers.
1508 .TP
1509 .B RFC1144
1510 Jacobson, V.
1511 \fICompressing TCP/IP headers for low-speed serial links.\fR
1512 February 1990.
1513 .TP
1514 .B RFC1321
1515 Rivest, R.
1516 .I The MD5 Message-Digest Algorithm.
1517 April 1992.
1518 .TP
1519 .B RFC1332
1520 McGregor, G.
1521 .I PPP Internet Protocol Control Protocol (IPCP).
1522 May 1992.
1523 .TP
1524 .B RFC1334
1525 Lloyd, B.; Simpson, W.A.
1526 .I PPP authentication protocols.
1527 October 1992.
1528 .TP
1529 .B RFC1661
1530 Simpson, W.A.
1531 .I The Point\-to\-Point Protocol (PPP).
1532 July 1994.
1533 .TP
1534 .B RFC1662
1535 Simpson, W.A.
1536 .I PPP in HDLC-like Framing.
1537 July 1994.
1538 .TP
1539 .B RFC2472
1540 Haskin, D.
1541 .I IP Version 6 over PPP
1542 December 1998.
1543 .SH NOTES
1544 The following signals have the specified effect when sent to pppd.
1545 .TP
1547 These signals cause pppd to terminate the link (by closing LCP),
1548 restore the serial device settings, and exit.
1549 .TP
1550 .B SIGHUP
1551 This signal causes pppd to terminate the link, restore the serial
1552 device settings, and close the serial device.  If the \fIpersist\fR or
1553 \fIdemand\fR option has been specified, pppd will try to reopen the
1554 serial device and start another connection (after the holdoff period).
1555 Otherwise pppd will exit.  If this signal is received during the
1556 holdoff period, it causes pppd to end the holdoff period immediately.
1557 .TP
1558 .B SIGUSR1
1559 This signal toggles the state of the \fIdebug\fR option.
1560 .TP
1561 .B SIGUSR2
1562 This signal causes pppd to renegotiate compression.  This can be
1563 useful to re-enable compression after it has been disabled as a result
1564 of a fatal decompression error.  (Fatal decompression errors generally
1565 indicate a bug in one or other implementation.)
1568 Paul Mackerras (, based on earlier work by
1569 Drew Perkins,
1570 Brad Clements,
1571 Karl Fox,
1572 Greg Christy,
1573 and
1574 Brad Parker.