svn commit: r42992 - head/en_US.ISO8859-1/books/handbook/ppp-and-slip

Dru Lavigne dru at FreeBSD.org
Thu Oct 17 21:56:10 UTC 2013


Author: dru
Date: Thu Oct 17 21:56:10 2013
New Revision: 42992
URL: http://svnweb.freebsd.org/changeset/doc/42992

Log:
  This patch does the following:
  - replaces FreeBSD with entity
  - adds acronym tags for instances of PPP that refer to the protocol, the instances that refer to the app still need to be fixed
  - comments out "26.5.1. Using PPPoA with the Alcatel SpeedTouch USB" as the port it relies on has been broken for 4 years
  - fixes internal links
  
  This will be followed by a white space fix.

Modified:
  head/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml	Thu Oct 17 21:22:38 2013	(r42991)
+++ head/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml	Thu Oct 17 21:56:10 2013	(r42992)
@@ -18,47 +18,40 @@
   </chapterinfo>
   -->
 
-  <title>PPP</title>
+  <title><acronym>PPP</acronym></title>
 
   <sect1 id="ppp-and-slip-synopsis">
     <title>Synopsis</title>
 
     <indexterm id="ppp-ppp">
-      <primary>PPP</primary>
+      <primary><acronym>PPP</acronym></primary>
     </indexterm>
 
-    <para>FreeBSD has a number of ways to link one computer to
+    <para>&os; has a number of ways to link one computer to
       another.  To establish a network or Internet connection through
       a dial-up modem, or to allow others to do so through you,
-      requires the use of PPP.  This chapter describes setting
+      requires the use of <acronym>PPP</acronym>.  This chapter describes setting
       up these modem-based communication services in detail.</para>
 
     <para>After reading this chapter, you will know:</para>
 
     <itemizedlist>
       <listitem>
-	<para>How to set up user PPP.</para>
+	<para>How to set configure <acronym>PPP</acronym>.</para>
       </listitem>
       <listitem>
-	<para>How to set up <acronym>PPPoE</acronym> (PPP over
-	  Ethernet).</para>
+	<para>How to set up <acronym>PPP</acronym> over Ethernet (<acronym>PPPoE</acronym>).</para>
       </listitem>
       <listitem>
-	<para>How to set up <acronym>PPPoA</acronym> (PPP over
-	  ATM).</para>
+	<para>How to set up <acronym>PPP</acronym> over ATM (<acronym>PPPoA</acronym>).</para>
       </listitem>
     </itemizedlist>
 
     <indexterm>
-      <primary>PPP</primary>
-      <secondary>user PPP</secondary>
+      <primary><acronym>PPP</acronym></primary>
     </indexterm>
     <indexterm>
-      <primary>PPP</primary>
-      <secondary>kernel PPP</secondary>
-    </indexterm>
-    <indexterm>
-      <primary>PPP</primary>
+      <primary><acronym>PPP</acronym></primary>
       <secondary>over Ethernet</secondary>
     </indexterm>
 
@@ -70,7 +63,7 @@
       </listitem>
       <listitem>
 	<para>Understand the basics and purpose of a dialup connection
-	  and PPP.</para>
+	  and <acronym>PPP</acronym>.</para>
       </listitem>
     </itemizedlist>
   </sect1>
@@ -110,14 +103,14 @@
     </sect1info>
     -->
 
-    <title>Configuring PPP</title>
+    <title>Configuring <acronym>PPP</acronym></title>
 
 	<para>This document assumes you have the following:</para>
 
 	<itemizedlist>
 	  <listitem>
-	    <para>An account with an Internet Service Provider (ISP)<indexterm id="ppp-isp"><primary>ISP</primary></indexterm>
-	      which you connect to using PPP<indexterm id="ppp-ppp2"><primary>PPP</primary></indexterm>.</para>
+	    <para>An account with an Internet Service Provider (<acronym>ISP</acronym>)
+	      which you connect to using <acronym>PPP</acronym>.</para>
 	  </listitem>
 
 	  <listitem>
