explain about behaviour when opening the device
[ppp.git] / pppd / pppd.8
1 .\" manual page [] for pppd 2.3
2 .\" $Id: pppd.8,v 1.33 1999/03/03 00:52:08 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
9 .SH NAME
10 pppd \- Point to Point Protocol daemon
11 .SH SYNOPSIS
12 .B pppd
13 [
14 .I tty_name
15 ] [
16 .I speed
17 ] [
18 .I options
19 ]
20 .SH DESCRIPTION
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).
33 .SH FREQUENTLY USED OPTIONS
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.
40 .TP
41 .I <speed>
42 Set the baud rate to <speed> (a decimal number).  On systems such as
43 4.4BSD and NetBSD, any speed can be specified.  Other systems
44 (e.g. SunOS) allow only a limited set of speeds.
45 .TP
46 .B asyncmap \fI<map>
47 Set the async character map to <map>.  This map describes which
48 control characters cannot be successfully received over the serial
49 line.  Pppd will ask the peer to send these characters as a 2-byte
50 escape sequence.  The argument is a 32 bit hex number with each bit
51 representing a character to escape.  Bit 0 (00000001) represents the
52 character 0x00; bit 31 (80000000) represents the character 0x1f or ^_.
53 If multiple \fIasyncmap\fR options are given, the values are ORed
54 together.  If no \fIasyncmap\fR option is given, no async character
55 map will be negotiated for the receive direction; the peer should then
56 escape \fIall\fR control characters.  To escape transmitted
57 characters, use the \fIescape\fR option.
58 .TP
59 .B auth
60 Require the peer to authenticate itself before allowing network
61 packets to be sent or received.  This option is the default if the
62 system has a default route.  If neither this option nor the
63 \fInoauth\fR option is specified, pppd will only allow the peer to use
64 IP addresses to which the system does not already have a route.
65 .TP
66 .B call \fIname
67 Read options from the file /etc/ppp/peers/\fIname\fR.  This file may
68 contain privileged options, such as \fInoauth\fR, even if pppd
69 is not being run by root.  The \fIname\fR string may not begin with /
70 or include .. as a pathname component.  The format of the options file
71 is described below.
72 .TP
73 .B connect \fIscript
74 Use the executable or shell command specified by \fIscript\fR to set
75 up the serial line.  This script would typically use the chat(8)
76 program to dial the modem and start the remote ppp session.  This
77 option is privileged if the \fInoauth\fR option is used.
78 .TP
79 .B crtscts
80 Use hardware flow control (i.e. RTS/CTS) to control the flow of
81 data on the serial port.  If neither the \fIcrtscts\fR, the
82 \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR option
83 is given, the hardware flow control setting for the serial port is
84 left unchanged.
85 Some serial ports (such as Macintosh serial ports) lack a true
86 RTS output. Such serial ports use this mode to implement
87 unidirectional flow control. The serial port will
88 suspend transmission when requested by the modem (via CTS)
89 but will be unable to request the modem stop sending to the
90 computer. This mode retains the ability to use DTR as
91 a modem control line.
92 .TP
93 .B cdtrcts
94 Use a non-standard hardware flow control (i.e. DTR/CTS) to control
95 the flow of data on the serial port.  If neither the \fIcrtscts\fR,
96 the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR
97 option is given, the hardware flow control setting for the serial
98 port is left unchanged.
99 Some serial ports (such as Macintosh serial ports) lack a true
100 RTS output. Such serial ports use this mode to implement true
101 bi-directional flow control. The sacrifice is that this flow
102 control mode does not permit using DTR as a modem control line.
103 .TP
104 .B defaultroute
105 Add a default route to the system routing tables, using the peer as
106 the gateway, when IPCP negotiation is successfully completed.
107 This entry is removed when the PPP connection is broken.  This option
108 is privileged if the \fInodefaultroute\fR option has been specified.
109 .TP
110 .B disconnect \fIscript
111 Run the executable or shell command specified by \fIscript\fR after
112 pppd has terminated the link.  This script could, for example, issue
113 commands to the modem to cause it to hang up if hardware modem control
114 signals were not available.  The disconnect script is not run if the
115 modem has already hung up.  This option is privileged if the
116 \fInoauth\fR option is used.
117 .TP
118 .B escape \fIxx,yy,...
119 Specifies that certain characters should be escaped on transmission
120 (regardless of whether the peer requests them to be escaped with its
121 async control character map).  The characters to be escaped are
122 specified as a list of hex numbers separated by commas.  Note that
123 almost any character can be specified for the \fIescape\fR option,
124 unlike the \fIasyncmap\fR option which only allows control characters
125 to be specified.  The characters which may not be escaped are those
126 with hex values 0x20 - 0x3f or 0x5e.
127 .TP
128 .B file \fIname
129 Read options from file \fIname\fR (the format is described below).
130 The file must be readable by the user who has invoked pppd.
131 .TP
132 .B lock
133 Specifies that pppd should create a UUCP-style lock file for the
134 serial device to ensure exclusive access to the device.
135 .TP
136 .B mru \fIn
137 Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd
138 will ask the peer to send packets of no more than \fIn\fR bytes.  The
139 minimum MRU value is 128.  The default MRU value is 1500.  A value of
140 296 is recommended for slow links (40 bytes for TCP/IP header + 256
141 bytes of data).
142 .TP
143 .B mtu \fIn
144 Set the MTU [Maximum Transmit Unit] value to \fIn\fR.  Unless the
145 peer requests a smaller value via MRU negotiation, pppd will
146 request that the kernel networking code send data packets of no more
147 than \fIn\fR bytes through the PPP network interface. 
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.
154 .SH OPTIONS
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. 150.234.56.78).  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 active-filter \fIfilter-expression
171 Specifies a packet filter to be applied to data packets to determine
172 which packets are to be regarded as link activity, and therefore reset
173 the idle timer, or cause the link to be brought up in demand-dialling
174 mode.  This option is useful in conjunction with the
175 \fBidle\fR option if there are packets being sent or received
176 regularly over the link (for example, routing information packets)
177 which would otherwise prevent the link from ever appearing to be idle.
178 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
179 except that qualifiers which are inappropriate for a PPP link, such as
180 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
181 expression should be enclosed in single-quotes to prevent whitespace
182 in the expression from being interpreted by the shell. This option
183 is currently only available under NetBSD, and then only
184 if both the kernel and pppd were compiled with PPP_FILTER defined.
185 .TP
186 .B bsdcomp \fInr,nt
187 Request that the peer compress packets that it sends, using the
188 BSD-Compress scheme, with a maximum code size of \fInr\fR bits, and
189 agree to compress packets sent to the peer with a maximum code size of
190 \fInt\fR bits.  If \fInt\fR is not specified, it defaults to the value
191 given for \fInr\fR.  Values in the range 9 to 15 may be used for
192 \fInr\fR and \fInt\fR; larger values give better compression but
193 consume more kernel memory for compression dictionaries.
194 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
195 compression in the corresponding direction.  Use \fInobsdcomp\fR or
196 \fIbsdcomp 0\fR to disable BSD-Compress compression entirely.
197 .TP
198 .B chap-interval \fIn
199 If this option is given, pppd will rechallenge the peer every \fIn\fR
200 seconds.
201 .TP
202 .B chap-max-challenge \fIn
203 Set the maximum number of CHAP challenge transmissions to \fIn\fR
204 (default 10).
205 .TP
206 .B chap-restart \fIn
207 Set the CHAP restart interval (retransmission timeout for challenges)
208 to \fIn\fR seconds (default 3).
209 .TP
210 .B debug
211 Enables connection debugging facilities.
212 If this option is given, pppd will log the contents of all
213 control packets sent or received in a readable form.  The packets are
214 logged through syslog with facility \fIdaemon\fR and level
215 \fIdebug\fR.  This information can be directed to a file by setting up
216 /etc/syslog.conf appropriately (see syslog.conf(5)).
217 .TP
218 .B default-asyncmap
219 Disable asyncmap negotiation, forcing all control characters to be
220 escaped for both the transmit and the receive direction.
221 .TP
222 .B default-mru
223 Disable MRU [Maximum Receive Unit] negotiation.  With this option,
224 pppd will use the default MRU value of 1500 bytes for both the
225 transmit and receive direction.
226 .TP
227 .B deflate \fInr,nt
228 Request that the peer compress packets that it sends, using the
229 Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
230 agree to compress packets sent to the peer with a maximum window size
231 of \fI2**nt\fR bytes.  If \fInt\fR is not specified, it defaults to
232 the value given for \fInr\fR.  Values in the range 8 to 15 may be used
233 for \fInr\fR and \fInt\fR; larger values give better compression but
234 consume more kernel memory for compression dictionaries.
235 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
236 compression in the corresponding direction.  Use \fInodeflate\fR or
237 \fIdeflate 0\fR to disable Deflate compression entirely.  (Note: pppd
238 requests Deflate compression in preference to BSD-Compress if the peer
239 can do either.)
240 .TP
241 .B demand
242 Initiate the link only on demand, i.e. when data traffic is present.
243 With this option, the remote IP address must be specified by the user
244 on the command line or in an options file.  Pppd will initially
245 configure the interface and enable it for IP traffic without
246 connecting to the peer.  When traffic is available, pppd will
247 connect to the peer and perform negotiation, authentication, etc.
248 When this is completed, pppd will commence passing data packets
249 (i.e., IP packets) across the link.
250
251 The \fIdemand\fR option implies the \fIpersist\fR option.  If this
252 behaviour is not desired, use the \fInopersist\fR option after the
253 \fIdemand\fR option.  The \fIidle\fR and \fIholdoff\fR
254 options are also useful in conjuction with the \fIdemand\fR option.
255 .TP
256 .B domain \fId
257 Append the domain name \fId\fR to the local host name for authentication
258 purposes.  For example, if gethostname() returns the name porsche, but
259 the fully qualified domain name is porsche.Quotron.COM, you could
260 specify \fIdomain Quotron.COM\fR.  Pppd would then use the name
261 \fIporsche.Quotron.COM\fR for looking up secrets in the secrets file,
262 and as the default name to send to the peer when authenticating itself
263 to the peer.  This option is privileged.
264 .TP
265 .B hide-password
266 When logging the contents of PAP packets, this option causes pppd to
267 exclude the password string from the log.
268 .TP
269 .B holdoff \fIn
270 Specifies how many seconds to wait before re-initiating the link after
271 it terminates.  This option only has any effect if the \fIpersist\fR
272 or \fIdemand\fR option is used.  The holdoff period is not applied if
273 the link was terminated because it was idle.
274 .TP
275 .B idle \fIn
276 Specifies that pppd should disconnect if the link is idle for \fIn\fR
277 seconds.  The link is idle when no data packets (i.e. IP packets) are
278 being sent or received.  Note: it is not advisable to use this option
279 with the \fIpersist\fR option without the \fIdemand\fR option.
280 If the \fBactive-filter\fR
281 option is given, data packets which are rejected by the specified
282 activity filter also count as the link being idle.
283 .TP
284 .B ipcp-accept-local
285 With this option, pppd will accept the peer's idea of our local IP
286 address, even if the local IP address was specified in an option.
287 .TP
288 .B ipcp-accept-remote
289 With this option, pppd will accept the peer's idea of its (remote) IP
290 address, even if the remote IP address was specified in an option.
291 .TP
292 .B ipcp-max-configure \fIn
293 Set the maximum number of IPCP configure-request transmissions to
294 \fIn\fR (default 10).
295 .TP
296 .B ipcp-max-failure \fIn
297 Set the maximum number of IPCP configure-NAKs returned before starting
298 to send configure-Rejects instead to \fIn\fR (default 10).
299 .TP
300 .B ipcp-max-terminate \fIn
301 Set the maximum number of IPCP terminate-request transmissions to
302 \fIn\fR (default 3).
303 .TP
304 .B ipcp-restart \fIn
305 Set the IPCP restart interval (retransmission timeout) to \fIn\fR
306 seconds (default 3).
307 .TP
308 .B ipparam \fIstring
309 Provides an extra parameter to the ip-up and ip-down scripts.  If this
310 option is given, the \fIstring\fR supplied is given as the 6th
311 parameter to those scripts.
312 .TP
313 .B ipx
314 Enable the IPXCP and IPX protocols.  This option is presently only
315 supported under Linux, and only if your kernel has been configured to
316 include IPX support.
317 .TP
318 .B ipx-network \fIn
319 Set the IPX network number in the IPXCP configure request frame to
320 \fIn\fR, a hexadecimal number (without a leading 0x).  There is no
321 valid default.  If this option is not specified, the network number is
322 obtained from the peer.  If the peer does not have the network number,
323 the IPX protocol will not be started.
324 .TP
325 .B ipx-node \fIn\fB:\fIm
326 Set the IPX node numbers. The two node numbers are separated from each
327 other with a colon character. The first number \fIn\fR is the local
328 node number. The second number \fIm\fR is the peer's node number. Each
329 node number is a hexadecimal number, at most 10 digits long. The node
330 numbers on the ipx-network must be unique. There is no valid
331 default. If this option is not specified then the node numbers are
332 obtained from the peer.
333 .TP
334 .B ipx-router-name \fI<string>
335 Set the name of the router. This is a string and is sent to the peer
336 as information data.
337 .TP
338 .B ipx-routing \fIn
339 Set the routing protocol to be received by this option. More than one
340 instance of \fIipx-routing\fR may be specified. The '\fInone\fR'
341 option (0) may be specified as the only instance of ipx-routing. The
342 values may be \fI0\fR for \fINONE\fR, \fI2\fR for \fIRIP/SAP\fR, and
343 \fI4\fR for \fINLSP\fR.
344 .TP
345 .B ipxcp-accept-local
346 Accept the peer's NAK for the node number specified in the ipx-node
347 option. If a node number was specified, and non-zero, the default is
348 to insist that the value be used. If you include this option then you
349 will permit the peer to override the entry of the node number.
350 .TP
351 .B ipxcp-accept-network
352 Accept the peer's NAK for the network number specified in the
353 ipx-network option. If a network number was specified, and non-zero, the
354 default is to insist that the value be used. If you include this
355 option then you will permit the peer to override the entry of the node
356 number.
357 .TP
358 .B ipxcp-accept-remote
359 Use the peer's network number specified in the configure request
360 frame. If a node number was specified for the peer and this option was
361 not specified, the peer will be forced to use the value which you have
362 specified.
363 .TP
364 .B ipxcp-max-configure \fIn
365 Set the maximum number of IPXCP configure request frames which the
366 system will send to \fIn\fR. The default is 10.
367 .TP
368 .B ipxcp-max-failure \fIn
369 Set the maximum number of IPXCP NAK frames which the local system will
370 send before it rejects the options. The default value is 3.
371 .TP
372 .B ipxcp-max-terminate \fIn
373 Set the maximum nuber of IPXCP terminate request frames before the
374 local system considers that the peer is not listening to them. The
375 default value is 3.
376 .TP
377 .B kdebug \fIn
378 Enable debugging code in the kernel-level PPP driver.  The argument
379 \fIn\fR is a number which is the sum of the following values: 1 to
380 enable general debug messages, 2 to request that the contents of
381 received packets be printed, and 4 to request that the contents of
382 transmitted packets be printed.  On most systems, messages printed by
383 the kernel are logged by syslog(1) to a file as directed in the
384 /etc/syslog.conf configuration file.
385 .TP
386 .B lcp-echo-failure \fIn
387 If this option is given, pppd will presume the peer to be dead
388 if \fIn\fR LCP echo-requests are sent without receiving a valid LCP
389 echo-reply.  If this happens, pppd will terminate the
390 connection.  Use of this option requires a non-zero value for the
391 \fIlcp-echo-interval\fR parameter.  This option can be used to enable
392 pppd to terminate after the physical connection has been broken
393 (e.g., the modem has hung up) in situations where no hardware modem
394 control lines are available.
395 .TP
396 .B lcp-echo-interval \fIn
397 If this option is given, pppd will send an LCP echo-request frame to
398 the peer every \fIn\fR seconds.  Normally the peer should respond to
399 the echo-request by sending an echo-reply.  This option can be used
400 with the \fIlcp-echo-failure\fR option to detect that the peer is no
401 longer connected.
402 .TP
403 .B lcp-max-configure \fIn
404 Set the maximum number of LCP configure-request transmissions to
405 \fIn\fR (default 10).
406 .TP
407 .B lcp-max-failure \fIn
408 Set the maximum number of LCP configure-NAKs returned before starting
409 to send configure-Rejects instead to \fIn\fR (default 10).
410 .TP
411 .B lcp-max-terminate \fIn
412 Set the maximum number of LCP terminate-request transmissions to
413 \fIn\fR (default 3).
414 .TP
415 .B lcp-restart \fIn
416 Set the LCP restart interval (retransmission timeout) to \fIn\fR
417 seconds (default 3).
418 .TP
419 .B local
420 Don't use the modem control lines.  With this option, pppd will ignore
421 the state of the CD (Carrier Detect) signal from the modem and will
422 not change the state of the DTR (Data Terminal Ready) signal.
423 .TP
424 .B login
425 Use the system password database for authenticating the peer using
426 PAP, and record the user in the system wtmp file.  Note that the peer
427 must have an entry in the /etc/ppp/pap-secrets file as well as the
428 system password database to be allowed access.
429 .TP
430 .B maxconnect \fIn
431 Terminate the connection when it has been available for network
432 traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first
433 network control protocol comes up).
434 .TP
435 .B modem
436 Use the modem control lines.  This option is the default.  With this
437 option, pppd will wait for the CD (Carrier Detect) signal from the
438 modem to be asserted when opening the serial device (unless a connect
439 script is specified), and it will drop the DTR (Data Terminal Ready)
440 signal briefly when the connection is terminated and before executing
441 the connect script.  On Ultrix, this option implies hardware flow
442 control, as for the \fIcrtscts\fR option.
443 .TP
444 .B ms-dns \fI<addr>
445 If pppd is acting as a server for Microsoft Windows clients, this
446 option allows pppd to supply one or two DNS (Domain Name Server)
447 addresses to the clients.  The first instance of this option specifies
448 the primary DNS address; the second instance (if given) specifies the
449 secondary DNS address.  (This option was present in some older
450 versions of pppd under the name \fBdns-addr\fR.)
451 .TP
452 .B ms-wins \fI<addr>
453 If pppd is acting as a server for Microsoft Windows or "Samba"
454 clients, this option allows pppd to supply one or two WINS (Windows
455 Internet Name Services) server addresses to the clients.  The first
456 instance of this option specifies the primary WINS address; the second
457 instance (if given) specifies the secondary WINS address.
458 .TP
459 .B name \fIname
460 Set the name of the local system for authentication purposes to
461 \fIname\fR.  This is a privileged option.  With this option, pppd will
462 use lines in the secrets files which have \fIname\fR as the second
463 field when looking for a secret to use in authenticating the peer.  In
464 addition, unless overridden with the \fIuser\fR option, \fIname\fR
465 will be used as the name to send to the peer when authenticating the
466 local system to the peer.  (Note that pppd does not append the domain
467 name to \fIname\fR.)
468 .TP
469 .B netmask \fIn
470 Set the interface netmask to \fIn\fR, a 32 bit netmask in "decimal dot"
471 notation (e.g. 255.255.255.0).  If this option is given, the value
472 specified is ORed with the default netmask.  The default netmask is
473 chosen based on the negotiated remote IP address; it is the
474 appropriate network mask for the class of the remote IP address, ORed
475 with the netmasks for any non point-to-point network interfaces in the
476 system which are on the same network.  (Note: on some platforms, pppd
477 will always use 255.255.255.255 for the netmask, if that is the only
478 appropriate value for a point-to-point interface.)
479 .TP
480 .B noaccomp
481 Disable Address/Control compression in both directions (send and
482 receive).
483 .TP
484 .B noauth
485 Do not require the peer to authenticate itself.  This option is
486 privileged.
487 .TP
488 .B nobsdcomp
489 Disables BSD-Compress compression; \fBpppd\fR will not request or
490 agree to compress packets using the BSD-Compress scheme.
491 .TP
492 .B noccp
493 Disable CCP (Compression Control Protocol) negotiation.  This option
494 should only be required if the peer is buggy and gets confused by
495 requests from pppd for CCP negotiation.
496 .TP
497 .B nocrtscts
498 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
499 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the
500 \fIcdtrcts\fR nor the \fInodtrcts\fR option is given, the hardware
501 flow control setting for the serial port is left unchanged.
502 .TP
503 .B nodtrcts
504 This option is a synonym for \fInocrtscts\fR. Either of these options will
505 disable both forms of hardware flow control.
506 .TP
507 .B nodefaultroute
508 Disable the \fIdefaultroute\fR option.  The system administrator who
509 wishes to prevent users from creating default routes with pppd
510 can do so by placing this option in the /etc/ppp/options file.
511 .TP
512 .B nodeflate
513 Disables Deflate compression; pppd will not request or agree to
514 compress packets using the Deflate scheme.
515 .TP
516 .B nodetach
517 Don't detach from the controlling terminal.  Without this option, if a
518 serial device other than the terminal on the standard input is
519 specified, pppd will fork to become a background process.
520 .TP
521 .B noip
522 Disable IPCP negotiation and IP communication.  This option should
523 only be required if the peer is buggy and gets confused by requests
524 from pppd for IPCP negotiation.
525 .TP
526 .B noipdefault
527 Disables the default behaviour when no local IP address is specified,
528 which is to determine (if possible) the local IP address from the
529 hostname.  With this option, the peer will have to supply the local IP
530 address during IPCP negotiation (unless it specified explicitly on the
531 command line or in an options file).
532 .TP
533 .B noipx
534 Disable the IPXCP and IPX protocols.  This option should only be
535 required if the peer is buggy and gets confused by requests from pppd
536 for IPXCP negotiation.
537 .TP
538 .B nomagic
539 Disable magic number negotiation.  With this option, pppd cannot
540 detect a looped-back line.  This option should only be needed if the
541 peer is buggy.
542 .TP
543 .B nopcomp
544 Disable protocol field compression negotiation in both the receive and
545 the transmit direction.
546 .TP
547 .B nopersist
548 Exit once a connection has been made and terminated.  This is the
549 default unless the \fIpersist\fR or \fIdemand\fR option has been
550 specified.
551 .TP
552 .B nopredictor1
553 Do not accept or agree to Predictor-1 comprssion.
554 .TP
555 .B noproxyarp
556 Disable the \fIproxyarp\fR option.  The system administrator who
557 wishes to prevent users from creating proxy ARP entries with pppd can
558 do so by placing this option in the /etc/ppp/options file.
559 .TP
560 .B novj
561 Disable Van Jacobson style TCP/IP header compression in both the
562 transmit and the receive direction.
563 .TP
564 .B novjccomp
565 Disable the connection-ID compression option in Van Jacobson style
566 TCP/IP header compression.  With this option, pppd will not omit the
567 connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
568 ask the peer to do so.
569 .TP
570 .B papcrypt
571 Indicates that all secrets in the /etc/ppp/pap-secrets file which are
572 used for checking the identity of the peer are encrypted, and thus
573 pppd should not accept a password which, before encryption, is
574 identical to the secret from the /etc/ppp/pap-secrets file.
575 .TP
576 .B pap-max-authreq \fIn
577 Set the maximum number of PAP authenticate-request transmissions to
578 \fIn\fR (default 10).
579 .TP
580 .B pap-restart \fIn
581 Set the PAP restart interval (retransmission timeout) to \fIn\fR
582 seconds (default 3).
583 .TP
584 .B pap-timeout \fIn
585 Set the maximum time that pppd will wait for the peer to authenticate
586 itself with PAP to \fIn\fR seconds (0 means no limit).
587 .TP
588 .B pass-filter \fIfilter-expression
589 Specifies a packet filter to applied to data packets being sent or
590 received to determine which packets should be allowed to pass.
591 Packets which are rejected by the filter are silently discarded.  This
592 option can be used to prevent specific network daemons (such as
593 routed) using up link bandwidth, or to provide a basic firewall
594 capability.
595 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
596 except that qualifiers which are inappropriate for a PPP link, such as
597 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
598 expression should be enclosed in single-quotes to prevent whitespace
599 in the expression from being interpreted by the shell.  Note that it
600 is possible to apply different constraints to incoming and outgoing
601 packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. This
602 option is currently only available under NetBSD, and then only if both
603 the kernel and pppd were compiled with PPP_FILTER defined.
604 .TP
605 .B persist
606 Do not exit after a connection is terminated; instead try to reopen
607 the connection.
608 .TP
609 .B predictor1
610 Request that the peer compress frames that it sends using Predictor-1
611 compression, and agree to compress transmitted frames with Predictor-1
612 if requested.  This option has no effect unless the kernel driver
613 supports Predictor-1 compression.
614 .TP
615 .B proxyarp
616 Add an entry to this system's ARP [Address Resolution Protocol] table
617 with the IP address of the peer and the Ethernet address of this
618 system.  This will have the effect of making the peer appear to other
619 systems to be on the local ethernet.
620 .TP
621 .B remotename \fIname
622 Set the assumed name of the remote system for authentication purposes
623 to \fIname\fR.
624 .TP
625 .B refuse-chap
626 With this option, pppd will not agree to authenticate itself to the
627 peer using CHAP.
628 .TP
629 .B refuse-pap
630 With this option, pppd will not agree to authenticate itself to the
631 peer using PAP.
632 .TP
633 .B require-chap
634 Require the peer to authenticate itself using CHAP [Challenge
635 Handshake Authentication Protocol] authentication.
636 .TP
637 .B require-pap
638 Require the peer to authenticate itself using PAP [Password
639 Authentication Protocol] authentication.
640 .TP
641 .B silent
642 With this option, pppd will not transmit LCP packets to initiate a
643 connection until a valid LCP packet is received from the peer (as for
644 the `passive' option with ancient versions of pppd).
645 .TP
646 .B usehostname
647 Enforce the use of the hostname (with domain name appended, if given)
648 as the name of the local system for authentication purposes (overrides
649 the \fIname\fR option).  This option is not normally needed since the
650 \fIname\fR option is privileged.
651 .TP
652 .B user \fIname
653 Sets the name used for authenticating the local system to the peer to
654 \fIname\fR.
655 .TP
656 .B vj-max-slots \fIn
657 Sets the number of connection slots to be used by the Van Jacobson
658 TCP/IP header compression and decompression code to \fIn\fR, which
659 must be between 2 and 16 (inclusive).
660 .TP
661 .B welcome \fIscript
662 Run the executable or shell command specified by \fIscript\fR before
663 initiating PPP negotiation, after the connect script (if any) has
664 completed.  This option is privileged if the \fInoauth\fR option is
665 used.
666 .TP
667 .B xonxoff
668 Use software flow control (i.e. XON/XOFF) to control the flow of data on
669 the serial port.
670 .SH OPTIONS FILES
671 Options can be taken from files as well as the command line.  Pppd
672 reads options from the files /etc/ppp/options, ~/.ppprc and
673 /etc/ppp/options.\fIttyname\fR (in that order) before processing the
674 options on the command line.  (In fact, the command-line options are
675 scanned to find the terminal name before the options.\fIttyname\fR
676 file is read.)  In forming the name of the options.\fIttyname\fR file,
677 the initial /dev/ is removed from the terminal name, and any remaining
678 / characters are replaced with dots.
679 .PP
680 An options file is parsed into a series of words, delimited by
681 whitespace.  Whitespace can be included in a word by enclosing the
682 word in double-quotes (").  A backslash (\\) quotes the following character.
683 A hash (#) starts a comment, which continues until the end of the
684 line.  There is no restriction on using the \fIfile\fR or \fIcall\fR
685 options within an options file.
686 .SH SECURITY
687 .I pppd
688 provides system administrators with sufficient access control that PPP
689 access to a server machine can be provided to legitimate users without
690 fear of compromising the security of the server or the network it's
691 on.  This control is provided through restrictions on which IP
692 addresses the peer may use, based on its authenticated identity (if
693 any), and through restrictions on which options a non-privileged user
694 may use.  Several of pppd's options are privileged, in particular
695 those which permit potentially insecure configurations; these options
696 are only accepted in files which are under the control of the system
697 administrator, or if pppd is being run by root.
698 .PP
699 The default behaviour of pppd is to allow an unauthenticated peer to
700 use a given IP address only if the system does not already have a
701 route to that IP address.  For example, a system with a
702 permanent connection to the wider internet will normally have a
703 default route, and thus all peers will have to authenticate themselves
704 in order to set up a connection.  On such a system, the \fIauth\fR
705 option is the default.  On the other hand, a system where the
706 PPP link is the only connection to the internet will not normally have
707 a default route, so the peer will be able to use almost any IP address
708 without authenticating itself.
709 .PP
710 As indicated above, some security-sensitive options are privileged,
711 which means that they may not be used by an ordinary non-privileged
712 user running a setuid-root pppd, either on the command line, in the
713 user's ~/.ppprc file, or in an options file read using the \fIfile\fR
714 option.  Privileged options may be used in /etc/ppp/options file or in
715 an options file read using the \fIcall\fR option.  If pppd is being
716 run by the root user, privileged options can be used without
717 restriction.
718 .PP
719 When opening the device, pppd uses either the invoking user's user ID
720 or the root UID (that is, 0), depending on whether the device name was
721 specified by the user or the system administrator.  If the device name
722 comes from a privileged source, that is, /etc/ppp/options or an
723 options file read using the \fIcall\fR option, pppd uses full root
724 privileges when opening the device.  Thus, by creating an appropriate
725 file under /etc/ppp/peers, the system administrator can allow users to
726 establish a ppp connection via a device which they would not normally
727 have permission to access.  Otherwise pppd uses the invoking user's
728 real UID when opening the device.
729 .SH AUTHENTICATION
730 Authentication is the process whereby one peer convinces the other of
731 its identity.  This involves the first peer sending its name to the
732 other, together with some kind of secret information which could only
733 come from the genuine authorized user of that name.  In such an
734 exchange, we will call the first peer the "client" and the other the
735 "server".  The client has a name by which it identifies itself to the
736 server, and the server also has a name by which it identifies itself
737 to the client.  Generally the genuine client shares some secret (or
738 password) with the server, and authenticates itself by proving that it
739 knows that secret.  Very often, the names used for authentication
740 correspond to the internet hostnames of the peers, but this is not
741 essential.
742 .LP
743 At present, pppd supports two authentication protocols: the Password
744 Authentication Protocol (PAP) and the Challenge Handshake
745 Authentication Protocol (CHAP).  PAP involves the client sending its
746 name and a cleartext password to the server to authenticate itself.
747 In contrast, the server initiates the CHAP authentication exchange by
748 sending a challenge to the client (the challenge packet includes the
749 server's name).  The client must respond with a response which
750 includes its name plus a hash value derived from the shared secret and
751 the challenge, in order to prove that it knows the secret.
752 .LP
753 The PPP protocol, being symmetrical, allows both peers to require the
754 other to authenticate itself.  In that case, two separate and
755 independent authentication exchanges will occur.  The two exchanges
756 could use different authentication protocols, and in principle,
757 different names could be used in the two exchanges.
758 .LP
759 The default behaviour of pppd is to agree to authenticate if
760 requested, and to not require authentication from the peer.  However,
761 pppd will not agree to authenticate itself with a particular protocol
762 if it has no secrets which could be used to do so.
763 .LP
764 Pppd stores secrets for use in authentication in secrets
765 files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP).
766 Both secrets files have the same format.  The secrets files can
767 contain secrets for pppd to use in authenticating itself to other
768 systems, as well as secrets for pppd to use when authenticating other
769 systems to itself.
770 .LP
771 Each line in a secrets file contains one secret.  A given secret is
772 specific to a particular combination of client and server - it can
773 only be used by that client to authenticate itself to that server.
774 Thus each line in a secrets file has at least 3 fields: the name of
775 the client, the name of the server, and the secret.  These fields may
776 be followed by a list of the IP addresses that the specified client
777 may use when connecting to the specified server.
778 .LP
779 A secrets file is parsed into words as for a options file, so the
780 client name, server name and secrets fields must each be one word,
781 with any embedded spaces or other special characters quoted or
782 escaped.  Any following words on the same line are taken to be a list
783 of acceptable IP addresses for that client.  If there are only 3 words
784 on the line, or if the first word is "-", then all IP addresses are
785 disallowed.  To allow any address, use "*".
786 A word starting with "!" indicates that the
787 specified address is \fInot\fR acceptable.  An address may be followed
788 by "/" and a number \fIn\fR, to indicate a whole subnet, i.e. all
789 addresses which have the same value in the most significant \fIn\fR
790 bits.  Note that case is significant in the client and server names
791 and in the secret.
792 .LP
793 If the secret starts with an `@', what follows is assumed to be the
794 name of a file from which to read the secret.  A "*" as the client or
795 server name matches any name.  When selecting a secret, pppd takes the
796 best match, i.e.  the match with the fewest wildcards.
797 .LP
798 Thus a secrets file contains both secrets for use in authenticating
799 other hosts, plus secrets which we use for authenticating ourselves to
800 others.  When pppd is authenticating the peer (checking the peer's
801 identity), it chooses a secret with the peer's name in the first
802 field and the name of the local system in the second field.  The
803 name of the local system defaults to the hostname, with the domain
804 name appended if the \fIdomain\fR option is used.  This default can be
805 overridden with the \fIname\fR option, except when the
806 \fIusehostname\fR option is used.
807 .LP
808 When pppd is choosing a secret to use in authenticating itself to the
809 peer, it first determines what name it is going to use to identify
810 itself to the peer.  This name can be specified by the user with the
811 \fIuser\fR option.  If this option is not used, the name defaults to
812 the name of the local system, determined as described in the previous
813 paragraph.  Then pppd looks for a secret with this name in the first
814 field and the peer's name in the second field.  Pppd will know the
815 name of the peer if CHAP authentication is being used, because the
816 peer will have sent it in the challenge packet.  However, if PAP is being
817 used, pppd will have to determine the peer's name from the options
818 specified by the user.  The user can specify the peer's name directly
819 with the \fIremotename\fR option.  Otherwise, if the remote IP address
820 was specified by a name (rather than in numeric form), that name will
821 be used as the peer's name.  Failing that, pppd will use the null
822 string as the peer's name.
823 .LP
824 When authenticating the peer with PAP, the supplied password is first
825 compared with the secret from the secrets file.  If the password
826 doesn't match the secret, the password is encrypted using crypt() and
827 checked against the secret again.  Thus secrets for authenticating the
828 peer can be stored in encrypted form if desired.  If the
829 \fIpapcrypt\fR option is given, the first (unencrypted) comparison is
830 omitted, for better security.
831 .LP
832 Furthermore, if the \fIlogin\fR option was specified, the username and
833 password are also checked against the system password database.  Thus,
834 the system administrator can set up the pap-secrets file to allow PPP
835 access only to certain users, and to restrict the set of IP addresses
836 that each user can use.  Typically, when using the \fIlogin\fR option,
837 the secret in /etc/ppp/pap-secrets would be "", which will match any
838 password supplied by the peer.  This avoids the need to have the same
839 secret in two places.
840 .LP
841 Authentication must be satisfactorily completed before IPCP (or any
842 other Network Control Protocol) can be started.  If the peer is
843 required to authenticate itself, and fails to do so, pppd will
844 terminated the link (by closing LCP).  If IPCP negotiates an
845 unacceptable IP address for the remote host, IPCP will be closed.  IP
846 packets can only be sent or received when IPCP is open.
847 .LP
848 In some cases it is desirable to allow some hosts which can't
849 authenticate themselves to connect and use one of a restricted set of
850 IP addresses, even when the local host generally requires
851 authentication.  If the peer refuses to authenticate itself when
852 requested, pppd takes that as equivalent to authenticating with PAP
853 using the empty string for the username and password.  Thus, by adding
854 a line to the pap-secrets file which specifies the empty string for
855 the client and password, it is possible to allow restricted access to
856 hosts which refuse to authenticate themselves.
857 .SH ROUTING
858 .LP
859 When IPCP negotiation is completed successfully, pppd will inform the
860 kernel of the local and remote IP addresses for the ppp interface.
861 This is sufficient to create a host route to the remote end of the
862 link, which will enable the peers to exchange IP packets.
863 Communication with other machines generally requires further
864 modification to routing tables and/or ARP (Address Resolution
865 Protocol) tables.  In most cases the \fIdefaultroute\fR and/or
866 \fIproxyarp\fR options are sufficient for this, but in some cases
867 further intervention is required.  The /etc/ppp/ip-up script can be
868 used for this.
869 .LP
870 Sometimes it is desirable to add a default route through the remote
871 host, as in the case of a machine whose only connection to the
872 Internet is through the ppp interface.  The \fIdefaultroute\fR option
873 causes pppd to create such a default route when IPCP comes up, and
874 delete it when the link is terminated.
875 .LP
876 In some cases it is desirable to use proxy ARP, for example on a
877 server machine connected to a LAN, in order to allow other hosts to
878 communicate with the remote host.  The \fIproxyarp\fR option causes
879 pppd to look for a network interface on the same subnet as the remote
880 host (an interface supporting broadcast and ARP, which is up and not a
881 point-to-point or loopback interface).  If found, pppd creates a
882 permanent, published ARP entry with the IP address of the remote host
883 and the hardware address of the network interface found.
884 .LP
885 When the \fIdemand\fR option is used, the interface IP addresses have
886 already been set at the point when IPCP comes up.  If pppd has not
887 been able to negotiate the same addresses that it used to configure
888 the interface (for example when the peer is an ISP that uses dynamic
889 IP address assignment), pppd has to change the interface IP addresses
890 to the negotiated addresses.  This may disrupt existing connections,
891 and the use of demand dialling with peers that do dynamic IP address
892 assignment is not recommended.
893 .SH EXAMPLES
894 .LP
895 The following examples assume that the /etc/ppp/options file contains
896 the \fIauth\fR option (as in the default /etc/ppp/options file in the
897 ppp distribution).
898 .LP
899 Probably the most common use of pppd is to dial out to an ISP.  This
900 can be done with a command such as
901 .IP
902 pppd call isp
903 .LP
904 where the /etc/ppp/peers/isp file is set up by the system
905 administrator to contain something like this:
906 .IP
907 ttyS0 19200 crtscts
908 .br
909 connect '/usr/sbin/chat -v -f /etc/ppp/chat-isp'
910 .br
911 noauth
912 .LP
913 In this example, we are using chat to dial the ISP's modem and go
914 through any logon sequence required.  The /etc/ppp/chat-isp file
915 contains the script used by chat; it could for example contain
916 something like this:
917 .IP
918 ABORT "NO CARRIER"
919 .br
920 ABORT "NO DIALTONE"
921 .br
922 ABORT "ERROR"
923 .br
924 ABORT "NO ANSWER"
925 .br
926 ABORT "BUSY"
927 .br
928 ABORT "Username/Password Incorrect"
929 .br
930 "" "at"
931 .br
932 OK "at&d0&c1"
933 .br
934 OK "atdt2468135"
935 .br
936 "name:" "^Umyuserid"
937 .br
938 "word:" "\\qmypassword"
939 .br
940 "ispts" "\\q^Uppp"
941 .br
942 "~-^Uppp-~"
943 .LP
944 See the chat(8) man page for details of chat scripts.
945 .LP
946 Pppd can also be used to provide a dial-in ppp service for users.  If
947 the users already have login accounts, the simplest way to set up the
948 ppp service is to let the users log in to their accounts and run pppd
949 (installed setuid-root) with a command such as
950 .IP
951 pppd proxyarp
952 .LP
953 To allow a user to use the PPP facilities, you need to allocate an IP
954 address for that user's machine and create an entry in
955 /etc/ppp/pap-secrets or /etc/ppp/chap-secrets (depending on which
956 authentication method the PPP implementation on the user's machine
957 supports), so that the user's
958 machine can authenticate itself.  For example, if Joe has a machine
959 called "joespc" which is to be allowed to dial in to the machine
960 called "server" and use the IP address joespc.my.net, you would add an
961 entry like this to /etc/ppp/pap-secrets or /etc/ppp/chap-secrets:
962 .IP
963 joespc  server  "joe's secret"  joespc.my.net
964 .LP
965 Alternatively, you can create a username called (for example) "ppp",
966 whose login shell is pppd and whose home directory is /etc/ppp.
967 Options to be used when pppd is run this way can be put in
968 /etc/ppp/.ppprc.
969 .LP
970 If your serial connection is any more complicated than a piece of
971 wire, you may need to arrange for some control characters to be
972 escaped.  In particular, it is often useful to escape XON (^Q) and
973 XOFF (^S), using \fIasyncmap a0000\fR.  If the path includes a telnet,
974 you probably should escape ^] as well (\fIasyncmap 200a0000\fR).  If
975 the path includes an rlogin, you will need to use the \fIescape ff\fR
976 option on the end which is running the rlogin client, since many
977 rlogin implementations are not transparent; they will remove the
978 sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the
979 stream.
980 .SH DIAGNOSTICS
981 .LP
982 Messages are sent to the syslog daemon using facility LOG_DAEMON.
983 (This can be overriden by recompiling pppd with the macro
984 LOG_PPP defined as the desired facility.)  In order to see the error
985 and debug messages, you will need to edit your /etc/syslog.conf file
986 to direct the messages to the desired output device or file.
987 .LP
988 The \fIdebug\fR option causes the contents of all control packets sent
989 or received to be logged, that is, all LCP, PAP, CHAP or IPCP packets.
990 This can be useful if the PPP negotiation does not succeed or if
991 authentication fails.
992 If debugging is enabled at compile time, the \fIdebug\fR option also
993 causes other debugging messages to be logged.
994 .LP
995 Debugging can also be enabled or disabled by sending a SIGUSR1 signal
996 to the pppd process.  This signal acts as a toggle.
997 .SH SCRIPTS
998 Pppd invokes scripts at various stages in its processing which can be
999 used to perform site-specific ancillary processing.  These scripts are
1000 usually shell scripts, but could be executable code files instead.
1001 Pppd does not wait for the scripts to finish.  The scripts are
1002 executed as root (with the real and effective user-id set to 0), so
1003 that they can do things such as update routing tables or run
1004 privileged daemons.  Be careful that the contents of these scripts do
1005 not compromise your system's security.  Pppd runs the scripts with
1006 standard input, output and error redirected to /dev/null, and with an
1007 environment that is empty except for some environment variables that
1008 give information about the link.  The environment variables that pppd
1009 sets are:
1010 .TP
1011 .B DEVICE
1012 The name of the serial tty device being used.
1013 .TP
1014 .B IFNAME
1015 The name of the network interface being used.
1016 .TP
1017 .B IPLOCAL
1018 The IP address for the local end of the link.  This is only set when
1019 IPCP has come up.
1020 .TP
1021 .B IPREMOTE
1022 The IP address for the remote end of the link.  This is only set when
1023 IPCP has come up.
1024 .TP
1025 .B PEERNAME
1026 The authenticated name of the peer.  This is only set if the peer
1027 authenticates itself.
1028 .TP
1029 .B SPEED
1030 The baud rate of the tty device.
1031 .TP
1032 .B ORIG_UID
1033 The real user-id of the user who invoked pppd.
1034 .P
1035 Pppd invokes the following scripts, if they exist.  It is not an error
1036 if they don't exist.
1037 .TP
1038 .B /etc/ppp/auth-up
1039 A program or script which is executed after the remote system
1040 successfully authenticates itself.  It is executed with the parameters
1041 .IP
1042 \fIinterface-name peer-name user-name tty-device speed\fR
1043 .IP
1044 Note that this script is not executed if the peer doesn't authenticate
1045 itself, for example when the \fInoauth\fR option is used.
1046 .TP
1047 .B /etc/ppp/auth-down
1048 A program or script which is executed when the link goes down, if
1049 /etc/ppp/auth-up was previously executed.  It is executed in the same
1050 manner with the same parameters as /etc/ppp/auth-up.
1051 .TP
1052 .B /etc/ppp/ip-up
1053 A program or script which is executed when the link is available for
1054 sending and receiving IP packets (that is, IPCP has come up).  It is
1055 executed with the parameters
1056 .IP
1057 \fIinterface-name tty-device speed local-IP-address
1058 remote-IP-address ipparam\fR
1059 .TP
1060 .B /etc/ppp/ip-down
1061 A program or script which is executed when the link is no longer
1062 available for sending and receiving IP packets.  This script can be
1063 used for undoing the effects of the /etc/ppp/ip-up script.  It is
1064 invoked in the same manner and with the same parameters as the ip-up
1065 script.
1066 .TP
1067 .B /etc/ppp/ipx-up
1068 A program or script which is executed when the link is available for
1069 sending and receiving IPX packets (that is, IPXCP has come up).  It is
1070 executed with the parameters
1071 .IP
1072 \fIinterface-name tty-device speed network-number local-IPX-node-address
1073 remote-IPX-node-address local-IPX-routing-protocol remote-IPX-routing-protocol
1074 local-IPX-router-name remote-IPX-router-name ipparam pppd-pid\fR 
1075 .IP
1076 The local-IPX-routing-protocol and remote-IPX-routing-protocol field
1077 may be one of the following:
1078 .IP
1079 NONE      to indicate that there is no routing protocol
1080 .br
1081 RIP       to indicate that RIP/SAP should be used
1082 .br
1083 NLSP      to indicate that Novell NLSP should be used
1084 .br
1085 RIP NLSP  to indicate that both RIP/SAP and NLSP should be used
1086 .TP
1087 .B /etc/ppp/ipx-down
1088 A program or script which is executed when the link is no longer
1089 available for sending and receiving IPX packets.  This script can be
1090 used for undoing the effects of the /etc/ppp/ipx-up script.  It is
1091 invoked in the same manner and with the same parameters as the ipx-up
1092 script.
1093 .SH FILES
1094 .TP
1095 .B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others)
1096 Process-ID for pppd process on ppp interface unit \fIn\fR.
1097 .TP
1098 .B /etc/ppp/pap-secrets
1099 Usernames, passwords and IP addresses for PAP authentication.  This
1100 file should be owned by root and not readable or writable by any other
1101 user.  Pppd will log a warning if this is not the case.
1102 .TP
1103 .B /etc/ppp/chap-secrets
1104 Names, secrets and IP addresses for CHAP authentication.  As for
1105 /etc/ppp/pap-secrets, this file should be owned by root and not
1106 readable or writable by any other user.  Pppd will log a warning if
1107 this is not the case.
1108 .TP
1109 .B /etc/ppp/options
1110 System default options for pppd, read before user default options or
1111 command-line options.
1112 .TP
1113 .B ~/.ppprc
1114 User default options, read before /etc/ppp/options.\fIttyname\fR.
1115 .TP
1116 .B /etc/ppp/options.\fIttyname
1117 System default options for the serial port being used, read after
1118 ~/.ppprc.  In forming the \fIttyname\fR part of this
1119 filename, an initial /dev/ is stripped from the port name (if
1120 present), and any slashes in the remaining part are converted to
1121 dots.
1122 .TP
1123 .B /etc/ppp/peers
1124 A directory containing options files which may contain privileged
1125 options, even if pppd was invoked by a user other than root.  The
1126 system administrator can create options files in this directory to
1127 permit non-privileged users to dial out without requiring the peer to
1128 authenticate, but only to certain trusted peers.
1129 .SH SEE ALSO
1130 .TP
1131 .B RFC1144
1132 Jacobson, V.
1133 \fICompressing TCP/IP headers for low-speed serial links.\fR
1134 February 1990.
1135 .TP
1136 .B RFC1321
1137 Rivest, R.
1138 .I The MD5 Message-Digest Algorithm.
1139 April 1992.
1140 .TP
1141 .B RFC1332
1142 McGregor, G.
1143 .I PPP Internet Protocol Control Protocol (IPCP).
1144 May 1992.
1145 .TP
1146 .B RFC1334
1147 Lloyd, B.; Simpson, W.A.
1148 .I PPP authentication protocols.
1149 October 1992.
1150 .TP
1151 .B RFC1661
1152 Simpson, W.A.
1153 .I The Point\-to\-Point Protocol (PPP).
1154 July 1994.
1155 .TP
1156 .B RFC1662
1157 Simpson, W.A.
1158 .I PPP in HDLC-like Framing.
1159 July 1994.
1160 .SH NOTES
1161 The following signals have the specified effect when sent to pppd.
1162 .TP
1163 .B SIGINT, SIGTERM
1164 These signals cause pppd to terminate the link (by closing LCP),
1165 restore the serial device settings, and exit.
1166 .TP
1167 .B SIGHUP
1168 This signal causes pppd to terminate the link, restore the serial
1169 device settings, and close the serial device.  If the \fIpersist\fR or
1170 \fIdemand\fR option has been specified, pppd will try to reopen the
1171 serial device and start another connection (after the holdoff period).
1172 Otherwise pppd will exit.  If this signal is received during the
1173 holdoff period, it causes pppd to end the holdoff period immediately.
1174 .TP
1175 .B SIGUSR1
1176 This signal toggles the state of the \fIdebug\fR option.
1177 .TP
1178 .B SIGUSR2
1179 This signal causes pppd to renegotiate compression.  This can be
1180 useful to re-enable compression after it has been disabled as a result
1181 of a fatal decompression error.  (Fatal decompression errors generally
1182 indicate a bug in one or other implementation.)
1183
1184 .SH AUTHORS
1185 Paul Mackerras (Paul.Mackerras@cs.anu.edu.au), based on earlier work by
1186 Drew Perkins,
1187 Brad Clements,
1188 Karl Fox,
1189 Greg Christy,
1190 and
1191 Brad Parker.