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