os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Change <filename> tags to <port> when the documentation is referring

Browse source 
to ports as in the FreeBSD Ports Collection.

As pointed out by Nik and others, the <port> tag is not the best way
to mark up Ports Collection ports.  However, for the present it is
the best we have, and the least we can do is be consistent in its
usage :)

Approved as a temp "best current practice" measure by:	bmah, -doc
This commit is contained in:
Peter Pentchev 2002-01-18 07:57:33 +00:00
parent 1061f40e60
commit 0837dba788
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=11741
9 changed files with 42 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
en_US.ISO8859-1/books/faq/book.sgml
View file

@ -815,7 +815,7 @@
<entry>The Zip format. If you want to uncompress
this on FreeBSD you will need to install the
<filename>archivers/unzip</filename> port
<port>archivers/unzip</port> port
first.</entry>
</row>
@ -832,7 +832,7 @@
<entry>The BZip2 format. Less widespread than the
others, but generally gives smaller files.
Install the <filename>archivers/bzip2</filename>
Install the <port>archivers/bzip2</port>
port to uncompress these files.</entry>
</row>
</tbody>
@ -3325,9 +3325,9 @@ diff -u -r1.60.2.1 -r1.60.2.2
<answer>
<para>FreeBSD supports many software modems via add-on
software. The <filename>comms/ltmdm</filename> port adds
software. The <port>comms/ltmdm</port> port adds
support for modems based on the very popular Lucent LT
chipset. The <filename>comms/mwavem</filename> port
chipset. The <port>comms/mwavem</port> port
supports the modem in IBM Thinkpad 600 and 700
laptops.</para>
@ -3752,7 +3752,7 @@ quit</programlisting>
special hook has been added into the CD9660 driver to allow the
user to load an appropriate conversion table on the fly.
Modules for some of the common encodings are available via the
<filename>sysutils/cd9660_unicode</filename> port.</para>
<port>sysutils/cd9660_unicode</port> port.</para>
</answer>
</qandaentry>
@ -3819,7 +3819,7 @@ quit</programlisting>
<command>mount</command> only works on filesystems. Audio
CDs do not have filesystems; they just have data. You
need a program that reads audio CDs, such as the
<filename>audio/xmcd</filename> port.</para>
<port>audio/xmcd</port> port.</para>
</answer>
</qandaentry>

4
en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml
View file

@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml,v 1.5 2001/08/29 00:34:27 nik Exp $
$FreeBSD$
-->
<appendix id="examples">
@ -153,7 +153,7 @@
<title>Producing formatted output</title>
<para>This section assumes that you have installed the software listed in
the <filename>textproc/docproj</filename> port, either by hand, or by
the <port>textproc/docproj</port> port, either by hand, or by
using the port. Further, it is assumed that your software is installed
in subdirectories under <filename>/usr/local/</filename>, and the
directory where binaries have been installed is in your

2
en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
View file

@ -176,7 +176,7 @@
<procedure>
<step>
<para>Install the <filename>textproc/docproj</filename>
<para>Install the <port>textproc/docproj</port>
meta-port.</para>
<screen>&prompt.root; <userinput>cd /usr/ports/textproc/docproj</userinput>

12
en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
View file

@ -80,8 +80,8 @@
<emphasis>loose</emphasis> variants).</para>
<para>The HTML DTDs are available from the ports collection in the
<filename>textproc/html</filename> port. They are automatically
installed as part of the <filename>textproc/docproj</filename>
<port>textproc/html</port> port. They are automatically
installed as part of the <port>textproc/docproj</port>
port.</para>
<sect2>
@ -677,8 +677,8 @@
</note>
<para>The DocBook DTD is available from the ports collection in the
<filename>textproc/docbook</filename> port. It is automatically
installed as part of the <filename>textproc/docproj</filename>
<port>textproc/docbook</port> port. It is automatically
installed as part of the <port>textproc/docproj</port>
port.</para>
<sect2>
@ -2231,12 +2231,12 @@ This is the file called 'foo2'</screen>
change, but that is not guaranteed.</para>
<para>You will also need to install the
<filename>graphics/ImageMagick</filename> port, which is used to
<port>graphics/ImageMagick</port> port, which is used to
convert between the different image formats. This is a big port,
and most of it is not required. However, while we are working on the
<filename>Makefile</filename>s and other infrastructure it makes
things easier. This port is <emphasis>not</emphasis> in the
<filename>textproc/docproj</filename> meta port, you must install it
<port>textproc/docproj</port> meta port, you must install it
by hand.</para>
<para>The best example of what follows in practice is the