@@ -131,20 +124,18 @@
 	  </listitem>
 
 	  <listitem>
-	    <para>Your login name<indexterm id="ppp-login"><primary>login name</primary></indexterm> and password<indexterm id="ppp-password"><primary>password</primary></indexterm>.  (Either a
-	      regular &unix;<indexterm id="ppp-unix"><primary>UNIX</primary></indexterm> style login and password pair, or a PAP<indexterm id="ppp-pap"><primary>PAP</primary></indexterm>
-	      or CHAP<indexterm id="ppp-chap"><primary>CHAP</primary></indexterm> login and password pair).</para>
+	    <para>The login name and password assigned by the ISP.</para>
 	  </listitem>
 
 	  <listitem>
-	    <para>The IP address of one or more name servers<indexterm id="ppp-nameserver"><primary>nameserver</primary></indexterm>.
+	    <para>The IP address of one or more name servers.
 	      Normally, you will be given two IP addresses by your
 	      ISP to use for this.  If they have not given you at
 	      least one, then you can use the <command>enable
 		dns</command> command in <filename>ppp.conf</filename>
 	      and <application>ppp</application> will set the name
-	      servers for you.  This feature depends on your ISPs
-	      PPP implementation supporting DNS negotiation.</para>
+	      servers for you.  This feature depends on your ISP's
+	      <acronym>PPP</acronym> implementation supporting DNS negotiation.</para>
 	  </listitem>
 	</itemizedlist>
 
@@ -313,7 +304,7 @@
 	      <term>Line 6 & 7:</term>
 
 	      <listitem>
-		<para>The dial string.  User PPP<indexterm><primary>PPP</primary><secondary>user PPP</secondary></indexterm> uses an expect-send
+		<para>The dial string.  PPP uses an expect-send
 		  syntax similar to the &man.chat.8; program.  Refer
 		  to the manual page for information on the features
 		  of this language.</para>
@@ -410,9 +401,9 @@
 	      <listitem>
 		<para>If you are using PAP<indexterm><primary>PAP</primary></indexterm> or CHAP<indexterm><primary>CHAP</primary></indexterm>, there will be no
 		  login at this point, and this line should be
-		  commented out or removed.  See <link
-		    linkend="userppp-PAPnCHAP">PAP and CHAP
-		    authentication</link> for further details.</para>
+		  commented out or removed.  See <xref
+		    linkend="userppp-PAPnCHAP"/>
+		  for further details.</para>
 
 		<para>The login string is of the same chat-like
 		  syntax as the dial string.  In this example, the
@@ -461,9 +452,8 @@ protocol: ppp</screen>
 		  use a <quote>guessed</quote> address, make sure that
 		  you create an entry in
 		  <filename>/etc/ppp/ppp.linkup</filename> as per the
-		  instructions for <link
-		  linkend="userppp-dynamicIP">PPP and Dynamic IP
-		  addresses</link>.  If this line is omitted,
+		  instructions in <xref
+		  linkend="userppp-dynamicIP"/>.  If this line is omitted,
 		  <command>ppp</command> cannot run in
 		  <option>-auto</option> mode.</para>
 	      </listitem>
@@ -502,10 +492,10 @@ protocol: ppp</screen>
 	</sect2>
 
 	<sect2 id="userppp-dynamicIP">
-	  <title>PPP With Dynamic IP Addresses</title>
+	  <title><acronym>PPP</acronym> With Dynamic IP Addresses</title>
 
 	  <indexterm>
-	    <primary>PPP</primary>
+	    <primary><acronym>PPP</acronym></primary>
 	    <secondary>with dynamic IP addresses</secondary>
 	  </indexterm>
 
@@ -519,9 +509,8 @@ protocol: ppp</screen>
 	    <quote>guessing</quote> an IP address and allowing
 	    <command>ppp</command> to set it up correctly using the IP
 	    Configuration Protocol (IPCP) after connecting.  The
