8dd7db04d4534acaf215ab38a517eac4ef691206
[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 In this first beta release, the ports for SunOS, Solaris, NetBSD and
6 Digital Unix (OSF/1) are believed to be working correctly.  The Linux
7 port mostly works, but still has some known bugs.  The remaining ports
8 haven't been tested extensively.  The NeXTStep port is not included
9 here since it hasn't been updated from 2.2 yet.  For information on
10 its current status, see http://www.thoughtport.com:8080/PPP/.
11
12
13 Introduction.
14 *************
15
16 The Point-to-Point Protocol (PPP) provides a standard way to establish
17 a network connection over a serial link.  At present, this package
18 supports IP and the protocols layered above IP, such as TCP and UDP.
19 The Linux port of this package also supports IPX.
20
21 This software consists of two parts:
22
23 - Kernel code, which establishes a network interface and passes
24 packets between the serial port, the kernel networking code and the
25 PPP daemon (pppd).  This code is implemented using STREAMS modules on
26 SunOS 4.x, Solaris 2.x, System V Release 4, and OSF/1, and as a
27 line discipline under Ultrix, NextStep, NetBSD, FreeBSD, and Linux.
28
29 - The PPP daemon (pppd), which negotiates with the peer to establish
30 the link and sets up the ppp network interface.  Pppd includes support
31 for authentication, so you can control which other systems may make a
32 PPP connection and what IP addresses they may use.
33
34
35 Installation.
36 *************
37
38 The file SETUP contains general information about setting up your
39 system for using PPP.  There is also a README file for each supported
40 system, which contains more specific details for installing PPP on
41 that system.  The supported systems, and the corresponding README
42 files, are:
43
44         Digital Unix (OSF/1)            README.osf
45         Linux                           README.linux
46         NetBSD, FreeBSD                 README.bsd
47         NeXTStep                        README.next
48         Solaris 2                       README.sol2
49         SunOS 4.x                       README.sunos4
50         System V Release 4              README.svr4
51         Ultrix 4.x                      README.ultrix
52
53 In each case you start by running the ./configure script.  This works
54 out which operating system you are using and creates symbolic links to
55 the appropriate makefiles.  You then run `make' to compile the
56 user-level code, and (as root) `make install' to install the
57 user-level programs pppd, chat and pppstats.
58
59 The procedures for installing the kernel code vary from system to
60 system.  On some systems, the kernel code can be loaded into a running
61 kernel using a `modload' facility.  On others, the kernel image has to
62 be recompiled and the system rebooted.  See the README.* files for
63 details.
64
65 (Unfortunately, AIX 4 is no longer supported, since I don't have a
66 maintainer for the AIX 4 port.  If you want to volunteer, contact me.)
67
68
69 What's new in ppp-2.3.
70 **********************
71
72 * Demand-dialling.  Pppd now has a mode where it will establish the
73 network interface immediately when it starts, but not actually bring
74 the link up until it sees some data to be sent.
75
76 * Idle timeout.  Pppd will optionally terminate the link if no data
77 packets are sent or received within a certain time interval.
78
79 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
80 peer successfully authenticates itself, and /etc/ppp/auth-down when
81 the connection is subsequently terminated.
82
83 * A new packet compression scheme, Deflate, has been implemented.
84 This uses the same compression method as `gzip'.  This method is free
85 of patent or copyright restrictions, and it achieves better
86 compression than BSD-Compress.  It does consume more CPU cycles for
87 compression than BSD-Compress, but this won't be a problem for links
88 running at 100kbit/s or less.
89
90 * There is now no code in this distribution which is covered by Brad
91 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
92 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
93 were written from scratch without any Clements code.
94
95 * Pppstats has been reworked to clean up the output format somewhat.
96 It also has a new -d option which displays data rate in kbyte/s for
97 those columns which would normally display bytes.
98
99 * Pppd options beginning with - or + have been renamed, e.g. -ip
100 became noip, +chap became require-chap, etc.  The old options are
101 still accepted for compatibility but may be removed in future.
102
103 * Several minor new features have been added to pppd, including the
104 maxconnect and welcome options.  Pppd will now terminate the
105 connection when there are no network control protocols running.  The
106 allowed IP address(es) field in the secrets files can now specify
107 subnets (with a notation like 123.45.67.89/24) and addresses which are
108 not acceptable (put a ! on the front).
109
110 * Numerous bugs have been fixed (no doubt some have been introduced :-)
111 Thanks to those who reported bugs in ppp-2.2.
112
113
114 Patents.
115 ********
116
117 The BSD-Compress algorithm used for packet compression is the same as
118 that used in the Unix "compress" command.  It is apparently covered by
119 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
120 and corresponding patents in various other countries (but not
121 Australia).  If this is of concern, you can build the package without
122 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
123 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
124 longer needed, so the references to bsd-comp.o may optionally be
125 removed from the Makefiles.
126
127
128 Contacts.
129 *********
130
131 Bugs in the the SunOS, Solaris 2, NetBSD and Ultrix ports, and bugs in
132 pppd, chat or pppstats should be reported me at:
133
134         email:  Paul.Mackerras@cs.anu.edu.au
135
136         mail:   Dr Paul Mackerras
137                 Dept. of Computer Science
138                 Australian National University
139                 Canberra  ACT  0200
140                 AUSTRALIA
141
142         fax:    +61-6-249-0010
143
144 Bugs in other ports should be reported to the maintainer for that port
145 (see the appropriate README.* file) or to me.
146
147 Thanks to:
148
149         Brad Parker  (brad@fcr.com)
150         Greg Christy (gmc@quotron.com)
151         Drew D. Perkins (ddp@andrew.cmu.edu)
152         Rick Adams (rick@seismo.ARPA)
153         Chris Torek (chris@mimsy.umd.edu, umcp-cs!chris).
154
155
156 Copyrights:
157 ***********
158
159 All of the code can be freely used and redistributed.
160
161
162 Distribution:
163 *************
164
165 The primary site for releases of this software is:
166
167         ftp://cs.anu.edu.au/pub/software/ppp/
168
169
170 ($Id: README,v 1.6 1996/07/03 06:47:29 paulus Exp $)