Date: Tue, 6 May 2008 20:11:18 +0200 From: "Gabor PALI" <pgj@FreeBSD.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/123473: [patch] Replace Old-Style Replaceables with <replaceable> Markups in Handbook Chapter 25 Message-ID: <48209f48.25e2660a.1890.ffffbf8f@mx.google.com> Resent-Message-ID: <200805061820.m46IK1lh009763@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 123473
>Category: docs
>Synopsis: [patch] Replace Old-Style Replaceables with <replaceable> Markups in Handbook Chapter 25
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Tue May 06 18:20:01 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator: Gabor PALI
>Release: FreeBSD 6.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD disznohal 6.3-STABLE FreeBSD 6.3-STABLE #4: Fri Apr 4 23:29:43 CEST 2008 dezzy@disznohal:/usr/obj/usr/src/sys/GENERIC_ i386
>Description:
I found some old fashioned replaceables (enclosed by > and
< entities) in the FreeBSD Handbook, Chapter 25 (``PPP and
SLIP''). I think they should be replaced with <replaceable>
markups, so I created a patch to implement this.
>How-To-Repeat:
>Fix:
--- ppp-and-slip.patch.3.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.sgml,v
retrieving revision 1.177
diff -u -r1.177 chapter.sgml
--- chapter.sgml 3 Feb 2008 23:12:02 -0000 1.177
+++ chapter.sgml 6 May 2008 04:09:11 -0000
@@ -1324,10 +1324,10 @@
passive # wait for LCP packets
domain ppp.foo.com # put your domain name here
-:<remote_ip> # put the IP of remote PPP host here
+:<replaceable>remote_ip</replaceable> # put the IP of remote PPP host here
# it will be used to route packets via PPP link
# if you didn't specified the noipdefault option
- # change this line to <local_ip>:<remote_ip>
+ # change this line to <replaceable>local_ip</replaceable>:<replaceable>remote_ip</replaceable>
defaultroute # put this if you want that PPP server will be your
# default router</programlisting>
@@ -1468,12 +1468,12 @@
# if the remote host doesn't send your IP during
# IPCP negotiation, remove this option
passive # wait for LCP packets
-domain <your.domain> # put your domain name here
+domain <replaceable>your.domain</replaceable> # put your domain name here
: # put the IP of remote PPP host here
# it will be used to route packets via PPP link
# if you didn't specified the noipdefault option
- # change this line to <local_ip>:<remote_ip>
+ # change this line to <replaceable>local_ip</replaceable>:<replaceable>remote_ip</replaceable>
defaultroute # put this if you want that PPP server will be
# your default router</programlisting>
@@ -1484,9 +1484,9 @@
<para>The following should go on a single line.</para>
</note>
- <programlisting>ABORT BUSY ABORT 'NO CARRIER' "" AT OK ATDT<phone.number>
- CONNECT "" TIMEOUT 10 ogin:-\\r-ogin: <login-id>
- TIMEOUT 5 sword: <password></programlisting>
+ <programlisting>ABORT BUSY ABORT 'NO CARRIER' "" AT OK ATDT<replaceable>phone.number</replaceable>
+ CONNECT "" TIMEOUT 10 ogin:-\\r-ogin: <replaceable>login-id</replaceable>
+ TIMEOUT 5 sword: <replaceable>password</replaceable></programlisting>
<para>Once these are installed and modified correctly, all you need
to do is run <command>pppd</command>, like so:</para>
--- ppp-and-slip.patch.3.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?48209f48.25e2660a.1890.ffffbf8f>