-	    <filename>ppp.conf</filename> configuration is the same as
-	    <link linkend="userppp-staticIP">PPP and Static IP
-	    Addresses</link>, with the following change:</para>
+	    <filename>ppp.conf</filename> configuration is the same as that described in
+	    <xref linkend="userppp-staticIP"/>, with the following change:</para>
 
 	  <programlisting>17      set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.255 0.0.0.0</programlisting>
 
@@ -607,7 +596,7 @@ protocol: ppp</screen>
 	  <title>Receiving Incoming Calls</title>
 
 	  <indexterm>
-	    <primary>PPP</primary>
+	    <primary><acronym>PPP</acronym></primary>
 	    <secondary>receiving incoming calls</secondary>
 	  </indexterm>
 
@@ -627,8 +616,8 @@ protocol: ppp</screen>
 	<sect2>
 	  <title>Which getty?</title>
 
-	  <para><link linkend="dialup">Configuring FreeBSD for
-	      Dial-up Services</link> provides a good description
+	  <para><xref linkend="dialup"/>
+	    provides a good description
 	    on enabling dial-up services using &man.getty.8;.</para>
 
 	  <para>An alternative to <command>getty</command> is <ulink
@@ -645,11 +634,11 @@ protocol: ppp</screen>
 
 	  <para>Later versions of <command>mgetty</command> (from
 	    0.99beta onwards) also support the automatic detection of
-	    PPP streams, allowing your clients script-less access to
+	    <acronym>PPP</acronym> streams, allowing your clients script-less access to
 	    your server.</para>
 
-	  <para>Refer to <link linkend="userppp-mgetty">Mgetty and
-	      AutoPPP</link> for more information on
+	  <para>Refer to <xref linkend="userppp-mgetty"/>
+	    for more information on
 	    <command>mgetty</command>.</para>
 	</sect2>
 
@@ -677,10 +666,10 @@ protocol: ppp</screen>
 	</sect2>
 
 	<sect2>
-	  <title>PPP Shells for Dynamic IP Users</title>
+	  <title><acronym>PPP</acronym> Shells for Dynamic IP Users</title>
 
 	  <indexterm>
-	    <primary>PPP shells</primary>
+	    <primary><acronym>PPP</acronym> shells</primary>
 	  </indexterm>
 
 	  <para>Create a file called
@@ -710,7 +699,7 @@ exec /usr/sbin/ppp -direct $IDENT</progr
 	  <para>You should use this script as the
 	    <emphasis>shell</emphasis> for all of your dialup users.
 	    This is an example from <filename>/etc/passwd</filename>
-	    for a dialup PPP user with username
+	    for a dialup <acronym>PPP</acronym> user with username
 	    <username>pchilds</username> (remember do not directly
 	    edit the password file, use &man.vipw.8;).</para>
 
@@ -729,10 +718,10 @@ exec /usr/sbin/ppp -direct $IDENT</progr
 	  </sect2>
 
 	  <sect2>
-	    <title>PPP Shells for Static IP Users</title>
+	    <title><acronym>PPP</acronym> Shells for Static IP Users</title>
 
 	    <indexterm>
-	      <primary>PPP shells</primary>
+	      <primary><acronym>PPP</acronym> shells</primary>
 	    </indexterm>
 
 	    <para>Create the <filename>ppp-shell</filename> file as
@@ -841,7 +830,7 @@ mary:
 	      role="package">comms/mgetty+sendfax</filename> port
 	    comes with the <literal>AUTO_PPP</literal> option enabled
 	    allowing <command>mgetty</command> to detect the LCP
-	    phase of PPP connections and automatically spawn off a
+	    phase of <acronym>PPP</acronym> connections and automatically spawn off a
 	    ppp shell.  However, since the default login/password
 	    sequence does not occur it is necessary to authenticate
 	    users using either PAP or CHAP.</para>
@@ -859,7 +848,7 @@ mary:
 
 	  <para>This will tell <command>mgetty</command> to run the
 	    <filename>ppp-pap-dialup</filename> script for detected
-	    PPP connections.</para>
+	    <acronym>PPP</acronym> connections.</para>
 
 	  <para>Create a file called
 	    <filename>/etc/ppp/ppp-pap-dialup</filename> containing
