release/src/router/rp-pppoe/README

   1 # LIC: GPL
   2
   3 pppoe: a PPP-over-Ethernet redirector for pppd
   4 Copyright (C) 2001-2005 Roaring Penguin Software Inc.
   5
   6 Some inspiration from an earlier client by Luke Stras.
   7
   8 The MSS clamping was inspired by mssclampfw by Marc Boucher <marc@mbsi.ca>
   9 with acknowledgements to Rebel.com (http://www.rebel.com).  However, the
  10 actual MSS clamping code is original and is licensed under the GPL, unlike
  11 the original mssclampfw.
  12
  13 Introduction
  14 ============
  15
  16 pppoe is a user-space redirector which permits the use of PPPoE
  17 (Point-to-Point Over Ethernet) with Linux.  PPPoE is used by many
  18 DSL service providers.
  19
  20 Installation
  21 ============
  22
  23 Requirements
  24 ------------
  25
  26 1) Linux 2.2.9 or later on Intel, Sparc or PowerPC.  It may work on
  27    Alpha, too -- anyone care to let me know?
  28
  29            OR
  30
  31    Linux 2.0.36 or later.
  32
  33            OR
  34
  35    FreeBSD, NetBSD or OpenBSD with BPF support.  I have access only
  36    to FreeBSD.  In general, I can't answer questions about the *BSD's
  37    as well as I can about Linux.
  38
  39
  40 2) pppd 2.3.10 or later.  Versions 2.3.7 and later work unless you use
  41    demand-dialling.  For demand dialling, you *must* use 2.3.10 or later.
  42
  43 QUICKSTART
  44 ----------
  45
  46 If you're lucky, the "quickstart" method will work.  After unpacking
  47 the archive, become root and type:
  48
  49         ./go
  50
  51 This should configure, compile and install the software and set up your
  52 DSL connection.  You'll have to answer a few questions along the way.
  53
  54 If you want the GUI wrapper, type:
  55
  56         ./go-gui
  57
  58 If ./go and ./go-gui didn't work, read the rest of this README.
  59
  60 Compiling
  61 ---------
  62
  63 Compile and install pppd if you don't already have it.  Then:
  64
  65 1) Unpack:
  66
  67         $ tar xzvf rp-pppoe-xxx.tar.gz
  68
  69 2) Change to source directory:
  70
  71         $ cd src
  72
  73 3) Configure:
  74
  75         $ ./configure
  76
  77 4) Compile:
  78
  79         $ make
  80
  81 4) Install (this step must be done as root)
  82
  83         # make install
  84
  85 5) Now read doc/HOW-TO-CONNECT
  86
  87 --
  88 David F. Skoll <dfs@roaringpenguin.com> | Roaring Penguin Software Inc.
  89 http://www.roaringpenguin.com