Changeset e51a0eb2 for connect/other/pppoe.xml

Timestamp:

02/10/2005 06:54:49 PM (19 years ago)

Author:

Randy McMurchy <randy@…>

Branches:

10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 6.0, 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, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal

Children:

e8eb87c

Parents:

791e96fa

Message:

Fixed broken download URLs, added md5sum and indexing tags to RP-PPPoE instructions

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

File:

• connect/other/pppoe.xml (modified) (12 diffs)

connect/other/pppoe.xml

@@ -5 +5 @@
   %general-entities;
 
-  <!ENTITY pppoe-download-http "http://www.roaringpenguin.com/products/rp-pppoe/rp-pppoe-&pppoe-version;.tar.gz">
-  <!ENTITY pppoe-download-ftp  "ftp://ftp.rutgers.edu/pub/slackware/slackware_source/n/rp-pppoe/rp-pppoe-&pppoe-version;.tar.gz">
+  <!ENTITY pppoe-download-http "http://www.roaringpenguin.com/penguin/pppoe/rp-pppoe-&pppoe-version;.tar.gz">
+  <!ENTITY pppoe-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/rp-pppoe-&pppoe-version;.tar.gz">
+  <!ENTITY pppoe-md5sum        "97972f8f8f6a3ab9b7070333a6a29c4b">
   <!ENTITY pppoe-size          "185 KB">
   <!ENTITY pppoe-buildsize     "2.2 MB">
@@ -19 +20 @@
 <?dbhtml filename="pppoe.html"?>
 <title>RP-PPPoE-&pppoe-version;</title>
+<indexterm zone="pppoe">
+<primary sortas="a-RP-PPPoE">RP-PPPoE</primary></indexterm>
 
 <sect2>
@@ -38 +41 @@
 <listitem><para>Download (FTP): <ulink
 url="&pppoe-download-ftp;"/></para></listitem>
+<listitem><para>Download MD5 sum: &pppoe-md5sum;</para></listitem>
 <listitem><para>Download size: &pppoe-size;</para></listitem>
 <listitem><para>Estimated disk space required:
@@ -45 +49 @@
 </sect3>
 
-<sect3><title><application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> 
+<sect3><title>
+<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> 
 dependencies</title>
 <sect4><title>Required</title>
@@ -51 +56 @@
 <xref linkend="net-tools"/> (you may omit
 <application>Net-tools</application> by using the following patch to
-utilize <application><acronym>IP</acronym>Route2</application>: <ulink
+utilize <application><acronym>IP</acronym>Route2</application>: <ulink 
 url="&patch-root;/rp-pppoe-&pppoe-version;-iproute2-1.patch"/>)</para>
 </sect4>
@@ -58 +63 @@
 </sect2>
 
-<sect2>
+<sect2 id="pppoe-kernel">
 <title>Installation of 
-<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
+<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
+</title>
 
 <note><para>If you plan on using kernel-mode <acronym>PPPoE</acronym>, 
@@ -67 +73 @@
 <acronym>PPPoE</acronym> can be found in 
 <filename>rp-pppoe-&pppoe-version;/doc/KERNEL-MODE-PPPOE</filename>.</para></note>
+<indexterm zone="pppoe pppoe-kernel">
+<primary sortas="d-Kernel-mode-PPPoE">Kernel-mode PPPoE</primary></indexterm>
 
 <para>Install 
@@ -74 +82 @@
 <screen><userinput><command>cd src &amp;&amp;
 ./configure &amp;&amp;
-make &amp;&amp;
-make install</command></userinput></screen>
+make</command></userinput></screen>
+
+<para>Now, as the root user:</para>
+
+<screen><userinput role='root'><command>make install</command></userinput></screen>
 
 </sect2>
@@ -92 +103 @@
 <sect2>
 <title>Configuring 
-<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
-
-<sect3><title>Config files</title>
+<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
+</title>
+
+<sect3 id="pppoe-config"><title>Config files</title>
 <para><filename>/etc/ppp/pppoe.conf</filename>, 
 <filename>/etc/ppp/firewall-standalone</filename>, 
@@ -100 +112 @@
 <filename>/etc/ppp/pppoe-server-options</filename>, 
 <filename>/etc/resolv.conf</filename>, 