@@ -907,14 +896,14 @@ exec /usr/sbin/ppp -direct pap$IDENT</pr
 	  </indexterm>
 
 	  <indexterm>
-	    <primary>PPP</primary>
+	    <primary><acronym>PPP</acronym></primary>
 	    <secondary>Microsoft extensions</secondary>
 	  </indexterm>
 
 	  <para>It is possible to configure PPP to supply DNS and
 	    NetBIOS nameserver addresses on demand.</para>
 
-	  <para>To enable these extensions with PPP version 1.x, the
+	  <para>To enable these extensions with <acronym>PPP</acronym> version 1.x, the
 	    following lines might be added to the relevant section
 	    of <filename>/etc/ppp/ppp.conf</filename>.</para>
 
@@ -922,7 +911,7 @@ exec /usr/sbin/ppp -direct pap$IDENT</pr
 set ns 203.14.100.1 203.14.100.2
 set nbns 203.14.100.5</programlisting>
 
-	  <para>And for PPP version 2 and above:</para>
+	  <para>And for <acronym>PPP</acronym> version 2 and above:</para>
 
 	  <programlisting>accept dns
 set dns 203.14.100.1 203.14.100.2
@@ -933,7 +922,7 @@ set nbns 203.14.100.5</programlisting>
 	    host.</para>
 
 	  <para>In version 2 and above, if the
-	    <literal>set dns</literal> line is omitted, PPP will
+	    <literal>set dns</literal> line is omitted, <acronym>PPP</acronym> will
 	    use the values found in
 	    <filename>/etc/resolv.conf</filename>.</para>
 	</sect2>
@@ -948,7 +937,7 @@ set nbns 203.14.100.5</programlisting>
 	    either of the PAP or CHAP authentication mechanisms.  If
 	    this is the case, your ISP will not give a
 	    <prompt>login:</prompt> prompt when you connect, but will
-	    start talking PPP immediately.</para>
+	    start talking <acronym>PPP</acronym> immediately.</para>
 
 	  <para>PAP is less secure than CHAP, but security is not
 	    normally an issue here as passwords, although being sent
@@ -956,11 +945,11 @@ set nbns 203.14.100.5</programlisting>
 	    serial line only.  There is not much room for crackers
 	    to <quote>eavesdrop</quote>.</para>
 
-	  <para>Referring back to the <link
-	      linkend="userppp-staticIP">PPP and Static IP
-	    addresses</link> or <link
-	      linkend="userppp-dynamicIP">PPP and Dynamic IP
-	    addresses</link> sections, the following alterations must
+	  <para>Referring back to <xref
+	      linkend="userppp-staticIP"/>
+	    or <xref
+	      linkend="userppp-dynamicIP"/>,
+	    the following alterations must
 	    be made:</para>
 
 	  <programlisting>13      set authname <replaceable>MyUserName</replaceable>
@@ -1035,11 +1024,11 @@ set nbns 203.14.100.5</programlisting>
 	</sect2>
 
       <sect2 id="userppp-nat">
-	<title>Using PPP Network Address Translation
+	<title>Using <acronym>PPP</acronym> Network Address Translation
 	  Capability</title>
 
 	<indexterm>
-	  <primary>PPP</primary><secondary>NAT</secondary>
+	  <primary><acronym>PPP</acronym></primary><secondary>NAT</secondary>
 	</indexterm>
 
 	<para>PPP has ability to use internal NAT without kernel
@@ -1049,7 +1038,7 @@ set nbns 203.14.100.5</programlisting>
 
 	<programlisting>nat enable yes</programlisting>
 
-	<para>Alternatively, PPP NAT may be enabled by command-line
+	<para>Alternatively, NAT may be enabled by command-line
 	  option <literal>-nat</literal>. There is also
 	  <filename>/etc/rc.conf</filename> knob named
 	  <literal>ppp_nat</literal>, which is enabled by
@@ -1071,7 +1060,7 @@ nat port tcp 10.0.0.2:http http</program
 	<title>Final System Configuration</title>
 
 	<indexterm>