6
en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
View file

@ -332,7 +332,7 @@
<procedure>
<step>
<para>Download and install <filename>textproc/docproj</filename>
<para>Download and install <port>textproc/docproj</port>
from the FreeBSD ports system. This is a
<emphasis>meta-port</emphasis> that should download and install
all of the programs and supporting files that are used by the
@ -396,7 +396,7 @@ setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES</
<step>
<para>Try and validate this file using an SGML parser.</para>
<para>Part of <filename>textproc/docproj</filename> is the
<para>Part of <port>textproc/docproj</port> is the
&man.nsgmls.1; <link linkend="sgml-primer-validating">validating
parser</link>. Normally, &man.nsgmls.1; reads in a document
marked up according to an SGML DTD and returns a copy of the
@ -699,7 +699,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>Look at the contents of
<filename>/usr/local/share/sgml/html/catalog</filename>. This is
the catalog file for the HTML DTDs that will have been installed as
part of the <filename>textproc/docproj</filename> port.</para>
part of the <port>textproc/docproj</port> port.</para>
</sect3>
<sect3>

2
en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml
View file

@ -48,7 +48,7 @@
Norm Walsh's modular DocBook stylesheets.</para>
<para>These can be found in
<filename>textproc/dsssl-docbook-modular</filename>.</para>
<port>textproc/dsssl-docbook-modular</port>.</para>
<para>The modified stylesheets are not in the ports system. Instead they
are part of the Documentation Project source repository, and can be

32
en_US.ISO8859-1/books/fdp-primer/tools/chapter.sgml
View file

@ -47,10 +47,10 @@
tools is covered in later chapters.</para>
<tip>
<title>Use <filename>textproc/docproj</filename> if possible</title>
<title>Use <port>textproc/docproj</port> if possible</title>
<para>You can save yourself a lot of time if you install the
<filename>textproc/docproj</filename> port. This is a
<port>textproc/docproj</port> port. This is a
<emphasis>meta-port</emphasis> which does not contain any software
itself. Instead, it depends on various other ports being installed
correctly. Installing this port <emphasis>should</emphasis>
@ -84,12 +84,12 @@
<para>These programs are required before you can usefully work with the
FreeBSD documentation, and they will allow you to convert the
documentation to HTML, plain text, and RTF formats. They are all
included in <filename>textproc/docproj</filename>.</para>
included in <port>textproc/docproj</port>.</para>
<variablelist>
<varlistentry>
<term><application>SP</application>
(<filename>textproc/sp</filename>)</term>
(<port>textproc/sp</port>)</term>
<listitem>
<para>A suite of applications, including a validating SGML parser,
@ -99,7 +99,7 @@
<varlistentry>
<term><application>Jade</application>
(<filename>textproc/jade</filename>)</term>
(<port>textproc/jade</port>)</term>
<listitem>
<para>A DSSSL implementation. Used for converting marked up
@ -109,7 +109,7 @@
<varlistentry>
<term><application>Tidy</application>
(<filename>www/tidy</filename>)</term>
(<port>www/tidy</port>)</term>
<listitem>
<para>An HTML 'pretty printer', used to reformat some of the
@ -120,7 +120,7 @@
<varlistentry>
<term><application>Links</application>
(<filename>www/links</filename>)</term>
(<port>www/links</port>)</term>
<listitem>
<para>A text-mode WWW browser, &man.links.1; can also convert
@ -130,7 +130,7 @@
<varlistentry>
<term><application>peps</application>
(<filename>graphics/peps</filename>)</term>
(<port>graphics/peps</port>)</term>
<listitem>
<para>Some of the documentation includes images, some of which are
@ -149,7 +149,7 @@
<variablelist>
<varlistentry>
<term>HTML DTD (<filename>textproc/html</filename>)</term>
<term>HTML DTD (<port>textproc/html</port>)</term>
<listitem>
<para>HTML is the markup language of choice for the World Wide
@ -158,7 +158,7 @@
</varlistentry>
<varlistentry>
<term>DocBook DTD (<filename>textproc/docbook</filename>)</term>
<term>DocBook DTD (<port>textproc/docbook</port>)</term>
<listitem>
<para>DocBook is designed for marking up technical documentation.
@ -168,7 +168,7 @@
<varlistentry>
<term>ISO 8879 entities
(<filename>textproc/iso8879</filename>)</term>
(<port>textproc/iso8879</port>)</term>
<listitem>
<para>19 of the ISO 8879:1986 character entity sets used by many
@ -189,7 +189,7 @@
<variablelist>
<varlistentry>
<term>Modular DocBook Stylesheets
(<filename>textproc/dsssl-docbook-modular</filename>)</term>
(<port>textproc/dsssl-docbook-modular</port>)</term>
<listitem>
<para>The Modular DocBook Stylesheets are used when converting
@ -216,8 +216,8 @@
<varlistentry>
<term><application>JadeTeX</application> and
<application>teTeX</application>
(<filename>print/jadetex</filename> and
<filename>print/teTeX</filename>)</term>
(<port>print/jadetex</port> and
<port>print/teTeX</port>)</term>
<listitem>
<para><application>Jade</application> and
@ -249,8 +249,8 @@
<varlistentry>
<term><application>Emacs</application> or
<application>xemacs</application>
(<filename>editors/emacs</filename> or
<filename>editors/xemacs</filename>)</term>
(<port>editors/emacs</port> or
<port>editors/xemacs</port>)</term>
<listitem>
<para>Both these editors include a special mode for editing

