don't die on EIO on setting asyncmap
[ppp.git] / README
1 This is the README file for ppp-2.3, a package which implements the
2 Point-to-Point Protocol (PPP) to provide Internet connections over
3 serial lines.
4
5
6 Introduction.
7 *************
8
9 The Point-to-Point Protocol (PPP) provides a standard way to establish
10 a network connection over a serial link.  At present, this package
11 supports IP and the protocols layered above IP, such as TCP and UDP.
12 The Linux port of this package also has support for IPX.
13
14 This software consists of two parts:
15
16 - Kernel code, which establishes a network interface and passes
17 packets between the serial port, the kernel networking code and the
18 PPP daemon (pppd).  This code is implemented using STREAMS modules on
19 SunOS 4.x, Solaris 2.x, System V Release 4, and OSF/1, and as a
20 line discipline under Ultrix, NextStep, NetBSD, FreeBSD, and Linux.
21
22 - The PPP daemon (pppd), which negotiates with the peer to establish
23 the link and sets up the ppp network interface.  Pppd includes support
24 for authentication, so you can control which other systems may make a
25 PPP connection and what IP addresses they may use.
26
27
28 Installation.
29 *************
30
31 The file SETUP contains general information about setting up your
32 system for using PPP.  There is also a README file for each supported
33 system, which contains more specific details for installing PPP on
34 that system.  The supported systems, and the corresponding README
35 files, are:
36
37         Digital Unix (OSF/1)            README.osf
38         Linux                           README.linux
39         NetBSD, FreeBSD                 README.bsd
40         NeXTStep                        README.next
41         Solaris 2                       README.sol2
42         SunOS 4.x                       README.sunos4
43         System V Release 4              README.svr4
44         Ultrix 4.x                      README.ultrix
45
46 Unfortunately, AIX 4 is no longer supported, since I don't have a
47 maintainer for the AIX 4 port.  If you want to volunteer, contact me.
48 The Ultrix port is untested, as I no longer have access to an Ultrix
49 box.
50
51 In each case you start by running the ./configure script.  This works
52 out which operating system you are using and creates symbolic links to
53 the appropriate makefiles.  You then run `make' to compile the
54 user-level code, and (as root) `make install' to install the
55 user-level programs pppd, chat and pppstats.
56
57 The procedures for installing the kernel code vary from system to
58 system.  On some systems, the kernel code can be loaded into a running
59 kernel using a `modload' facility.  On others, the kernel image has to
60 be recompiled and the system rebooted.  See the README.* files for
61 details.
62
63 N.B. Since 2.3.0, leaving the permitted IP addresses column of the
64 pap-secrets or chap-secrets file empty means that no addresses are
65 permitted.  You need to put a "*" in that column to allow the peer to
66 use any IP address.  (This only applies where the peer is
67 authenticating itself to you, of course.)
68
69
70 What's new in ppp-2.3.6.
71 ************************
72
73 * Pppd now opens the tty device as the user (rather than as root) if
74   the device name was given by the user, i.e. on the command line or
75   in the ~/.ppprc file.  If the device name was given in
76   /etc/ppp/options or in a file loaded with the `call' option, the
77   device is opened as root.
78
79 * The default behaviour of pppd is now to let a peer which has not
80   authenticated itself (e.g. your ISP) use any IP address to which the
81   system does not already have a route.  (This is currently only
82   supported under Linux, Solaris and Digital Unix; on the other
83   systems, the peer must now authenticate itself unless the noauth
84   option is used.)
85
86 * Added new option `usepeerdns', thanks to Nick Walker
87   <nickwalker@email.com>.  If the peer supplies DNS addresses, these
88   will be written to /etc/ppp/resolv.conf.  The ip-up script can then
89   be used to add these addresses to /etc/resolv.conf if desired (see
90   the ip-up.local.add and ip-down.local.add files in the scripts
91   directory).
92
93 * The Solaris ppp driver should now work correctly on SMP systems.
94
95 * Minor corrections so that the code can compile under Solaris 7,
96   and under Linux with glibc-2.1.
97
98 * The Linux kernel driver has been restructured for improved
99   performance.
100
101 * Pppd now won't start the ip-down script until the ip-up script has
102   finished.
103
104
105 What was new in ppp-2.3.5.
106 **************************
107
108 * Minor corrections to the Digital UNIX and NetBSD ports.
109
110 * A workaround to avoid tickling a bug in the `se' serial port driver
111 on Sun PCI Ultra machines running Solaris.
112
113 * Fixed a bug in the negotiation of the Microsoft WINS server address
114 option.
115
116 * Fixed a bug in the Linux port where it would fail for kernel
117 versions above 2.1.99.
118
119
120 What was new in ppp-2.3.4.
121 **************************
122
123 * The NeXT port has been updated, thanks to Steve Perkins.
124
125 * ppp-2.3.4 compiles and works under Solaris 2.6, using either gcc or
126 cc.
127
128 * With the Solaris, SVR4 and SunOS ports, you can control the choice
129 of C compiler, C compiler options, and installation directories by
130 editing the svr4/Makedefs or sunos4/Makedefs file.
131
132 * Until now, we have been using the number 24 to identify Deflate
133 compression in the CCP negotiations, which was the number in the draft
134 RFC describing Deflate.  The number actually assigned to Deflate is
135 26.  The code has been changed to use 26, but to allow the use of 24
136 for now for backwards compatibility.  (This can be disabled with the
137 `nodeflatedraft' option to pppd.)
138
139 * Fixed some bugs in the linux driver and deflate compressor which
140 were causing compression problems, including corrupting long
141 incompressible packets sometimes.
142
143 * Fixes to the PAM and shadow password support in pppd, from Al
144 Longyear and others.
145
146 * Pppd now sets some environment variables for scripts it invokes
147 (ip-up/down, auth-ip/down), giving information about the connection.
148 The variables it sets are PEERNAME, IPLOCAL, IPREMOTE, UID, DEVICE,
149 SPEED, and IFNAME.
150
151 * Pppd now has an `updetach' option, which will cause it to detach
152 from its controlling terminal once the link has come up (i.e. once it
153 is available for IP traffic).
154
155
156 What was new in ppp-2.3.3.
157 **************************
158
159 * Fixed compilation problems under SunOS.
160
161 * Fixed a bug introduced into chat in 2.3.2, and compilation problems
162 introduced into the MS-CHAP implementation in 2.3.2.
163
164 * The linux kernel driver has been updated for recent 2.1-series
165 kernel changes, and it now will ask kerneld to load compression
166 modules when required, if the kernel is configured to support kerneld.
167
168 * Pppd should now compile correctly under linux on systems with glibc.
169
170
171 What was new in ppp-2.3.2.
172 **************************
173
174 * In 2.3.1, I made a change which was intended to make pppd able to
175 detect loss of CD during or immediately after the connection script
176 runs.  Unfortunately, this had the side-effect that the connection
177 script wouldn't work at all on some systems.  This change has been
178 reversed.
179
180 * Fix compilation problems in the Linux kernel driver.
181
182
183 What was new in ppp-2.3.1.
184 **************************
185
186 * Enhancements to chat, thanks to Francis Demierre.  Chat can now
187 accept comments in the chat script file, and has new SAY, HANGUP,
188 CLR_ABORT and CLR_REPORT keywords.
189
190 * Fixed a bug which causes 2.3.0 to crash Solaris systems.
191
192 * Bug-fixes and restructuring of the Linux kernel driver.
193
194 * The holdoff behaviour of pppd has been changed slightly: now, if
195 the link comes up for IP (or other network protocol) traffic, we
196 consider that the link has been successfully established, and don't
197 enforce the holdoff period after the link goes down.
198
199 * Pppd should now correctly wait for CD (carrier detect) from the
200 modem, even when the serial port initially had CLOCAL set, and it
201 should also detect loss of CD during or immediately after the
202 connection script runs.
203
204 * Under linux, pppd will work with older 2.2.0* version kernel
205 drivers, although demand-dialling is not supported with them.
206
207 * Minor bugfixes for pppd.
208
209
210 What was new in ppp-2.3.
211 ************************
212
213 * Demand-dialling.  Pppd now has a mode where it will establish the
214 network interface immediately when it starts, but not actually bring
215 the link up until it sees some data to be sent.  Look for the demand
216 option description in the pppd man page.  Demand-dialling is not
217 supported under Ultrix or NeXTStep.
218
219 * Idle timeout.  Pppd will optionally terminate the link if no data
220 packets are sent or received within a certain time interval.
221
222 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
223 peer successfully authenticates itself, and /etc/ppp/auth-down when
224 the connection is subsequently terminated.  This can be useful for
225 accounting purposes.
226
227 * A new packet compression scheme, Deflate, has been implemented.
228 This uses the same compression method as `gzip'.  This method is free
229 of patent or copyright restrictions, and it achieves better
230 compression than BSD-Compress.  It does consume more CPU cycles for
231 compression than BSD-Compress, but this shouldn't be a problem for
232 links running at 100kbit/s or less.
233
234 * There is no code in this distribution which is covered by Brad
235 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
236 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
237 were written from scratch without any Clements code.
238
239 * Pppstats has been reworked to clean up the output format somewhat.
240 It also has a new -d option which displays data rate in kbyte/s for
241 those columns which would normally display bytes.
242
243 * Pppd options beginning with - or + have been renamed, e.g. -ip
244 became noip, +chap became require-chap, etc.  The old options are
245 still accepted for compatibility but may be removed in future.
246
247 * Pppd now has some options (such as the new `noauth' option) which
248 can only be specified if it is being run by root, or in an
249 "privileged" options file: /etc/ppp/options or an options file in the
250 /etc/ppp/peers directory.  There is a new "call" option to read
251 options from a file in /etc/ppp/peers, making it possible for non-root
252 users to make unauthenticated connections, but only to certain trusted
253 peers.  My intention is to make the `auth' option the default in a
254 future release.
255
256 * Several minor new features have been added to pppd, including the
257 maxconnect and welcome options.  Pppd will now terminate the
258 connection when there are no network control protocols running.  The
259 allowed IP address(es) field in the secrets files can now specify
260 subnets (with a notation like 123.45.67.89/24) and addresses which are
261 not acceptable (put a ! on the front).
262
263 * Numerous bugs have been fixed (no doubt some have been introduced :-)
264 Thanks to those who reported bugs in ppp-2.2.
265
266
267 Patents.
268 ********
269
270 The BSD-Compress algorithm used for packet compression is the same as
271 that used in the Unix "compress" command.  It is apparently covered by
272 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
273 and corresponding patents in various other countries (but not
274 Australia).  If this is of concern, you can build the package without
275 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
276 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
277 longer needed, so the references to bsd-comp.o may optionally be
278 removed from the Makefiles.
279
280
281 Contacts.
282 *********
283
284 The comp.protocols.ppp newsgroup is a useful place to get help if you
285 have trouble getting your ppp connections to work.  Please do not send
286 me questions of the form "please help me get connected to my ISP" -
287 I'm sorry, but I simply do not have the time to answer all the
288 questions like this that I get.
289
290 If you find bugs in this package, please report them to the maintainer
291 for the port for the operating system you are using:
292
293 Digital Unix (OSF/1)    Sowmini Varadhan <varadhan@zk3.dec.com>
294 Linux                   Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
295 NetBSD                  Matthew Green <mrg@eterna.com.au>
296 FreeBSD                 Peter Wemm <peter@haywire.DIALix.COM>
297 NeXTStep                Steve Perkins <perkins@cps.msu.edu>
298 Solaris 2               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
299 SunOS 4.x               Paul Mackerras (for want of anybody better :-)
300 System V Release 4      Matthias Apitz <Matthias.Apitz@SOFTCON.de>
301 Ultrix 4.x              Paul Mackerras (for want of anybody better :-)
302
303
304 Copyrights:
305 ***********
306
307 All of the code can be freely used and redistributed.
308
309
310 Distribution:
311 *************
312
313 The primary site for releases of this software is:
314
315         ftp://cs.anu.edu.au/pub/software/ppp/
316
317
318 ($Id: README,v 1.15 1999/03/10 05:10:47 paulus Exp $)