Document installs over PPPoE; based on a text proposed by Eddy Petrisor

5 files changed, 120 insertions, 3 deletions

diff --git a/build/templates/docstruct.ent b/build/templates/docstruct.ent
index 010464bb8..b28ca7656 100644
--- a/build/templates/docstruct.ent
+++ b/build/templates/docstruct.ent
@@ -188,6 +188,7 @@
   <!ENTITY files.xml            SYSTEM "##SRCPATH##/appendix/files.xml">
   <!ENTITY chroot-install.xml   SYSTEM "##SRCPATH##/appendix/chroot-install.xml">
   <!ENTITY plip.xml             SYSTEM "##SRCPATH##/appendix/plip.xml">
+  <!ENTITY pppoe.xml            SYSTEM "##SRCPATH##/appendix/pppoe.xml">
   <!ENTITY graphical.xml        SYSTEM "##SRCPATH##/appendix/graphical.xml">
  <!ENTITY administrivia.xml    SYSTEM "##SRCPATH##/administrivia/administrivia.xml">
  <!ENTITY gpl.xml              SYSTEM "##SRCPATH##/appendix/gpl.xml">
diff --git a/debian/changelog b/debian/changelog
index 676d82567..fdf4b3901 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -18,11 +18,13 @@ installation-guide (2007xxxx) UNRELEASED; urgency=low
     Thanks to Francesco Poli for suggesting the changes. Closes: #410317.
   * using-d-i: guided partitioning now creates swap inside LVM.
     Thanks to Francesco Poli. Closes: #411399.
+  * Document installs over PPPoE. Based on a text proposed by Eddy Petrisor.
+    Closes: #408340.
 
   [ Joey Hess ]
   * Document debian-installer/allow_unauthenticated.
 
- -- Frans Pop <fjp@debian.org>  Sun, 18 Feb 2007 19:45:13 +0100
+ -- Frans Pop <fjp@debian.org>  Sun, 18 Feb 2007 20:34:28 +0100
 
 installation-guide (20070122) unstable; urgency=low
 
diff --git a/en/appendix/pppoe.xml b/en/appendix/pppoe.xml
new file mode 100644
index 000000000..96dd3bcaa
--- /dev/null
+++ b/en/appendix/pppoe.xml
@@ -0,0 +1,113 @@
+<!-- retain these comments for translator revision tracking -->
+<!-- $Id: plip.xml 39644 2006-08-08 22:08:57Z jfs $ -->
+
+ <sect1 id="pppoe" arch="not-s390">
+ <title>Installing &debian; using PPP over Ethernet (PPPoE)</title>
+
+<para>
+
+In some countries PPP over Ethernet (PPPoE) is a common protocol for
+broadband (ADSL or cable) connections to an Internet Service Provider.
+Setting up a network connection using PPPoE is not supported by default
+in the installer, but can be made to work very simply. This section
+explains how.
+
+</para><para>
+
+The PPPoE connection set up during the installation will also be available
+after the reboot into the installed system (see <xref linkend="boot-new"/>).
+
+</para><para>
+
+To have the option of setting up and using PPPoE during the installation,
+you will need to install using one of the CD-ROM/DVD images that are
+available. It is not supported for other installation methods (e.g.
+netboot<phrase condition="supports-floppy-boot"> or floppy</phrase>).
+
+</para><para>
+
+Installing over PPPoE is mostly the same as any other installation. The
+following steps explain the differences.
+
+</para>
+
+<itemizedlist>
+<listitem><para>
+
+Boot the installer with <userinput>modules=ppp-udeb</userinput> as boot
+parameter. This means that at the boot prompt you should enter:
+
+<informalexample><screen>
+install modules=ppp-udeb
+</screen></informalexample>
+
+or, if you prefer using the graphical installer:
+
+<informalexample><screen>
+installgui modules=ppp-udeb
+</screen></informalexample>
+
+This will ensure the component responsible for the setup of PPPoE
+(<classname>ppp-udeb</classname>) will be loaded and run automatically.
+
+</para></listitem>
+<listitem><para>
+
+Follow the regular initial steps of the installation (language,
+country and keyboard selection; the loading of additional installer
+components<footnote>
+
+<para>
+
+The <classname>ppp-udeb</classname> component is loaded as one of
+the additional components in this step. If you want to install at
+medium or low priority (expert mode), you can also manually select
+the <classname>ppp-udeb</classname> instead of entering the
+<quote>modules</quote> parameter at the boot prompt.
+
+</para>
+
+</footnote>).
+
+</para></listitem>
+<listitem><para>
+
+The next step is the detection of network hardware, in order to identify
+any Ethernet cards present in the system.
+
+</para></listitem>
+<listitem><para>
+
+After this the actual setup of PPPoE is started. The installer will probe
+all the detected Ethernet interfaces in an attempt to find a PPPoE
+concentrator (a type of server which handles PPPoE connections).
+
+</para><para>
+
+It is possible that the concentrator will not to be found at the first
+attempt. This can happen occasionally on slow or loaded networks or with
+faulty servers. In most cases a second attempt to detect the concentrator
+will be successful; to retry, select <guimenuitem>Configure and start a
+PPPoE connection</guimenuitem> from the main menu of the installer).
+
+</para></listitem>
+<listitem><para>
+
+After a concentrator is found, the user will be prompted to type the login
+information (the PPPoE username and password).
+
+</para></listitem>
+<listitem><para>
+
+At this point the installer will use the provided information to establish
+the PPPoE connection. If the correct information was provided, the PPPoE
+connection should be configured and the installer should be able to use it
+to connect to the Internet and retrieve packages over it (if needed). If
+the login information is not correct or some error appears, the installer
+will stop, but the configuration can be attempted again by selecting the
+menu entry <guimenuitem>Configure and start PPPoE networking</guimenuitem>.
+
+</para></listitem>
+</itemizedlist>
+
+ </sect1>
diff --git a/en/appendix/random-bits.xml b/en/appendix/random-bits.xml
index e19709b0b..d3aa6bd33 100644
--- a/en/appendix/random-bits.xml
+++ b/en/appendix/random-bits.xml
@@ -6,6 +6,7 @@
 &files.xml;
 &chroot-install.xml;
 &plip.xml;
+&pppoe.xml;
 &graphical.xml;
 
 </appendix>
diff --git a/en/boot-installer/parameters.xml b/en/boot-installer/parameters.xml
index 60a2b7cc7..514521f72 100644
--- a/en/boot-installer/parameters.xml
+++ b/en/boot-installer/parameters.xml
@@ -451,8 +451,8 @@ Can be used to automatically load installer components that are not loaded
 by default.
 Examples of optional components that may be useful are
 <classname>openssh-client-udeb</classname> (so you can use
-<command>scp</command> during the installation) and
-<classname>ppp-udeb</classname> (which supports PPPoE configuration).
+<command>scp</command> during the installation)<phrase arch="not-s390"> and
+<classname>ppp-udeb</classname> (see <xref linkend="pppoe"/>)</phrase>.
 
 </para></listitem>
 </varlistentry>