Document "port" tag. From the PR, but with the text moved to a more

suitable section (DocBook vs. HTML section) and with an explanatory
note that this element is a FreeBSD extension to DocBook.

PR:		31934
Submitted by:	mwlucas@blackhelicopters.org
This commit is contained in:
Bruce A. Mah 2001-11-13 18:07:39 +00:00
parent edf26dccd4
commit 7abba1b857
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=11193

View file

@ -1801,6 +1801,36 @@ This is the file called 'foo2'</screen>
</example>
</sect3>
<sect3>
<title>The name of ports</title>
<note>
<title>FreeBSD extension</title>
<para>These elements are part of the FreeBSD extension to DocBook,
and do not exist in the original DocBook DTD.</para>
</note>
<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</port> to view network traffic.</para>]]></programlisting>
<para>Appearance:</para>
<para>Install <port>net/ethereal</port> to view network traffic.</para>
</example>
</sect3>
<sect3>
<title>Devices</title>