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