From owner-freebsd-doc  Mon Nov 12 11:20: 8 2001
Delivered-To: freebsd-doc@freebsd.org
Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 12A5A37B416
	for <freebsd-doc@freebsd.org>; Mon, 12 Nov 2001 11:20:01 -0800 (PST)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.11.4/8.11.4) id fACJK1Y85876;
	Mon, 12 Nov 2001 11:20:01 -0800 (PST)
	(envelope-from gnats)
Received: from blackhelicopters.org (geburah.blackhelicopters.org [209.69.178.18])
	by hub.freebsd.org (Postfix) with ESMTP id 0EBF837B417
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 12 Nov 2001 11:18:32 -0800 (PST)
Received: (from mwlucas@localhost)
	by blackhelicopters.org (8.9.3/8.9.3) id OAA29898;
	Mon, 12 Nov 2001 14:18:31 -0500 (EST)
	(envelope-from mwlucas)
Message-Id: <200111121918.OAA29898@blackhelicopters.org>
Date: Mon, 12 Nov 2001 14:18:31 -0500 (EST)
From: mwlucas@blackhelicopters.org
Reply-To: mwlucas@blackhelicopters.org
To: FreeBSD-gnats-submit@freebsd.org
X-Send-Pr-Version: 3.2
Subject: docs/31934: port tag not in FDP
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org


>Number:         31934
>Category:       docs
>Synopsis:       port tag not in FDP
>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:   Mon Nov 12 11:20:00 PST 2001
>Closed-Date:
>Last-Modified:
>Originator:     Michael Lucas
>Release:        FreeBSD 3.5-STABLE i386
>Organization:
None
>Environment:

today's -doc tree

>Description:

The <port> tag was not documented in the FDP.  This made some of my
earlier patches less than perfect.

>How-To-Repeat:


>Fix:

*** en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml-dist	Mon Nov 12 11:21:53 2001
--- en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml	Mon Nov 12 14:12:43 2001
***************
*** 2165,2170 ****
--- 2165,2193 ----
  	    value for <replaceable>n</replaceable>.</para>	  
  	</example>
        </sect3>
+ 
+       <sect3>
+         <title>The name of ports</title>
+ 	
+         <para>You might need to include the name of a program from the
+           FreeBSD Ports Collection in the documentation.  Use the
+           <sgmltag>port</sgmltag> tag to identify these.  Since ports
+           can be installed in any number of locations, only include
+           the category and the port name; do not include
+           <filename>/usr/ports</filename>.</para>
+ 
+         <example>
+           <title><sgmltag>portname</sgmltag></title>
+ 
+           <para>Use:</para>
+ 
+           <programlisting><![ CDATA [<para>Install <port>net/ethereal</literal> to view network traffic.</para>]]></programlisting>
+ 
+           <para>Appearance:</para>
+ 	  
+           <para>Install <port>net/ethereal</port> to view network traffic.</para>
+         </example>
+       </sect3>
      </sect2>
  
      <sect2>
>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message