release/src/router/rp-pppoe/README

   1 # LIC: GPL
   2
   3 pppoe: a PPP-over-Ethernet redirector for pppd
   4 Copyright (C) 2001-2012 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, though this is old,
  36    unmaintained, and may no longer work.
  37
  38
  39 2) pppd 2.3.10 or later.  Versions 2.3.7 and later work unless you use
  40    demand-dialling.  For demand dialling, you *must* use 2.3.10 or later.
  41
  42 QUICKSTART
  43 ----------
  44
  45 If you're lucky, the "quickstart" method will work.  After unpacking
  46 the archive, become root and type:
  47
  48         ./go
  49
  50 This should configure, compile and install the software and set up your
  51 DSL connection.  You'll have to answer a few questions along the way.
  52
  53 If you want the GUI wrapper, type:
  54
  55         ./go-gui
  56
  57 If ./go and ./go-gui didn't work, read the rest of this README.
  58
  59 Compiling
  60 ---------
  61
  62 Compile and install pppd if you don't already have it.  Then:
  63
  64 1) Unpack:
  65
  66         $ tar xzvf rp-pppoe-xxx.tar.gz
  67
  68 2) Change to source directory:
  69
  70         $ cd src
  71
  72 3) Configure:
  73
  74         $ ./configure
  75
  76 4) Compile:
  77
  78         $ make
  79
  80 4) Install (this step must be done as root)
  81
  82         # make install
  83
  84 5) Now read doc/HOW-TO-CONNECT
  85
  86 --
  87 David F. Skoll <dfs@roaringpenguin.com> | Roaring Penguin Software Inc.
  88 http://www.roaringpenguin.com