-<filename>/etc/ppp/pap-seecrets</filename>, 
-<filename>/etc/ppp/chap-secrets</filename></para></sect3>
+<filename>/etc/ppp/pap-secrets</filename>, 
+<filename>/etc/ppp/chap-secrets</filename></para>
+<indexterm zone="pppoe pppoe-config"><primary 
+sortas="e-etc-ppp-pppoe.conf">/etc/ppp/pppoe.conf</primary>
+</indexterm>
+<indexterm zone="pppoe pppoe-config"><primary 
+sortas="e-etc-ppp-firewall-standalone">/etc/ppp/firewall-standalone</primary>
+</indexterm>
+<indexterm zone="pppoe pppoe-config"><primary 
+sortas="e-etc-ppp-firewall-masq">/etc/ppp/firewall-masq</primary>
+</indexterm>
+<indexterm zone="pppoe pppoe-config"><primary 
+sortas="e-etc-ppp-pppoe-server-options">/etc/ppp/pppoe-server-options</primary>
+</indexterm>
+<indexterm zone="pppoe pppoe-config"><primary 
+sortas="e-etc-resolv.conf">/etc/resolv.conf</primary>
+</indexterm>
+<indexterm zone="pppoe pppoe-config"><primary 
+sortas="e-etc-ppp-pap-secrets">/etc/ppp/pap-secrets</primary>
+</indexterm>
+<indexterm zone="pppoe pppoe-config"><primary 
+sortas="e-etc-ppp-chap-secrets">/etc/ppp/chap-secrets</primary>
+</indexterm>
+</sect3>
 
 <sect3><title>Configuration Information</title>
@@ -119 +153 @@
 <command>adsl-start</command> script.</para>
 
-<para><emphasis>Optionally</emphasis> install the 
+<para id="pppoe-init"><emphasis>Optionally</emphasis> install the 
 <filename>/etc/sysconfig/network-devices/services/pppoe</filename> service 
 script included with the <xref linkend="intro-important-bootscripts"/> 
-package.</para>
-
-<screen><userinput><command>make install-service-pppoe</command></userinput></screen>
-
-<para>Now create the config file for use with the <filename>pppoe</filename> 
-service script:</para>
+package (as user root).</para>
+<indexterm zone="pppoe pppoe-init">
+<primary sortas="f-pppoe-service-script">pppoe (service script)</primary>
+</indexterm>
+
+<screen><userinput role='root'><command>make install-service-pppoe</command></userinput></screen>
+
+<para id="pppoe-config2">Now create the config file for use with the 
+<filename>pppoe</filename> service script (as user root):</para>
+<indexterm zone="pppoe pppoe-config2">
+<primary sortas="e-etc-sysconfig-pppoe">/etc/sysconfig/.../pppoe</primary>
+</indexterm>
 
 <note><para>If you have previously configured the network interface that
 will now use <acronym>PPPoE</acronym>, you should remove the interface 
