Bug 79667

Summary: Some sections of the handbook refer to /etc/ppp/ppp.conf and others just ppp.conf This patch makes it consistant throughout
Product: Documentation Reporter: Josh Paetzel <josh> <josh>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Josh Paetzel <josh@tcbug.org> 2005-04-08 03:50:03 UTC

http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ppp-and-slip.html   uses ppp.conf and /etc/ppp/ppp.conf somewhat haphazardly.   This patch makes the usage "uniform"

Fix: 

<para>Note that this command continues onto the next line
                    for readability.  Any command in
-                   <filename>ppp.conf</filename> may do this if the last
+                   <filename>/etc/ppp/ppp.conf</filename> may do this
+if the last
                    character on the line is a ``\'' character.</para>
              </listitem>
            </varlistentry>
@@ -587,7 +588,8 @@
            <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
+           <filename>/etc/ppp/ppp.conf</filename> configuration is the same
+as
            <link linkend="userppp-staticIP">PPP and Static IP
            Addresses</link>, with the following change:</para>

@@ -640,7 +642,7 @@
                  <command>ppp</command> will look for an entry in
                  <filename>ppp.linkup</filename> according to the
                  following rules: First, try to match the same label
-                 as we used in <filename>ppp.conf</filename>.  If
+                 as we used in <filename>/etc/ppp/ppp.conf</filename>.  If
                  that fails, look for an entry for the IP address of
                  our gateway.  This entry is a four-octet IP style
                  label.  If we still have not found an entry, look
@@ -808,7 +810,8 @@
          </sect4>

          <sect4>
-           <title>Setting Up <filename>ppp.conf</filename> for Dynamic-IP Users</title>
+           <title>Setting Up <filename>/etc/ppp/ppp.conf</filename> for
+Dynamic-IP Users</title>

            <para>The <filename>/etc/ppp/ppp.conf</filename> file should
              contain something along the lines of:</para>
@@ -838,7 +841,8 @@
          </sect4>

          <sect4>
-           <title>Setting Up <filename>ppp.conf</filename> for Static-IP
+           <title>Setting Up <filename>/etc/ppp/ppp.conf</filename> for
+Static-IP
              Users</title>

            <para>Along with the contents of the sample
@@ -2046,10 +2050,10 @@
     </sect2>

     <sect2>
-      <title>Setting Up <filename>ppp.conf</filename></title>
+      <title>Setting Up <filename>/etc/ppp/ppp.conf</filename></title>

       <para>Here is an example of a working
-        <filename>ppp.conf</filename>:</para>
+        <filename>/etc/ppp/ppp.conf</filename>:</para>

       <programlisting>default:
   set log Phase tun command # you can add more detailed logging if you wish
@@ -2109,7 +2113,8 @@
        <emphasis>ISP</emphasis>.</para>

       <para>The profile name (service tag) will be used in the PPPoE
-       configuration entry in <filename>ppp.conf</filename> as the provider
+       configuration entry in <filename>/etc/ppp/ppp.conf</filename> as the
+provider
        part of the <command>set device</command> command (see the &man.ppp.8;
        manual page for full details).  It should look like this:</para>

@@ -2226,7 +2231,8 @@
 ppp_profile="adsl"</programlisting>

      <para>For this to work correctly you will need to have used the
-       sample <filename>ppp.conf</filename> which is supplied with the
+       sample <filename>/etc/ppp/ppp.conf</filename> which is supplied
+with the
        <filename role="package">net/pppoa</filename> port.</para>

     </sect2>
@@ -2347,8 +2353,9 @@
        connect to a DSL service, install the port or package and edit your
        <filename>/etc/ppp/ppp.conf</filename>. You will need to be
        <username>root</username> to perform both of these operations. An
-       example section of <filename>ppp.conf</filename> is given
-       below. For further information on <filename>ppp.conf</filename>
+       example section of <filename>/etc/ppp/ppp.conf</filename> is given
+       below. For further information on
+<filename>/etc/ppp/ppp.conf</filename>
        options consult the <application>ppp</application> manual page,
        &man.ppp.8;.</para>

@@ -2372,7 +2379,8 @@

    <warning>
      <para>Because you must put your account's password in the
-        <filename>ppp.conf</filename> file in plain text form you should
+        <filename>/etc/ppp/ppp.conf</filename> file in plain text form you
+should
         make sure than nobody can read the contents of this file. The
         following series of commands will make sure the file is only
         readable by the <username>root</username> account. Refer to the--no3i912g6zPdYblI1BhfsJobFRbADy6uLfPEya87LL2xRYps
Content-Type: text/plain; name="file.diff"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="file.diff"

--- chapter.sgml.old    Thu Apr  7 21:27:10 2005
+++ chapter.sgml        Thu Apr  7 21:40:13 2005
@@ -193,7 +193,7 @@
              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
+             <filename>/etc/ppp/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>
@@ -401,7 +401,8 @@
Comment 1 Marc Fonvieille freebsd_committer freebsd_triage 2005-04-08 10:22:55 UTC
On Thu, Apr 07, 2005 at 09:48:55PM -0500, Josh Paetzel wrote:
> 
> >Number:         79667
> >Category:       docs
> >Synopsis:       Some sections of the handbook refer to /etc/ppp/ppp.conf and others just ppp.conf  This patch makes it consistant throughout
> >Confidential:   no
> >Severity:       non-critical
> >Priority:       low
> >Responsible:    freebsd-doc
> >State:          open
> >Quarter:        
> >Keywords:       
> >Date-Required:
> >Class:          change-request
> >Submitter-Id:   current-users
> >Arrival-Date:   Fri Apr 08 02:50:03 GMT 2005
> >Closed-Date:
> >Last-Modified:
> >Originator:     Josh Paetzel
> >Release:        FreeBSD 5.3-RELEASE-p8 i386
> >Organization:
> >Environment:
> 
> 
> System: FreeBSD 5.3-RELEASE-p8 #2: Wed Apr  6 18:08:11 CDT 2005
>     jpaetzel@twinmp.tcbug.org:/usr/obj/usr/src/sys/TWINMP
> 
> 
> 
> >Description:
> 
> 
> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ppp-and-slip.html
> uses ppp.conf and /etc/ppp/ppp.conf somewhat haphazardly.   This patch
> makes the usage "uniform"

The current usage in the Handbook is not inconsistent.
In the mentioned chapter the location of configuration files is clearly
stated:
"Both ppp and pppd (the kernel level implementation of PPP) use
the configuration files located in the /etc/ppp directory."

Then the 1st time ppp.conf is mentioned we have: "You will need to edit
the /etc/ppp/ppp.conf configuration file."
The following instances use both ppp.conf and /etc/ppp/ppp.conf, in the
same way we do for rc.conf and /etc/rc.conf, sendmail.cf, GENERIC, and
thousand of files.
Since the reader must read the beginning of the section with important
and "mandatory" explanations, he will know where is located ppp.conf
If the reader starts to read a section from the middle of it, we cannot
help...
I will evev add that having full path often leads to a "bloated" text.

Marc
Comment 2 Murray Stokely freebsd_committer freebsd_triage 2005-05-05 01:16:48 UTC
State Changed
From-To: open->closed

Sender agrees we should close this PR.