Date: Mon, 12 Nov 2001 14:18:31 -0500 (EST) From: mwlucas@blackhelicopters.org To: FreeBSD-gnats-submit@freebsd.org Subject: docs/31934: port tag not in FDP Message-ID: <200111121918.OAA29898@blackhelicopters.org>
next in thread | raw e-mail | index | archive | help
>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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200111121918.OAA29898>