README
1# LIC: GPL
2
3pppoe: a PPP-over-Ethernet redirector for pppd
4Copyright (C) 2001-2012 Roaring Penguin Software Inc.
5
6Some inspiration from an earlier client by Luke Stras.
7
8The MSS clamping was inspired by mssclampfw by Marc Boucher <marc@mbsi.ca>
9with acknowledgements to Rebel.com (http://www.rebel.com). However, the
10actual MSS clamping code is original and is licensed under the GPL, unlike
11the original mssclampfw.
12
13Introduction
14============
15
16pppoe is a user-space redirector which permits the use of PPPoE
17(Point-to-Point Over Ethernet) with Linux. PPPoE is used by many
18DSL service providers.
19
20Installation
21============
22
23Requirements
24------------
25
261) 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
392) 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
42QUICKSTART
43----------
44
45If you're lucky, the "quickstart" method will work. After unpacking
46the archive, become root and type:
47
48 ./go
49
50This should configure, compile and install the software and set up your
51DSL connection. You'll have to answer a few questions along the way.
52
53If you want the GUI wrapper, type:
54
55 ./go-gui
56
57If ./go and ./go-gui didn't work, read the rest of this README.
58
59Compiling
60---------
61
62Compile and install pppd if you don't already have it. Then:
63
641) Unpack:
65
66 $ tar xzvf rp-pppoe-xxx.tar.gz
67
682) Change to source directory:
69
70 $ cd src
71
723) Configure:
73
74 $ ./configure
75
764) Compile:
77
78 $ make
79
804) Install (this step must be done as root)
81
82 # make install
83
845) Now read doc/HOW-TO-CONNECT
85
86--
87David F. Skoll <dfs@roaringpenguin.com> | Roaring Penguin Software Inc.
88http://www.roaringpenguin.com
89