-configuration files for that interface:</para>
-
-<para><command><userinput>rm 
+configuration files for that interface (as user root):</para>
+
+<para><command><userinput role='root'>rm 
 /etc/sysconfig/network-devices/ifconfig.eth0/*</userinput></command></para>
 </note>
 
-<screen><userinput><command>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &amp;&amp;
+<screen><userinput role='root'><command>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &amp;&amp;
 cat &gt; /etc/sysconfig/network-devices/ifconfig.eth0/pppoe &lt;&lt; "EOF"</command>
 ONBOOT="yes"
@@ -152 +192 @@
 <title>Contents</title>
 
-<para>The 
-<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> 
-package contains <command>adsl-setup</command>, <command>adsl-start</command>, 
-<command>adsl-status</command>, <command>adsl-stop</command>, <command>
-pppoe</command>, <command>pppoe-relay</command>, <command>pppoe-server
-</command> and <command>pppoe-sniff</command>.</para>
-
-</sect2>
-
-<sect2><title>Description</title>
-
-<sect3><title>adsl-setup</title>
-<para>A script for configuring the client.  Configuration is then stored
-in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
-
-<sect3><title>adsl-start</title>
-<para><command>adsl-start</command> starts the client using the options 
-specified in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
-
-<sect3><title>adsl-status</title>
-<para><command>adsl-status</command> displays the status of the
-<acronym>ADSL</acronym> connection.</para></sect3>
-
-<sect3><title>adsl-stop</title>
-<para><command>adsl-stop</command> stops the client.</para></sect3>
-
-<sect3><title>pppoe</title>
-<para>This is the client itself. Generally it should not be started on its 
-own.</para></sect3>
-
-<sect3><title>pppoe-relay</title>
-<para><command>pppoe-relay</command> starts the server relay 
-agent.</para></sect3>
-
-<sect3><title>pppoe-server</title>
-<para><command>pppoe-server</command> starts the server 
-component.</para></sect3>
-
-<sect3><title>pppoe-sniff</title>
-<para>A small network sniffer designed to assist in setting 
-<envar>PPPOE_EXTRA</envar> settings.</para></sect3>
+<segmentedlist>
+<segtitle>Installed Programs</segtitle>
+<segtitle>Installed Libraries</segtitle>
+<segtitle>Installed Directories</segtitle>
+
+<seglistitem>
+<seg>adsl-connect, adsl-setup, adsl-start, adsl-status, adsl-stop, pppoe, 
+pppoe-relay, pppoe-server and pppoe-sniff</seg>
+<seg>None</seg>
+<seg>/etc/ppp/plugins and /usr/share/doc/rp-pppoe-&pppoe-version;</seg>
+</seglistitem>
+</segmentedlist>
+
+<variablelist>
+<bridgehead renderas="sect3">Short Descriptions</bridgehead>
+<?dbfo list-presentation="list"?>
+
+<varlistentry id="adsl-connect">
+<term><command>adsl-connect</command></term>
+<listitem><para>is a shell script which manages an <acronym>ADSL</acronym> 
+connection using the user-space <acronym>PPPoE</acronym> client.</para>
+<indexterm zone="pppoe adsl-connect">
+<primary sortas="b-adsl-connect">adsl-connect</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="adsl-setup">
+<term><command>adsl-setup</command></term>
+<listitem><para>is a script for configuring the client. Configuration is 
+then stored in <filename>/etc/ppp/pppoe.conf</filename>.</para>
+<indexterm zone="pppoe adsl-setup">
+<primary sortas="b-adsl-setup">adsl-setup</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="adsl-start">
+<term><command>adsl-start</command></term>
+<listitem><para>starts the client using the options specified in 
+<filename>/etc/ppp/pppoe.conf</filename>.</para>
+<indexterm zone="pppoe adsl-start">
+<primary sortas="b-adsl-start">adsl-start</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="adsl-status">
+<term><command>adsl-status</command></term>
+<listitem><para>displays the status of the <acronym>ADSL</acronym> 
+connection.</para>
+<indexterm zone="pppoe adsl-status">
+<primary sortas="b-adsl-status">adsl-status</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="adsl-stop">
+<term><command>adsl-stop</command></term>
+<listitem><para>stops the client.</para>
+<indexterm zone="pppoe adsl-stop">
+<primary sortas="b-adsl-stop">adsl-stop</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="pppoe-prog">
+<term><command>pppoe</command></term>
+<listitem><para>is the client program. Generally it should not be started on 
+its own.</para>
+<indexterm zone="pppoe pppoe-prog">
+<primary sortas="b-pppoe">pppoe</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="pppoe-relay">
+<term><command>pppoe-relay</command></term>
+<listitem><para>starts the server relay agent.</para>
+<indexterm zone="pppoe pppoe-relay">
+<primary sortas="b-pppoe-relay">pppoe-relay</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="pppoe-server">
+<term><command>pppoe-server</command></term>
+<listitem><para>starts the server component.</para>
+<indexterm zone="pppoe pppoe-server">
+<primary sortas="b-pppoe-server">pppoe-server</primary>
+</indexterm></listitem>
+</varlistentry>
+
+<varlistentry id="pppoe-sniff">
+<term><command>pppoe-sniff</command></term>
+<listitem><para>is a small network sniffer designed to assist in setting 
+<envar>PPPOE_EXTRA</envar> settings.</para>
+<indexterm zone="pppoe pppoe-sniff">
+<primary sortas="b-pppoe-sniff">pppoe-sniff</primary>
+</indexterm></listitem>
+</varlistentry>
+</variablelist>
 
 </sect2>