2
en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml
View file

@ -371,7 +371,7 @@
entity, and a semi-colon (;).</para>
<para>The entity names are defined in ISO8879, which is in the ports
tree as <filename>textproc/iso8879</filename>.</para>
tree as <port>textproc/iso8879</port>.</para>
<para>A few examples include</para>

12
en_US.ISO8859-1/books/porters-handbook/book.sgml
View file

@ -1595,7 +1595,7 @@ RESOLUTION?= 300
@${FALSE}
.endif</programlisting>
<para><filename>japanese/xdvi300</filename> also has all the regular
<para><port>japanese/xdvi300</port> also has all the regular
patches, package files, etc. If you type <command>make</command>
there, it will take the default value for the resolution (300) and
build the port normally.</para>
@ -1738,7 +1738,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
<para>There are many programs that require a Motif library (available
from several commercial vendors, while there is a free clone reported
to be able to run many applications in
<filename>x11-toolkits/lesstif</filename>) to compile. Since it is a
<port>x11-toolkits/lesstif</port>) to compile. Since it is a
popular toolkit and their licenses usually permit redistribution of
statically linked binaries, we have made special provisions for
handling ports that require Motif in a way that we can easily compile
@ -1834,7 +1834,7 @@ Options:
<para>Here's a seven-step procedure to convert ports to use
<command>install-info</command>.
<filename>editors/emacs</filename> will be used as an
<port>editors/emacs</port> will be used as an
example.</para>
<procedure>
@ -1886,7 +1886,7 @@ Options:
to use the extra arguments to <command>install-info</command>
because <command>makeinfo</command> cannot handle those texinfo
sources. (See <filename>Makefile</filename> and
<filename>pkg-plist</filename> of <filename>japanese/skk</filename>
<filename>pkg-plist</filename> of <port>japanese/skk</port>
for examples on how to do this).</para>
</step>
@ -3534,12 +3534,12 @@ lib/X11/oneko/sounds/cat.au
<para>If your port requires a certain user to be on the installed
system, let the <filename>pkg-install</filename> script call
<command>pw</command> to create it automatically. Look at
<filename>net/cvsup-mirror</filename> for an example.</para>
<port>net/cvsup-mirror</port> for an example.</para>
<para>If your port must use the same user/group ID number when it is
installed as a binary package as when it was compiled, then you must
choose a free UID from 50 to 999 and register it below. Look at
<filename>japanese/Wnn</filename> for an example.</para>
<port>japanese/Wnn</port> for an example.</para>
<para>Make sure you do not use a UID already used by the system or
other ports. This is the current list of UIDs between 50 and