-	  <primary>PPP</primary><secondary>configuration</secondary>
+	  <primary><acronym>PPP</acronym></primary><secondary>configuration</secondary>
 	</indexterm>
 
 	<para>You now have <command>ppp</command> configured, but
@@ -1167,7 +1156,7 @@ ifconfig_tun0=</programlisting>
 	<screen>&prompt.root; <userinput>ppp</userinput></screen>
 
 	<para>and then <command>dial provider</command> to start the
-	  PPP session, or, if you want <command>ppp</command> to
+	  <acronym>PPP</acronym> session, or, if you want <command>ppp</command> to
 	  establish sessions automatically when there is outbound
 	  traffic (and you have not created the
 	  <filename>start_if.tun0</filename> script), type:</para>
@@ -1281,12 +1270,12 @@ ifconfig_tun0=</programlisting>
     <title>Troubleshooting <acronym>PPP</acronym> Connections</title>
 
     <indexterm>
-      <primary>PPP</primary>
+      <primary><acronym>PPP</acronym></primary>
       <secondary>troubleshooting</secondary>
     </indexterm>
 
     <para>This section covers a few issues which may arise when
-      using PPP over a modem connection.  For instance, perhaps you
+      using <acronym>PPP</acronym> over a modem connection.  For instance, perhaps you
       need to know exactly what prompts the system you are dialing
       into will present.  Some <acronym>ISP</acronym>s present the
       <literal>ssword</literal> prompt, and others will present
@@ -1549,14 +1538,14 @@ nameserver <replaceable>y.y.y.y</replace
       </authorgroup>
     </sect1info>
     -->
-    <title>Using PPP over Ethernet (PPPoE)</title>
+    <title>Using <acronym>PPP</acronym> over Ethernet (PPPoE)</title>
 
     <indexterm>
-      <primary>PPP</primary>
+      <primary><acronym>PPP</acronym></primary>
       <secondary>over Ethernet</secondary>
     </indexterm>
 
-    <para>This section describes how to set up PPP over Ethernet
+    <para>This section describes how to set up <acronym>PPP</acronym> over Ethernet
       (<acronym>PPPoE</acronym>).</para>
 
       <para>Here is an example of a working
@@ -1601,10 +1590,8 @@ ppp_profile="name_of_service_provider"</
 	you cannot locate it there, ask your ISP's tech support
 	personnel.</para>
 
-      <para>As a last resort, you could try the method suggested by
-	the <ulink url="http://www.roaringpenguin.com/pppoe/">Roaring
-	Penguin PPPoE</ulink> program which can be found in the <link
-	linkend="ports">Ports Collection</link>.  Bear in mind
+      <para>As a last resort, you could try installing
+	the <filename role="package">net/rr-pppoe</filename> package or port.  Bear in mind
 	however, this may de-program your modem and render it useless,
 	so think twice before doing it.  Simply install the program
 	shipped with the modem by your provider.  Then, access the
@@ -1627,7 +1614,7 @@ ppp_profile="name_of_service_provider"</
 
       <para>For additional information, refer to <ulink
 	      url="http://renaud.waldura.com/doc/freebsd/pppoe/">Cheaper
-	    Broadband with FreeBSD on DSL</ulink> by Renaud
+	    Broadband with &os; on DSL</ulink> by Renaud
 	    Waldura.</para>
     </sect2>
 
@@ -1639,7 +1626,7 @@ ppp_profile="name_of_service_provider"</
 
       <para>This modem does not follow <ulink
 	  url="http://www.faqs.org/rfcs/rfc2516.html">RFC 2516</ulink>
