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