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.4.
  71 ************************
  72
  73 * The NeXT port has been updated, thanks to Steve Perkins.
  74
  75 * ppp-2.3.4 compiles and works under Solaris 2.6, using either gcc or
  76 cc.
  77
  78 * With the Solaris, SVR4 and SunOS ports, you can control the choice
  79 of C compiler, C compiler options, and installation directories by
  80 editing the svr4/Makedefs or sunos4/Makedefs file.
  81
  82 * Until now, we have been using the number 24 to identify Deflate
  83 compression in the CCP negotiations, which was the number in the draft
  84 RFC describing Deflate.  The number actually assigned to Deflate is
  85 26.  The code has been changed to use 26, but to allow the use of 24
  86 for now for backwards compatibility.  (This can be disabled with the
  87 `nodeflatedraft' option to pppd.)
  88
  89 * Fixed some bugs in the linux driver and deflate compressor which
  90 were causing compression problems, including corrupting long
  91 incompressible packets sometimes.
  92
  93 * Fixes to the PAM and shadow password support in pppd, from Al
  94 Longyear and others.
  95
  96 * Pppd now sets some environment variables for scripts it invokes
  97 (ip-up/down, auth-ip/down), giving information about the connection.
  98 The variables it sets are PEERNAME, IPLOCAL, IPREMOTE, UID, DEVICE,
  99 SPEED, and IFNAME.
 100
 101 * Pppd now has an `updetach' option, which will cause it to detach
 102 from its controlling terminal once the link has come up (i.e. once it
 103 is available for IP traffic).
 104
 105
 106 What was new in ppp-2.3.3.
 107 **************************
 108
 109 * Fixed compilation problems under SunOS.
 110
 111 * Fixed a bug introduced into chat in 2.3.2, and compilation problems
 112 introduced into the MS-CHAP implementation in 2.3.2.
 113
 114 * The linux kernel driver has been updated for recent 2.1-series
 115 kernel changes, and it now will ask kerneld to load compression
 116 modules when required, if the kernel is configured to support kerneld.
 117
 118 * Pppd should now compile correctly under linux on systems with glibc.
 119
 120
 121 What was new in ppp-2.3.2.
 122 **************************
 123
 124 * In 2.3.1, I made a change which was intended to make pppd able to
 125 detect loss of CD during or immediately after the connection script
 126 runs.  Unfortunately, this had the side-effect that the connection
 127 script wouldn't work at all on some systems.  This change has been
 128 reversed.
 129
 130 * Fix compilation problems in the Linux kernel driver.
 131
 132
 133 What was new in ppp-2.3.1.
 134 **************************
 135
 136 * Enhancements to chat, thanks to Francis Demierre.  Chat can now
 137 accept comments in the chat script file, and has new SAY, HANGUP,
 138 CLR_ABORT and CLR_REPORT keywords.
 139
 140 * Fixed a bug which causes 2.3.0 to crash Solaris systems.
 141
 142 * Bug-fixes and restructuring of the Linux kernel driver.
 143
 144 * The holdoff behaviour of pppd has been changed slightly: now, if
 145 the link comes up for IP (or other network protocol) traffic, we
 146 consider that the link has been successfully established, and don't
 147 enforce the holdoff period after the link goes down.
 148
 149 * Pppd should now correctly wait for CD (carrier detect) from the
 150 modem, even when the serial port initially had CLOCAL set, and it
 151 should also detect loss of CD during or immediately after the
 152 connection script runs.
 153
 154 * Under linux, pppd will work with older 2.2.0* version kernel
 155 drivers, although demand-dialling is not supported with them.
 156
 157 * Minor bugfixes for pppd.
 158
 159
 160 What was new in ppp-2.3.
 161 ************************
 162
 163 * Demand-dialling.  Pppd now has a mode where it will establish the
 164 network interface immediately when it starts, but not actually bring
 165 the link up until it sees some data to be sent.  Look for the demand
 166 option description in the pppd man page.  Demand-dialling is not
 167 supported under Ultrix or NeXTStep.
 168
 169 * Idle timeout.  Pppd will optionally terminate the link if no data
 170 packets are sent or received within a certain time interval.
 171
 172 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
 173 peer successfully authenticates itself, and /etc/ppp/auth-down when
 174 the connection is subsequently terminated.  This can be useful for
 175 accounting purposes.
 176
 177 * A new packet compression scheme, Deflate, has been implemented.
 178 This uses the same compression method as `gzip'.  This method is free
 179 of patent or copyright restrictions, and it achieves better
 180 compression than BSD-Compress.  It does consume more CPU cycles for
 181 compression than BSD-Compress, but this shouldn't be a problem for
 182 links running at 100kbit/s or less.
 183
 184 * There is no code in this distribution which is covered by Brad
 185 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
 186 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
 187 were written from scratch without any Clements code.
 188
 189 * Pppstats has been reworked to clean up the output format somewhat.
 190 It also has a new -d option which displays data rate in kbyte/s for
 191 those columns which would normally display bytes.
 192
 193 * Pppd options beginning with - or + have been renamed, e.g. -ip
 194 became noip, +chap became require-chap, etc.  The old options are
 195 still accepted for compatibility but may be removed in future.
 196
 197 * Pppd now has some options (such as the new `noauth' option) which
 198 can only be specified if it is being run by root, or in an
 199 "privileged" options file: /etc/ppp/options or an options file in the
 200 /etc/ppp/peers directory.  There is a new "call" option to read
 201 options from a file in /etc/ppp/peers, making it possible for non-root
 202 users to make unauthenticated connections, but only to certain trusted
 203 peers.  My intention is to make the `auth' option the default in a
 204 future release.
 205
 206 * Several minor new features have been added to pppd, including the
 207 maxconnect and welcome options.  Pppd will now terminate the
 208 connection when there are no network control protocols running.  The
 209 allowed IP address(es) field in the secrets files can now specify
 210 subnets (with a notation like 123.45.67.89/24) and addresses which are
 211 not acceptable (put a ! on the front).
 212
 213 * Numerous bugs have been fixed (no doubt some have been introduced :-)
 214 Thanks to those who reported bugs in ppp-2.2.
 215
 216
 217 Patents.
 218 ********
 219
 220 The BSD-Compress algorithm used for packet compression is the same as
 221 that used in the Unix "compress" command.  It is apparently covered by
 222 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
 223 and corresponding patents in various other countries (but not
 224 Australia).  If this is of concern, you can build the package without
 225 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
 226 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
 227 longer needed, so the references to bsd-comp.o may optionally be
 228 removed from the Makefiles.
 229
 230
 231 Contacts.
 232 *********
 233
 234 The comp.protocols.ppp newsgroup is a useful place to get help if you
 235 have trouble getting your ppp connections to work.  Please do not send
 236 me questions of the form "please help me get connected to my ISP" -
 237 I'm sorry, but I simply do not have the time to answer all the
 238 questions like this that I get.
 239
 240 If you find bugs in this package, please report them to the maintainer
 241 for the port for the operating system you are using:
 242
 243 Digital Unix (OSF/1)    Farrell Woods <ftw@zk3.dec.com>
 244 Linux                   Al Longyear <longyear@pobox.com>
 245 NetBSD                  Matthew Green <mrg@eterna.com.au
 246 FreeBSD                 Peter Wemm <peter@haywire.DIALix.COM>
 247 NeXTStep                Steve Perkins <perkins@cps.msu.edu>
 248 Solaris 2               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
 249 SunOS 4.x               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
 250 System V Release 4      Matthias Apitz <Matthias.Apitz@SOFTCON.de>
 251 Ultrix 4.x              Paul Mackerras (for want of anybody better :-)
 252
 253
 254 Copyrights:
 255 ***********
 256
 257 All of the code can be freely used and redistributed.
 258
 259
 260 Distribution:
 261 *************
 262
 263 The primary site for releases of this software is:
 264
 265         ftp://cs.anu.edu.au/pub/software/ppp/
 266
 267
 268 ($Id: README,v 1.12 1998/03/31 04:31:33 paulus Exp $)