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