add chap-ms stuff
[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
62 What's new in ppp-2.3.
63 **********************
64
65 * Demand-dialling.  Pppd now has a mode where it will establish the
66 network interface immediately when it starts, but not actually bring
67 the link up until it sees some data to be sent.  Look for the demand
68 option description in the pppd man page.  Demand-dialling is not
69 supported under Ultrix or NeXTStep.
70
71 * Idle timeout.  Pppd will optionally terminate the link if no data
72 packets are sent or received within a certain time interval.
73
74 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
75 peer successfully authenticates itself, and /etc/ppp/auth-down when
76 the connection is subsequently terminated.  This can be useful for
77 accounting purposes.
78
79 * A new packet compression scheme, Deflate, has been implemented.
80 This uses the same compression method as `gzip'.  This method is free
81 of patent or copyright restrictions, and it achieves better
82 compression than BSD-Compress.  It does consume more CPU cycles for
83 compression than BSD-Compress, but this shouldn't be a problem for
84 links running at 100kbit/s or less.
85
86 * There is no code in this distribution which is covered by Brad
87 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
88 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
89 were written from scratch without any Clements code.
90
91 * Pppstats has been reworked to clean up the output format somewhat.
92 It also has a new -d option which displays data rate in kbyte/s for
93 those columns which would normally display bytes.
94
95 * Pppd options beginning with - or + have been renamed, e.g. -ip
96 became noip, +chap became require-chap, etc.  The old options are
97 still accepted for compatibility but may be removed in future.
98
99 * Pppd now has some options (such as the new `noauth' option) which
100 can only be specified if it is being run by root, or in an
101 "privileged" options file: /etc/ppp/options or an options file in the
102 /etc/ppp/peers directory.  There is a new "call" option to read
103 options from a file in /etc/ppp/peers, making it possible for non-root
104 users to make unauthenticated connections, but only to certain trusted
105 peers.  My intention is to make the `auth' option the default in a
106 future release.
107
108 * Several minor new features have been added to pppd, including the
109 maxconnect and welcome options.  Pppd will now terminate the
110 connection when there are no network control protocols running.  The
111 allowed IP address(es) field in the secrets files can now specify
112 subnets (with a notation like 123.45.67.89/24) and addresses which are
113 not acceptable (put a ! on the front).
114
115 * Numerous bugs have been fixed (no doubt some have been introduced :-)
116 Thanks to those who reported bugs in ppp-2.2.
117
118
119 Patents.
120 ********
121
122 The BSD-Compress algorithm used for packet compression is the same as
123 that used in the Unix "compress" command.  It is apparently covered by
124 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
125 and corresponding patents in various other countries (but not
126 Australia).  If this is of concern, you can build the package without
127 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
128 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
129 longer needed, so the references to bsd-comp.o may optionally be
130 removed from the Makefiles.
131
132
133 Contacts.
134 *********
135
136 The comp.protocols.ppp newsgroup is a useful place to get help if you
137 have trouble getting your ppp connections to work.  Please do not send
138 me questions of the form "please help me get connected to my ISP" -
139 I'm sorry, but I simply do not have the time to answer all the
140 questions like this that I get.
141
142 If you find bugs in this package, please report them to the maintainer
143 for the port for the operating system you are using:
144
145 Digital Unix (OSF/1)    Farrell Woods <ftw@zk3.dec.com>
146 Linux                   Al Longyear <longyear@pobox.com>
147 NetBSD                  Matthew Green <mrg@eterna.com.au
148 FreeBSD                 Peter Wemm <peter@haywire.DIALix.COM>
149 NeXTStep                Steve Perkins <perkins@cps.msu.edu>
150 Solaris 2               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
151 SunOS 4.x               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
152 System V Release 4      Matthias Apitz <Matthias.Apitz@SOFTCON.de>
153 Ultrix 4.x              Paul Mackerras (for want of anybody better :-)
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.8 1997/05/22 06:43:44 paulus Exp $)