source: connect/other/pppoe.xml@ f26d6050

10.0 10.1 11.0 11.1 11.2 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn lazarus nosym perl-modules plabs/python-mods qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since f26d6050 was f26d6050, checked in by Igor Živković <igor@…>, 18 years ago

Added a test suite note to RP-PPPoE.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3639 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 10.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY pppoe-download-http "http://www.roaringpenguin.com/penguin/pppoe/rp-pppoe-&pppoe-version;.tar.gz">
8 <!ENTITY pppoe-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/rp-pppoe-&pppoe-version;.tar.gz">
9 <!ENTITY pppoe-md5sum "97972f8f8f6a3ab9b7070333a6a29c4b">
10 <!ENTITY pppoe-size "185 KB">
11 <!ENTITY pppoe-buildsize "2.2 MB">
12 <!ENTITY pppoe-time "0.05 SBU">
13]>
14
15<sect1 id="pppoe" xreflabel="RP-PPPoE-&pppoe-version;">
16<sect1info>
17<othername>$LastChangedBy$</othername>
18<date>$Date$</date>
19</sect1info>
20<?dbhtml filename="pppoe.html"?>
21<title>RP-PPPoE-&pppoe-version;</title>
22<indexterm zone="pppoe">
23<primary sortas="a-RP-PPPoE">RP-PPPoE</primary></indexterm>
24
25<sect2>
26<title>Introduction to
27<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
28
29<para>The Roaring Penguin <application><acronym>PPPoE</acronym></application>
30package contains both a client and a server component that works with the
31client. The client allows you to connect to large networks that use the
32<acronym>PPPoE</acronym> protocol, common among <acronym>ADSL</acronym>
33providers. The server component runs alongside the client,
34allowing you to configure other clients that send out a configuration
35request.</para>
36
37<sect3><title>Package information</title>
38<itemizedlist spacing='compact'>
39<listitem><para>Download (HTTP): <ulink
40url="&pppoe-download-http;"/></para></listitem>
41<listitem><para>Download (FTP): <ulink
42url="&pppoe-download-ftp;"/></para></listitem>
43<listitem><para>Download MD5 sum: &pppoe-md5sum;</para></listitem>
44<listitem><para>Download size: &pppoe-size;</para></listitem>
45<listitem><para>Estimated disk space required:
46&pppoe-buildsize;</para></listitem>
47<listitem><para>Estimated build time:
48&pppoe-time;</para></listitem></itemizedlist>
49</sect3>
50
51<sect3><title>
52<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
53dependencies</title>
54<sect4><title>Required</title>
55<para><xref linkend="ppp"/> and
56<xref linkend="net-tools"/> (you may omit
57<application>Net-tools</application> by using the following patch to
58utilize <application><acronym>IP</acronym>Route2</application>: <ulink
59url="&patch-root;/rp-pppoe-&pppoe-version;-iproute2-1.patch"/>)</para>
60</sect4>
61</sect3>
62
63</sect2>
64
65<sect2 id="pppoe-kernel">
66<title>Installation of
67<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
68</title>
69
70<note><para>If you plan on using kernel-mode <acronym>PPPoE</acronym>,
71this package is no longer explicitly needed, however, it is recomended
72for ease of configuration. Additional information about kernel mode
73<acronym>PPPoE</acronym> can be found in
74<filename>rp-pppoe-&pppoe-version;/doc/KERNEL-MODE-PPPOE</filename>.</para></note>
75<indexterm zone="pppoe pppoe-kernel">
76<primary sortas="d-Kernel-mode-PPPoE">Kernel-mode PPPoE</primary></indexterm>
77
78<para>Install
79<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> by
80running the following commands:</para>
81
82<screen><userinput><command>cd src &amp;&amp;
83./configure &amp;&amp;
84make</command></userinput></screen>
85
86<para>This package does not come with a test suite.</para>
87
88<para>Now, as the root user:</para>
89
90<screen><userinput role='root'><command>make install</command></userinput></screen>
91
92</sect2>
93
94<sect2>
95<title>Command explanations</title>
96
97<para>These are the standard installation commands that will install into
98the <filename>/usr</filename> prefix. You can optionally use the
99<command>go</command> script in the root of the source tree, to
100run the same commands, which are then immediately followed by the
101<command>adsl-setup</command> script.</para>
102
103</sect2>
104
105<sect2>
106<title>Configuring
107<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
108</title>
109
110<sect3 id="pppoe-config"><title>Config files</title>
111<para><filename>/etc/ppp/pppoe.conf</filename>,
112<filename>/etc/ppp/firewall-standalone</filename>,
113<filename>/etc/ppp/firewall-masq</filename>,
114<filename>/etc/ppp/pppoe-server-options</filename>,
115<filename>/etc/resolv.conf</filename>,
116<filename>/etc/ppp/pap-secrets</filename>,
117<filename>/etc/ppp/chap-secrets</filename></para>
118<indexterm zone="pppoe pppoe-config"><primary
119sortas="e-etc-ppp-pppoe.conf">/etc/ppp/pppoe.conf</primary>
120</indexterm>
121<indexterm zone="pppoe pppoe-config"><primary
122sortas="e-etc-ppp-firewall-standalone">/etc/ppp/firewall-standalone</primary>
123</indexterm>
124<indexterm zone="pppoe pppoe-config"><primary
125sortas="e-etc-ppp-firewall-masq">/etc/ppp/firewall-masq</primary>
126</indexterm>
127<indexterm zone="pppoe pppoe-config"><primary
128sortas="e-etc-ppp-pppoe-server-options">/etc/ppp/pppoe-server-options</primary>
129</indexterm>
130<indexterm zone="pppoe pppoe-config"><primary
131sortas="e-etc-resolv.conf">/etc/resolv.conf</primary>
132</indexterm>
133<indexterm zone="pppoe pppoe-config"><primary
134sortas="e-etc-ppp-pap-secrets">/etc/ppp/pap-secrets</primary>
135</indexterm>
136<indexterm zone="pppoe pppoe-config"><primary
137sortas="e-etc-ppp-chap-secrets">/etc/ppp/chap-secrets</primary>
138</indexterm>
139</sect3>
140
141<sect3><title>Configuration Information</title>
142
143<para>To configure
144<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
145after installation, you should run the <command>adsl-setup</command>
146script.</para>
147
148<para>When configuring your connection, you will need to have your
149<acronym>ISP</acronym>'s nameserver information available, as well as your
150username and password. You will also be asked whether to configure a
151dial-on-demand or a constant connection. If your service provider does not
152charge by the minute, it is usually good to have a bootscript handle the
153connection for you. You can, of course, choose not to install the
154following script, and start your connection manually with the
155<command>adsl-start</command> script.</para>
156
157<para id="pppoe-init"><emphasis>Optionally</emphasis> install the
158<filename>/etc/sysconfig/network-devices/services/pppoe</filename> service
159script included with the <xref linkend="intro-important-bootscripts"/>
160package (as user root).</para>
161<indexterm zone="pppoe pppoe-init">
162<primary sortas="f-pppoe-service-script">pppoe (service script)</primary>
163</indexterm>
164
165<screen><userinput role='root'><command>make install-service-pppoe</command></userinput></screen>
166
167<para id="pppoe-config2">Now create the config file for use with the
168<filename>pppoe</filename> service script (as user root):</para>
169<indexterm zone="pppoe pppoe-config2">
170<primary sortas="e-etc-sysconfig-pppoe">/etc/sysconfig/.../pppoe</primary>
171</indexterm>
172
173<note><para>If you have previously configured the network interface that
174will now use <acronym>PPPoE</acronym>, you should remove the interface
175configuration files for that interface (as user root):</para>
176
177<para><command><userinput role='root'>rm
178/etc/sysconfig/network-devices/ifconfig.eth0/*</userinput></command></para>
179</note>
180
181<screen><userinput role='root'><command>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &amp;&amp;
182cat &gt; /etc/sysconfig/network-devices/ifconfig.eth0/pppoe &lt;&lt; "EOF"</command>
183ONBOOT="yes"
184SERVICE="pppoe"
185<command>EOF</command></userinput></screen>
186
187<!-- A TYPE="[user/kernel]" will be added at a later date when kernel
188mode pppoe is described here. -->
189</sect3>
190
191</sect2>
192
193<sect2>
194<title>Contents</title>
195
196<segmentedlist>
197<segtitle>Installed Programs</segtitle>
198<segtitle>Installed Libraries</segtitle>
199<segtitle>Installed Directories</segtitle>
200
201<seglistitem>
202<seg>adsl-connect, adsl-setup, adsl-start, adsl-status, adsl-stop, pppoe,
203pppoe-relay, pppoe-server and pppoe-sniff</seg>
204<seg>None</seg>
205<seg>/etc/ppp/plugins and /usr/share/doc/rp-pppoe-&pppoe-version;</seg>
206</seglistitem>
207</segmentedlist>
208
209<variablelist>
210<bridgehead renderas="sect3">Short Descriptions</bridgehead>
211<?dbfo list-presentation="list"?>
212
213<varlistentry id="adsl-connect">
214<term><command>adsl-connect</command></term>
215<listitem><para>is a shell script which manages an <acronym>ADSL</acronym>
216connection using the user-space <acronym>PPPoE</acronym> client.</para>
217<indexterm zone="pppoe adsl-connect">
218<primary sortas="b-adsl-connect">adsl-connect</primary>
219</indexterm></listitem>
220</varlistentry>
221
222<varlistentry id="adsl-setup">
223<term><command>adsl-setup</command></term>
224<listitem><para>is a script for configuring the client. Configuration is
225then stored in <filename>/etc/ppp/pppoe.conf</filename>.</para>
226<indexterm zone="pppoe adsl-setup">
227<primary sortas="b-adsl-setup">adsl-setup</primary>
228</indexterm></listitem>
229</varlistentry>
230
231<varlistentry id="adsl-start">
232<term><command>adsl-start</command></term>
233<listitem><para>starts the client using the options specified in
234<filename>/etc/ppp/pppoe.conf</filename>.</para>
235<indexterm zone="pppoe adsl-start">
236<primary sortas="b-adsl-start">adsl-start</primary>
237</indexterm></listitem>
238</varlistentry>
239
240<varlistentry id="adsl-status">
241<term><command>adsl-status</command></term>
242<listitem><para>displays the status of the <acronym>ADSL</acronym>
243connection.</para>
244<indexterm zone="pppoe adsl-status">
245<primary sortas="b-adsl-status">adsl-status</primary>
246</indexterm></listitem>
247</varlistentry>
248
249<varlistentry id="adsl-stop">
250<term><command>adsl-stop</command></term>
251<listitem><para>stops the client.</para>
252<indexterm zone="pppoe adsl-stop">
253<primary sortas="b-adsl-stop">adsl-stop</primary>
254</indexterm></listitem>
255</varlistentry>
256
257<varlistentry id="pppoe-prog">
258<term><command>pppoe</command></term>
259<listitem><para>is the client program. Generally it should not be started on
260its own.</para>
261<indexterm zone="pppoe pppoe-prog">
262<primary sortas="b-pppoe">pppoe</primary>
263</indexterm></listitem>
264</varlistentry>
265
266<varlistentry id="pppoe-relay">
267<term><command>pppoe-relay</command></term>
268<listitem><para>starts the server relay agent.</para>
269<indexterm zone="pppoe pppoe-relay">
270<primary sortas="b-pppoe-relay">pppoe-relay</primary>
271</indexterm></listitem>
272</varlistentry>
273
274<varlistentry id="pppoe-server">
275<term><command>pppoe-server</command></term>
276<listitem><para>starts the server component.</para>
277<indexterm zone="pppoe pppoe-server">
278<primary sortas="b-pppoe-server">pppoe-server</primary>
279</indexterm></listitem>
280</varlistentry>
281
282<varlistentry id="pppoe-sniff">
283<term><command>pppoe-sniff</command></term>
284<listitem><para>is a small network sniffer designed to assist in setting
285<envar>PPPOE_EXTRA</envar> settings.</para>
286<indexterm zone="pppoe pppoe-sniff">
287<primary sortas="b-pppoe-sniff">pppoe-sniff</primary>
288</indexterm></listitem>
289</varlistentry>
290</variablelist>
291
292</sect2>
293
294</sect1>
Note: See TracBrowser for help on using the repository browser.