update for 2.3.3
[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
49 In each case you start by running the ./configure script.  This works
50 out which operating system you are using and creates symbolic links to
51 the appropriate makefiles.  You then run `make' to compile the
52 user-level code, and (as root) `make install' to install the
53 user-level programs pppd, chat and pppstats.
54
55 The procedures for installing the kernel code vary from system to
56 system.  On some systems, the kernel code can be loaded into a running
57 kernel using a `modload' facility.  On others, the kernel image has to
58 be recompiled and the system rebooted.  See the README.* files for
59 details.
60
61 N.B. Since 2.3.0, leaving the permitted IP addresses column of the
62 pap-secrets or chap-secrets file empty means that no addresses are
63 permitted.  You need to put a "*" in that column to allow the peer to
64 use any IP address.  (This only applies where the peer is
65 authenticating itself to you, of course.)
66
67
68 What's new in ppp-2.3.3.
69 ************************
70
71 * Fixed compilation problems under SunOS.
72
73 * Fixed a bug introduced into chat in 2.3.2, and compilation problems
74 introduced into the MS-CHAP implementation in 2.3.2.
75
76 * The linux kernel driver has been updated for recent 2.1-series
77 kernel changes, and it now will ask kerneld to load compression
78 modules when required, if the kernel is configured to support kerneld.
79
80 * Pppd should now compile correctly under linux on systems with glibc.
81
82
83 What was new in ppp-2.3.2.
84 **************************
85
86 * In 2.3.1, I made a change which was intended to make pppd able to
87 detect loss of CD during or immediately after the connection script
88 runs.  Unfortunately, this had the side-effect that the connection
89 script wouldn't work at all on some systems.  This change has been
90 reversed.
91
92 * Fix compilation problems in the Linux kernel driver.
93
94
95 What was new in ppp-2.3.1.
96 **************************
97
98 * Enhancements to chat, thanks to Francis Demierre.  Chat can now
99 accept comments in the chat script file, and has new SAY, HANGUP,
100 CLR_ABORT and CLR_REPORT keywords.
101
102 * Fixed a bug which causes 2.3.0 to crash Solaris systems.
103
104 * Bug-fixes and restructuring of the Linux kernel driver.
105
106 * The holdoff behaviour of pppd has been changed slightly: now, if
107 the link comes up for IP (or other network protocol) traffic, we
108 consider that the link has been successfully established, and don't
109 enforce the holdoff period after the link goes down.
110
111 * Pppd should now correctly wait for CD (carrier detect) from the
112 modem, even when the serial port initially had CLOCAL set, and it
113 should also detect loss of CD during or immediately after the
114 connection script runs.
115
116 * Under linux, pppd will work with older 2.2.0* version kernel
117 drivers, although demand-dialling is not supported with them.
118
119 * Minor bugfixes for pppd.
120
121
122 What was new in ppp-2.3.
123 ************************
124
125 * Demand-dialling.  Pppd now has a mode where it will establish the
126 network interface immediately when it starts, but not actually bring
127 the link up until it sees some data to be sent.  Look for the demand
128 option description in the pppd man page.  Demand-dialling is not
129 supported under Ultrix or NeXTStep.
130
131 * Idle timeout.  Pppd will optionally terminate the link if no data
132 packets are sent or received within a certain time interval.
133
134 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
135 peer successfully authenticates itself, and /etc/ppp/auth-down when
136 the connection is subsequently terminated.  This can be useful for
137 accounting purposes.
138
139 * A new packet compression scheme, Deflate, has been implemented.
140 This uses the same compression method as `gzip'.  This method is free
141 of patent or copyright restrictions, and it achieves better
142 compression than BSD-Compress.  It does consume more CPU cycles for
143 compression than BSD-Compress, but this shouldn't be a problem for
144 links running at 100kbit/s or less.
145
146 * There is no code in this distribution which is covered by Brad
147 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
148 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
149 were written from scratch without any Clements code.
150
151 * Pppstats has been reworked to clean up the output format somewhat.
152 It also has a new -d option which displays data rate in kbyte/s for
153 those columns which would normally display bytes.
154
155 * Pppd options beginning with - or + have been renamed, e.g. -ip
156 became noip, +chap became require-chap, etc.  The old options are
157 still accepted for compatibility but may be removed in future.
158
159 * Pppd now has some options (such as the new `noauth' option) which
160 can only be specified if it is being run by root, or in an
161 "privileged" options file: /etc/ppp/options or an options file in the
162 /etc/ppp/peers directory.  There is a new "call" option to read
163 options from a file in /etc/ppp/peers, making it possible for non-root
164 users to make unauthenticated connections, but only to certain trusted
165 peers.  My intention is to make the `auth' option the default in a
166 future release.
167
168 * Several minor new features have been added to pppd, including the
169 maxconnect and welcome options.  Pppd will now terminate the
170 connection when there are no network control protocols running.  The
171 allowed IP address(es) field in the secrets files can now specify
172 subnets (with a notation like 123.45.67.89/24) and addresses which are
173 not acceptable (put a ! on the front).
174
175 * Numerous bugs have been fixed (no doubt some have been introduced :-)
176 Thanks to those who reported bugs in ppp-2.2.
177
178
179 Patents.
180 ********
181
182 The BSD-Compress algorithm used for packet compression is the same as
183 that used in the Unix "compress" command.  It is apparently covered by
184 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
185 and corresponding patents in various other countries (but not
186 Australia).  If this is of concern, you can build the package without
187 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
188 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
189 longer needed, so the references to bsd-comp.o may optionally be
190 removed from the Makefiles.
191
192
193 Contacts.
194 *********
195
196 The comp.protocols.ppp newsgroup is a useful place to get help if you
197 have trouble getting your ppp connections to work.  Please do not send
198 me questions of the form "please help me get connected to my ISP" -
199 I'm sorry, but I simply do not have the time to answer all the
200 questions like this that I get.
201
202 If you find bugs in this package, please report them to the maintainer
203 for the port for the operating system you are using:
204
205 Digital Unix (OSF/1)    Farrell Woods <ftw@zk3.dec.com>
206 Linux                   Al Longyear <longyear@pobox.com>
207 NetBSD                  Matthew Green <mrg@eterna.com.au
208 FreeBSD                 Peter Wemm <peter@haywire.DIALix.COM>
209 NeXTStep                Steve Perkins <perkins@cps.msu.edu>
210 Solaris 2               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
211 SunOS 4.x               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
212 System V Release 4      Matthias Apitz <Matthias.Apitz@SOFTCON.de>
213 Ultrix 4.x              Paul Mackerras (for want of anybody better :-)
214
215
216 Copyrights:
217 ***********
218
219 All of the code can be freely used and redistributed.
220
221
222 Distribution:
223 *************
224
225 The primary site for releases of this software is:
226
227         ftp://cs.anu.edu.au/pub/software/ppp/
228
229
230 ($Id: README,v 1.11 1998/02/04 01:33:10 paulus Exp $)