-	(<emphasis>A Method for transmitting PPP over Ethernet
+	(<emphasis>A Method for transmitting <acronym>PPP</acronym> over Ethernet
 	(PPPoE)</emphasis>, written by L. Mamakos, K. Lidl, J. Evarts,
 	D. Carrel, D. Simone, and R. Wheeler).  Instead, different
 	packet type codes have been used for the Ethernet frames.
@@ -1647,7 +1634,7 @@ ppp_profile="name_of_service_provider"</
 	  url="http://www.3com.com/">3Com</ulink> if you think it
 	should comply with the PPPoE specification.</para>
 
-      <para>In order to make FreeBSD capable of communicating with
+      <para>In order to make &os; capable of communicating with
 	this device, a sysctl must be set.  This can be done
 	automatically at boot time by updating
 	<filename>/etc/sysctl.conf</filename>:</para>
@@ -1671,30 +1658,29 @@ ppp_profile="name_of_service_provider"</
       (PPPoA)</title>
 
     <indexterm>
-      <primary>PPP</primary>
+      <primary><acronym>PPP</acronym></primary>
       <secondary>over ATM</secondary>
     </indexterm>
 
     <indexterm>
       <primary>PPPoA</primary>
-      <see>PPP, over ATM</see>
     </indexterm>
 
     <para>The following describes how to set up PPP over ATM (PPPoA).
       PPPoA is a popular choice among European DSL providers.</para>
-
+<!--
+This port is broken as of June, 2009
     <sect2>
       <title>Using PPPoA with the Alcatel &speedtouch; USB</title>
 
       <para>PPPoA support for this device is supplied as a port in
-	FreeBSD because the firmware is distributed under <ulink
+	&os; because the firmware is distributed under <ulink
 	url="http://www.speedtouchdsl.com/disclaimer_lx.htm">Alcatel's
 	license agreement</ulink> and can not be redistributed freely
-	with the base system of FreeBSD.</para>
+	with the base system of &os;.</para>
 
-      <para>To install the software, simply use the <link
-	  linkend="ports">Ports Collection</link>. Install the
-	<filename role="package">net/pppoa</filename> port and follow
+      <para>This software can be installed using the
+	<filename role="package">net/pppoa</filename> package or port.  Once installed, follow
 	the instructions provided with it.</para>
 
       <para>Like many USB devices, the Alcatel &speedtouch; USB needs
@@ -1733,6 +1719,7 @@ ppp_profile="adsl"</programlisting>
 	sample <filename>ppp.conf</filename> which is supplied with
 	the <filename role="package">net/pppoa</filename> port.</para>
     </sect2>
+    -->
 
     <sect2>
       <title>Using mpd</title>
@@ -1740,7 +1727,7 @@ ppp_profile="adsl"</programlisting>
       <para>You can use <application>mpd</application> to connect to a
 	variety of services, in particular PPTP services.  You can
 	find <application>mpd</application> in the Ports Collection,
-	<filename role="package">net/mpd</filename>.  Many ADSL modems
+	<filename role="package">net/mpd5</filename>.  Many ADSL modems
 	require that a PPTP tunnel is created between the modem and
 	computer, one such modem is the Alcatel &speedtouch;
 	Home.</para>
@@ -1849,7 +1836,7 @@ ng0: flags=88d1<UP,POINTOPOINT,RUNNIN
   <sect2>
     <title>Using pptpclient</title>
 
-    <para>It is also possible to use FreeBSD to connect to other
+    <para>It is also possible to use &os; to connect to other
       PPPoA services using <filename
 	role="package">net/pptpclient</filename>.</para>
 
@@ -1896,13 +1883,13 @@ ng0: flags=88d1<UP,POINTOPOINT,RUNNIN
 
       </warning>
 
-      <para>This will open a tunnel for a PPP session to your DSL
+      <para>This will open a tunnel for a <acronym>PPP</acronym> session to your DSL
 	router.  Ethernet DSL modems have a preconfigured LAN IP
 	address which you connect to.  In the case of the Alcatel
 	&speedtouch; Home this address is <hostid
 	  role="ipaddr">10.0.0.138</hostid>. Your router
 	documentation should tell you which address your device
-	uses.  To open the tunnel and start a PPP session execute
+	uses.  To open the tunnel and start a <acronym>PPP</acronym> session execute
 	the following command:</para>
 
       <screen>&prompt.root; <userinput>pptp <replaceable>address</replaceable> <replaceable>adsl</replaceable></userinput></screen>


More information about the svn-doc-all mailing list