Date: Tue, 3 Apr 2001 18:10:02 -0700 (PDT) From: Dima Dorfman <dima@unixfreak.org> To: freebsd-doc@freebsd.org Subject: Re: docs/26293: Just add detail on the tutorial Message-ID: <200104040110.f341A2a74877@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/26293; it has been noted by GNATS.
From: Dima Dorfman <dima@unixfreak.org>
To: Brian Somers <brian@Awfulhak.org>
Cc: jrcharron@gen-int.com, freebsd-gnats-submit@freebsd.org
Subject: Re: docs/26293: Just add detail on the tutorial
Date: Tue, 03 Apr 2001 18:02:19 -0700
Brian Somers <brian@Awfulhak.org> writes:
> > jrcharron@gen-int.com writes:
> > > [ commands must be indented in ppp.conf ]
> >
> > Brain, can you confirm that this is indeed the intended behavior, and
> > not a bug? If that's the case, I'll update the docs to mention this
> > (unless you want to do it).
>
> Yes, all lines that are not labels should be indented by at least one
> space or tab. This is documented, but now that I look through the
> docs, it seems it's not very clear (it's surprising what you can take
> for granted!!!).
I think it's pretty clear where it's mentioned, but it's not mentioned
in share/examples/ppp.conf.sample, or the PPP Primer, which is
probably what most people read. Below are patches to those two. I'd
appreciate if you'd check them to make sure they're not spreading
misinformation (I don't use ppp on a daily basis).
Thanks,
Dima Dorfman
dima@unixfreak.org
Index: ppp.conf.sample
===================================================================
RCS file: /st/src/FreeBSD/src/share/examples/ppp/ppp.conf.sample,v
retrieving revision 1.22
diff -u -r1.22 ppp.conf.sample
--- ppp.conf.sample 2000/12/01 11:52:22 1.22
+++ ppp.conf.sample 2001/04/04 00:58:15
@@ -11,7 +11,8 @@
# This file is separated into sections. Each section is named with
# a label starting in column 0 and followed directly by a ``:''. The
# section continues until the next section. Blank lines and lines
-# beginning with ``#'' are ignored.
+# beginning with ``#'' are ignored. All commands inside sections *must*
+# be indented by at least one space or tab or they will not be recognized!
#
# Lines beginning with "!include" will ``include'' another file. You
# may want to ``!include ~/.ppp.conf'' for backwards compatibility.
Index: book.sgml
===================================================================
RCS file: /st/src/FreeBSD/doc/en_US.ISO_8859-1/books/ppp-primer/book.sgml,v
retrieving revision 1.6
diff -u -r1.6 book.sgml
--- book.sgml 2001/01/17 07:22:10 1.6
+++ book.sgml 2001/04/04 00:58:29
@@ -772,6 +772,15 @@
<para>Below is the /etc/ppp/ppp.conf file that we'll be using to provide a
dial-out Internet gateway for our example LAN:
+
+<note>
+ <para>The full syntax for <filename>ppp.conf</filename> is described in
+ &man.ppp.8;. Particuarly, note that any line that isn't a label that
+ ends with a colon (e.g., <literal>default:</literal>,
+ <literal>interactive:</literal>) or a comment <emphasis>must</emphasis>
+ be indented!</para>
+</note>
+
<programlisting>
################################################################
# PPP Configuration File ('/etc/ppp/ppp.conf')
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200104040110.f341A2a74877>