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

Round one of updates: style fixes.

Browse source 
PR:		docs/53420
Submitted by:	linimon
This commit is contained in:
Ceri Davies 2003-10-17 17:33:38 +00:00
parent 15c1c173f0
commit a2d61eb86a
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=18471
1 changed files with 64 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -69,8 +69,8 @@
This file uses a non-standard tab setting. This file uses a non-standard tab setting.
<application>Emacs</application> and <application>Emacs</application> and
<application>Vim</application> should recognize the setting on <application>Vim</application> should recognize the setting on
loading the file. Both <command>vi</command> and loading the file. Both &man.vi.1; and
<command>ex</command> can be set to use the correct value by &man.ex.1; can be set to use the correct value by
typing <command>:set tabstop=4</command> once the file has been typing <command>:set tabstop=4</command> once the file has been
loaded.</para> loaded.</para>
</note> </note>
@ -472,7 +472,7 @@ lib/X11/oneko/mouse.xpm
actions are done.</para> actions are done.</para>
<para>For example, if you have a <maketarget>post-extract</maketarget> <para>For example, if you have a <maketarget>post-extract</maketarget>
target defined in your Makefile, and a file target defined in your <filename>Makefile</filename>, and a file
<filename>pre-build</filename> in the <filename>scripts</filename> <filename>pre-build</filename> in the <filename>scripts</filename>
subdirectory, the <maketarget>post-extract</maketarget> target will subdirectory, the <maketarget>post-extract</maketarget> target will
be called after the regular extraction actions, and the be called after the regular extraction actions, and the
@ -583,8 +583,8 @@ lib/X11/oneko/mouse.xpm
<title>Patching</title> <title>Patching</title>
<para>In the preparation of the port, files that have been added or <para>In the preparation of the port, files that have been added or
changed can be picked up with a recursive diff for later feeding to changed can be picked up with a recursive &man.diff.1; for later feeding to
patch. Each set of patches you wish to apply should be collected &man.patch.1;. Each set of patches you wish to apply should be collected
into a file named into a file named
<filename>patch-<replaceable>*</replaceable></filename> where <filename>patch-<replaceable>*</replaceable></filename> where
<replaceable>*</replaceable> denotes the sequence in which the <replaceable>*</replaceable> denotes the sequence in which the
@ -611,10 +611,10 @@ lib/X11/oneko/mouse.xpm
<literal>&dollar;RCS</literal>.</para> <literal>&dollar;RCS</literal>.</para>
<para>Using the recurse (<option>-r</option>) option to <para>Using the recurse (<option>-r</option>) option to
<command>diff</command> to generate patches is fine, but please take &man.diff.1; to generate patches is fine, but please take
a look at the resulting patches to make sure you do not have any a look at the resulting patches to make sure you do not have any
unnecessary junk in there. In particular, diffs between two backup unnecessary junk in there. In particular, diffs between two backup
files, <filename>Makefiles</filename> when the port uses files, <filename>Makefile</filename>s when the port uses
<command>Imake</command> or GNU <command>configure</command>, etc., <command>Imake</command> or GNU <command>configure</command>, etc.,
are unnecessary and should be deleted. If you had to edit are unnecessary and should be deleted. If you had to edit
<filename>configure.in</filename> and run <filename>configure.in</filename> and run
@ -645,7 +645,7 @@ lib/X11/oneko/mouse.xpm
<title>Handling user input</title> <title>Handling user input</title>
<para>If your port requires user input to build, configure, or install, <para>If your port requires user input to build, configure, or install,
then set <makevar>IS_INTERACTIVE</makevar> in your Makefile. This then set <makevar>IS_INTERACTIVE</makevar> in your <filename>Makefile</filename>. This
will allow <quote>overnight builds</quote> to skip your port if the will allow <quote>overnight builds</quote> to skip your port if the
user sets the variable <envar>BATCH</envar> in his environment (and user sets the variable <envar>BATCH</envar> in his environment (and
if the user sets the variable <envar>INTERACTIVE</envar>, then if the user sets the variable <envar>INTERACTIVE</envar>, then
@ -663,7 +663,7 @@ lib/X11/oneko/mouse.xpm
<chapter id="makefile"> <chapter id="makefile">
<title>Configuring the Makefile</title> <title>Configuring the Makefile</title>
<para>Configuring the Makefile is pretty simple, and again we suggest <para>Configuring the <filename>Makefile</filename> is pretty simple, and again we suggest
that you look at existing examples before starting. Also, there is a that you look at existing examples before starting. Also, there is a
<link linkend="porting-samplem">sample Makefile</link> in this <link linkend="porting-samplem">sample Makefile</link> in this
handbook, so take a look and please follow the ordering of variables handbook, so take a look and please follow the ordering of variables
@ -671,7 +671,7 @@ lib/X11/oneko/mouse.xpm
read.</para> read.</para>
<para>Now, consider the following problems in sequence as you design <para>Now, consider the following problems in sequence as you design
your new Makefile:</para> your new <filename>Makefile</filename>:</para>
<sect1 id="makefile-source"> <sect1 id="makefile-source">
<title>The original source</title> <title>The original source</title>
@ -728,7 +728,7 @@ lib/X11/oneko/mouse.xpm
affects the content or structure of the derived affects the content or structure of the derived
package.</para> package.</para>
<para>Examples of when PORTREVISION should be bumped:</para> <para>Examples of when <makevar>PORTREVISION</makevar> should be bumped:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -738,7 +738,7 @@ lib/X11/oneko/mouse.xpm
</listitem> </listitem>
<listitem> <listitem>
<para>Changes to the port makefile to enable or disable <para>Changes to the port <filename>Makefile</filename> to enable or disable
compile-time options in the package.</para> compile-time options in the package.</para>
</listitem> </listitem>
@ -810,7 +810,7 @@ lib/X11/oneko/mouse.xpm
enhancement, fix, or by virtue that the new package will enhancement, fix, or by virtue that the new package will
actually work for them). If yes, the actually work for them). If yes, the
<makevar>PORTREVISION</makevar> should be bumped so that <makevar>PORTREVISION</makevar> should be bumped so that
automated tools (e.g. <command>pkg_version</command>) automated tools (e.g. &man.pkg.version.1;)
will highlight the fact that a new package is will highlight the fact that a new package is
available.</para> available.</para>
</sect3> </sect3>
@ -864,8 +864,8 @@ lib/X11/oneko/mouse.xpm
<title>Example of <makevar>PORTREVISION</makevar> and <title>Example of <makevar>PORTREVISION</makevar> and
<makevar>PORTEPOCH</makevar> usage</title> <makevar>PORTEPOCH</makevar> usage</title>
<para>The gtkmumble port, version 0.10, is committed to the <para>The <literal>gtkmumble</literal> port, version <literal>0.10</literal>, is committed to the
ports collection.</para> ports collection:</para>
<programlisting>PORTNAME= gtkmumble <programlisting>PORTNAME= gtkmumble
PORTVERSION= 0.10</programlisting> PORTVERSION= 0.10</programlisting>
@ -895,7 +895,7 @@ PORTREVISION= 1</programlisting>
force the new package to be detected as <quote>newer</quote>. Since it force the new package to be detected as <quote>newer</quote>. Since it
is a new vendor release of the code, is a new vendor release of the code,
<makevar>PORTREVISION</makevar> is reset to 0 (or removed <makevar>PORTREVISION</makevar> is reset to 0 (or removed
from the makefile).</para> from the <filename>Makefile</filename>).</para>
<programlisting>PORTNAME= gtkmumble <programlisting>PORTNAME= gtkmumble
PORTVERSION= 0.2 PORTVERSION= 0.2
@ -918,8 +918,8 @@ PORTEPOCH= 1</programlisting>
<note> <note>
<para>If <makevar>PORTEPOCH</makevar> were reset <para>If <makevar>PORTEPOCH</makevar> were reset
to <literal>0</literal> with this upgrade, someone who had to <literal>0</literal> with this upgrade, someone who had
installed the gtkmumble-0.10_1 package would not detect installed the <literal>gtkmumble-0.10_1</literal> package would not detect
the gtkmumble-0.3 package as newer, since the <literal>gtkmumble-0.3</literal> package as newer, since
<literal>3</literal> is still numerically less than <literal>3</literal> is still numerically less than
<literal>10</literal>.</para> <literal>10</literal>.</para>
</note> </note>
@ -941,7 +941,7 @@ PORTEPOCH= 1</programlisting>
hyphen (<literal>-</literal>) in hyphen (<literal>-</literal>) in
<makevar>PORTVERSION</makevar>. Also, if the package name <makevar>PORTVERSION</makevar>. Also, if the package name
has the <replaceable>language-</replaceable> or the has the <replaceable>language-</replaceable> or the
<replaceable>compiled.specifics</replaceable> part, use <replaceable>-compiled.specifics</replaceable> part, use
<makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make <makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make
them part of <makevar>PORTNAME</makevar>.</para> them part of <makevar>PORTNAME</makevar>.</para>
@ -987,7 +987,7 @@ PORTEPOCH= 1</programlisting>
should be lowercase. (The rest of the name can contain should be lowercase. (The rest of the name can contain
capital letters, so use your own discretion when you are capital letters, so use your own discretion when you are
converting a software name that has some capital letters in it.) converting a software name that has some capital letters in it.)
There is a tradition of naming Perl 5 modules by There is a tradition of naming <literal>perl 5</literal> modules by
prepending <literal>p5-</literal> and converting the double-colon prepending <literal>p5-</literal> and converting the double-colon
separator to a hyphen; for example, the separator to a hyphen; for example, the
<literal>Data::Dumper</literal> module becomes <literal>Data::Dumper</literal> module becomes
@ -1004,7 +1004,7 @@ PORTEPOCH= 1</programlisting>
the compiled-in defaults (the hyphen is optional). Examples are the compiled-in defaults (the hyphen is optional). Examples are
papersize and font units.</para> papersize and font units.</para>
<para>The <replaceable>compiled.specifics</replaceable> part <para>The <replaceable>-compiled.specifics</replaceable> part
should be set in the <makevar>PKGNAMESUFFIX</makevar> should be set in the <makevar>PKGNAMESUFFIX</makevar>
variable.</para> variable.</para>
</listitem> </listitem>
@ -1182,7 +1182,7 @@ PORTEPOCH= 1</programlisting>
<para>If there is absolutely no trace of version information in the <para>If there is absolutely no trace of version information in the
original source and it is unlikely that the original author will ever original source and it is unlikely that the original author will ever
release another version, just set the version string to release another version, just set the version string to
<literal>1.0</literal> (like the piewm example above). Otherwise, ask <literal>1.0</literal> (like the <literal>piewm</literal> example above). Otherwise, ask
the original author or use the date string the original author or use the date string
(<literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>) (<literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>)
as the version.</para> as the version.</para>
@ -1500,7 +1500,7 @@ PORTEPOCH= 1</programlisting>
<row> <row>
<entry><filename>perl5*</filename></entry> <entry><filename>perl5*</filename></entry>
<entry>Ports that require perl version 5 to run.</entry> <entry>Ports that require <literal>perl</literal> version 5 to run.</entry>
</row> </row>
<row> <row>
@ -1641,7 +1641,7 @@ PORTEPOCH= 1</programlisting>
<row> <row>
<entry><filename>windowmaker*</filename></entry> <entry><filename>windowmaker*</filename></entry>
<entry>Ports to support the WindowMaker window <entry>Ports to support the WindowMaker window
manager</entry> manager.</entry>
</row> </row>
<row> <row>
@ -2608,7 +2608,7 @@ PATCHFILES= patch1:test</programlisting>
<note> <note>
<para>This does not affect the <makevar>MASTER_SITES</makevar> you <para>This does not affect the <makevar>MASTER_SITES</makevar> you
define in your Makefile.</para> define in your <filename>Makefile</filename>.</para>
</note> </note>
</sect2> </sect2>
</sect1> </sect1>
@ -2680,7 +2680,7 @@ PATCHFILES= patch1:test</programlisting>
<maketarget>extract</maketarget> target and then from within the <maketarget>extract</maketarget> target and then from within the
<maketarget>install</maketarget> target. Also, the name of the <maketarget>install</maketarget> target. Also, the name of the
dependency is put into the package so that dependency is put into the package so that
<command>pkg_add</command> will automatically install it if it is &man.pkg.add.1; will automatically install it if it is
not on the user's system.</para> not on the user's system.</para>
</sect2> </sect2>
@ -2725,7 +2725,7 @@ PATCHFILES= patch1:test</programlisting>
<para>The dependency is checked from within the <para>The dependency is checked from within the
<maketarget>install</maketarget> target. Also, the name of the <maketarget>install</maketarget> target. Also, the name of the
dependency is put into the package so that dependency is put into the package so that
<command>pkg_add</command> will automatically install it if it is &man.pkg.add.1; will automatically install it if it is
not on the user's system. The <replaceable>target</replaceable> not on the user's system. The <replaceable>target</replaceable>
part can be omitted if it is the same as part can be omitted if it is the same as
<makevar>DEPENDS_TARGET</makevar>.</para> <makevar>DEPENDS_TARGET</makevar>.</para>
@ -2829,9 +2829,9 @@ PATCHFILES= patch1:test</programlisting>
<row> <row>
<entry><makevar>USE_PERL5</makevar></entry> <entry><makevar>USE_PERL5</makevar></entry>
<entry>The port requires Perl 5 to build and install. See <entry>The port requires <literal>perl 5</literal> to build and install. See
<xref linkend="using-perl"> for additional variables that <xref linkend="using-perl"> for additional variables that
can be set relating to Perl.</entry> can be set relating to <literal>perl</literal>.</entry>
</row> </row>
<row> <row>
@ -2903,8 +2903,8 @@ PATCHFILES= patch1:test</programlisting>
GNU autoconf to be run. Define <literal>USE_QT=yes</literal> if GNU autoconf to be run. Define <literal>USE_QT=yes</literal> if
your port uses the latest qt toolkit. Use your port uses the latest qt toolkit. Use
<literal>USE_PERL5=yes</literal> if your port requires version 5 <literal>USE_PERL5=yes</literal> if your port requires version 5
of the perl language. (The last is especially important since of the <literal>perl</literal> language. (The last is especially important since
some versions of FreeBSD have perl5 as part of the base system some versions of FreeBSD have <literal>perl5</literal> as part of the base system
while others do not.)</para> while others do not.)</para>
</sect2> </sect2>
@ -2935,7 +2935,7 @@ PATCHFILES= patch1:test</programlisting>
<programlisting>BUILD_DEPENDS= ${NONEXISTENT}:${PORTSDIR}/graphics/jpeg:extract</programlisting> <programlisting>BUILD_DEPENDS= ${NONEXISTENT}:${PORTSDIR}/graphics/jpeg:extract</programlisting>
will always descend to the JPEG port and extract it.</para> will always descend to the <literal>jpeg</literal> port and extract it.</para>
<para>Do not use <makevar>DEPENDS</makevar> unless there is no other <para>Do not use <makevar>DEPENDS</makevar> unless there is no other
way the behavior you want can be accomplished. It will cause the way the behavior you want can be accomplished. It will cause the
@ -3219,10 +3219,10 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting>
</sect1> </sect1>
<sect1 id="using-perl"> <sect1 id="using-perl">
<title>Using Perl</title> <title>Using <literal>perl</literal></title>
<table frame="none"> <table frame="none">
<title>Variables for ports that use Perl</title> <title>Variables for ports that use <literal>perl</literal></title>
<tgroup cols="2"> <tgroup cols="2">
<thead> <thead>
@ -3237,7 +3237,7 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting>
<row> <row>
<entry><makevar>USE_PERL5</makevar></entry> <entry><makevar>USE_PERL5</makevar></entry>
<entry>Says that the port uses Perl 5 to build and run.</entry> <entry>Says that the port uses <literal>perl 5</literal> to build and run.</entry>
</row> </row>
<row> <row>
@ -3260,28 +3260,28 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting>
<row> <row>
<entry><makevar>PERL_VERSION</makevar></entry> <entry><makevar>PERL_VERSION</makevar></entry>
<entry>The full version of Perl installed (e.g., <entry>The full version of <literal>perl</literal> installed (e.g.,
<literal>5.00503</literal>).</entry> <literal>5.00503</literal>).</entry>
</row> </row>
<row> <row>
<entry><makevar>PERL_VER</makevar></entry> <entry><makevar>PERL_VER</makevar></entry>
<entry>The short version of Perl installed (e.g., <entry>The short version of <literal>perl</literal> installed (e.g.,
<literal>5.005</literal>).</entry> <literal>5.005</literal>).</entry>
</row> </row>
<row> <row>
<entry><makevar>PERL_LEVEL</makevar></entry> <entry><makevar>PERL_LEVEL</makevar></entry>
<entry>The installed Perl version as an integer of the form MNNNPP <entry>The installed <literal>perl</literal> version as an integer of the form <literal>MNNNPP</literal>
(e.g., <literal>500503</literal>).</entry> (e.g., <literal>500503</literal>).</entry>
</row> </row>
<row> <row>
<entry><makevar>PERL_ARCH</makevar></entry> <entry><makevar>PERL_ARCH</makevar></entry>
<entry>Where Perl stores architecture dependent libraries. <entry>Where <literal>perl</literal> stores architecture dependent libraries.
Defaults to <literal>${ARCH}-freebsd</literal>.</entry> Defaults to <literal>${ARCH}-freebsd</literal>.</entry>
</row> </row>
</tbody> </tbody>
@ -3751,7 +3751,7 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting>
<sect1> <sect1>
<title><makevar>LIB_DEPENDS</makevar></title> <title><makevar>LIB_DEPENDS</makevar></title>
<para>All port Makefiles are edited to remove minor numbers from <para>All port <filename>Makefile</filename>s are edited to remove minor numbers from
<makevar>LIB_DEPENDS</makevar>, and also to have the regexp support <makevar>LIB_DEPENDS</makevar>, and also to have the regexp support
removed. (E.g., <literal>foo\\.1\\.\\(33|40\\)</literal> becomes removed. (E.g., <literal>foo\\.1\\.\\(33|40\\)</literal> becomes
<literal>foo.2</literal>.) They will be matched using <command>grep <literal>foo.2</literal>.) They will be matched using <command>grep
@ -3782,7 +3782,7 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting>
<sect1> <sect1>
<title><literal>ldconfig</literal></title> <title><literal>ldconfig</literal></title>
<para>The <literal>ldconfig</literal> line in Makefiles should <para>The <literal>ldconfig</literal> line in <filename>Makefile</filename>s should
read:</para> read:</para>
<programlisting>${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....</programlisting> <programlisting>${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....</programlisting>
@ -3809,7 +3809,7 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting>
make it easier for users to see what to do, but try to share as many make it easier for users to see what to do, but try to share as many
files as possible between ports. Typically you only need a very short files as possible between ports. Typically you only need a very short
<filename>Makefile</filename> in all but one of the directories if you <filename>Makefile</filename> in all but one of the directories if you
use variables cleverly. In the sole <filename>Makefiles</filename>, use variables cleverly. In the sole <filename>Makefile</filename>,
you can use <makevar>MASTERDIR</makevar> to specify the directory you can use <makevar>MASTERDIR</makevar> to specify the directory
where the rest of the files are. Also, use a variable as part of where the rest of the files are. Also, use a variable as part of
<link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so <link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so
@ -3932,7 +3932,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300
<para>If your port anchors its man tree somewhere other than <para>If your port anchors its man tree somewhere other than
<makevar>PREFIX</makevar>, you can use the <makevar>PREFIX</makevar>, you can use the
<makevar>MANPREFIX</makevar> to set it. Also, if only manpages in <makevar>MANPREFIX</makevar> to set it. Also, if only manpages in
certain sections go in a non-standard place, such as some Perl modules certain sections go in a non-standard place, such as some <literal>perl</literal> modules
ports, you can set individual man paths using ports, you can set individual man paths using
<makevar>MAN<replaceable>sect</replaceable>PREFIX</makevar> (where <makevar>MAN<replaceable>sect</replaceable>PREFIX</makevar> (where
<replaceable>sect</replaceable> is one of <literal>1-9</literal>, <replaceable>sect</replaceable> is one of <literal>1-9</literal>,
@ -3986,7 +3986,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
<title><makevar>USE_MOTIF</makevar></title> <title><makevar>USE_MOTIF</makevar></title>
<para>If your port requires Motif, define this variable in the <para>If your port requires Motif, define this variable in the
Makefile. This will prevent people who do not own a copy of Motif <filename>Makefile</filename>. This will prevent people who do not own a copy of Motif
from even attempting to build it.</para> from even attempting to build it.</para>
</sect1> </sect1>
@ -4059,7 +4059,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
<para>If you need to display a message to the installer, you may place <para>If you need to display a message to the installer, you may place
the message in <filename>pkg-message</filename>. This capability is the message in <filename>pkg-message</filename>. This capability is
often useful to display additional installation steps to be taken often useful to display additional installation steps to be taken
after a <command>pkg_add</command> or to display licensing after a &man.pkg.add.1; or to display licensing
information.</para> information.</para>
<note> <note>
@ -4075,10 +4075,10 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
<title><filename>pkg-install</filename></title> <title><filename>pkg-install</filename></title>
<para>If your port needs to execute commands when the binary package <para>If your port needs to execute commands when the binary package
is installed with <command>pkg_add</command> you can do this via the is installed with &man.pkg.add.1; you can do this via the
<filename>pkg-install</filename> script. This script will <filename>pkg-install</filename> script. This script will
automatically be added to the package, and will be run twice by automatically be added to the package, and will be run twice by
<command>pkg_add</command>. The first time as &man.pkg.add.1;. The first time as
<literal>&dollar;{SH} pkg-install &dollar;{PKGNAME} <literal>&dollar;{SH} pkg-install &dollar;{PKGNAME}
PRE-INSTALL</literal> and the second time as PRE-INSTALL</literal> and the second time as
<literal>&dollar;{SH} pkg-install &dollar;{PKGNAME} POST-INSTALL</literal>. <literal>&dollar;{SH} pkg-install &dollar;{PKGNAME} POST-INSTALL</literal>.
@ -4119,7 +4119,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
installation/deinstallation should proceed.</para> installation/deinstallation should proceed.</para>
<para>The script will be run at installation time by <para>The script will be run at installation time by
<command>pkg_add</command> as &man.pkg.add.1; as
<literal>pkg-req &dollar;{PKGNAME} INSTALL</literal>. <literal>pkg-req &dollar;{PKGNAME} INSTALL</literal>.
At deinstallation time it will be run by At deinstallation time it will be run by
&man.pkg.delete.1; as &man.pkg.delete.1; as
@ -4130,17 +4130,17 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
<title>Changing <filename>pkg-plist</filename> based on make <title>Changing <filename>pkg-plist</filename> based on make
variables</title> variables</title>
<para>Some ports, particularly the p5- ports, need to change their <para>Some ports, particularly the <literal>p5-</literal> ports, need to change their
<filename>pkg-plist</filename> depending on what options they are <filename>pkg-plist</filename> depending on what options they are
configured with (or version of perl, in the case of p5- ports). To configured with (or version of <literal>perl</literal>, in the case of <literal>p5-</literal> ports). To
make this easy, any instances in the <filename>pkg-plist</filename> of make this easy, any instances in the <filename>pkg-plist</filename> of
<literal>%%OSREL%%</literal>, <literal>%%PERL_VER%%</literal>, and <literal>%%OSREL%%</literal>, <literal>%%PERL_VER%%</literal>, and
<literal>%%PERL_VERSION%%</literal> will be substituted for <literal>%%PERL_VERSION%%</literal> will be substituted for
appropriately. The value of <literal>%%OSREL%%</literal> is the appropriately. The value of <literal>%%OSREL%%</literal> is the
numeric revision of the operating system (e.g., numeric revision of the operating system (e.g.,
<literal>2.2.7</literal>). <literal>%%PERL_VERSION%%</literal> is <literal>2.2.7</literal>). <literal>%%PERL_VERSION%%</literal> is
the full version number of perl (e.g., <literal>5.00502</literal>) the full version number of <literal>perl</literal> (e.g., <literal>5.00502</literal>)
and <literal>%%PERL_VER%%</literal> is the perl version number minus and <literal>%%PERL_VER%%</literal> is the <literal>perl</literal> version number minus
the patchlevel (e.g., <literal>5.005</literal>).</para> the patchlevel (e.g., <literal>5.005</literal>).</para>
<para>If you need to make other substitutions, you can set the <para>If you need to make other substitutions, you can set the
@ -4280,7 +4280,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
automatic; otherwise, this can often be done by simply replacing the automatic; otherwise, this can often be done by simply replacing the
occurrences of <filename>/usr/local</filename> (or occurrences of <filename>/usr/local</filename> (or
<filename>/usr/X11R6</filename> for X ports that do not use imake) <filename>/usr/X11R6</filename> for X ports that do not use imake)
in the various scripts/Makefiles in the port to read in the various <filename>scripts/Makefile</filename>s in the port to read
<makevar>PREFIX</makevar>, as this variable is automatically passed <makevar>PREFIX</makevar>, as this variable is automatically passed
down to every stage of the build and install processes.</para> down to every stage of the build and install processes.</para>
@ -4308,7 +4308,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<para>The variable <makevar>PREFIX</makevar> can be reassigned in your <para>The variable <makevar>PREFIX</makevar> can be reassigned in your
<filename>Makefile</filename> or in the user's environment. <filename>Makefile</filename> or in the user's environment.
However, it is strongly discouraged for individual ports to set this However, it is strongly discouraged for individual ports to set this
variable explicitly in the <filename>Makefiles</filename>.</para> variable explicitly in the <filename>Makefile</filename>s.</para>
<para>Also, refer to programs/files from other ports with the <para>Also, refer to programs/files from other ports with the
variables mentioned above, not explicit pathnames. For instance, if variables mentioned above, not explicit pathnames. For instance, if
@ -4324,7 +4324,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
if this is an X port, instead of if this is an X port, instead of
<literal>-DPAGER=\"/usr/local/bin/less\"</literal>. This way it will <literal>-DPAGER=\"/usr/local/bin/less\"</literal>. This way it will
have a better chance of working if the system administrator has have a better chance of working if the system administrator has
moved the whole `/usr/local' tree somewhere else.</para> moved the whole <filename>/usr/local</filename> tree somewhere else.</para>
</sect1> </sect1>
<sect1 id="testing-freshports"> <sect1 id="testing-freshports">
@ -4337,11 +4337,11 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
testing of your commits.</para> testing of your commits.</para>
<para>If you wish to use this service, all you need is a FreshPorts <para>If you wish to use this service, all you need is a FreshPorts
account. If your registered email address is @FreeBSD.org, account. If your registered email address is <literal>@FreeBSD.org</literal>,
you'll see the opt-in link on the right hand side of the webpages. you'll see the opt-in link on the right hand side of the webpages.
For those of you who already have a FreshPorts account, but are not For those of you who already have a FreshPorts account, but are not
using your @FreeBSD.org email address, just change your email to using your <literal>@FreeBSD.org</literal> email address, just change your email to
@FreeBSD.org, subscribe, then change it back again.</para> <literal>@FreeBSD.org</literal>, subscribe, then change it back again.</para>
</sect1> </sect1>
</chapter> </chapter>
@ -5597,8 +5597,8 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<note> <note>
<para>You need to include either the <para>You need to include either the
<filename>pre.mk</filename>/<filename>post.mk</filename> pair or <filename>bsd.port.pre.mk</filename>/<filename>bsd.port.post.mk</filename> pair or
<filename>bsd.port.mk</filename> only; do not mix these two.</para> <filename>bsd.port.mk</filename> only; do not mix these two usages.</para>
</note> </note>
<para><filename>bsd.port.pre.mk</filename> only defines a few <para><filename>bsd.port.pre.mk</filename> only defines a few
@ -5785,7 +5785,7 @@ post-install:
(executables started internally), <filename>sbin</filename> (executables started internally), <filename>sbin</filename>
(executables for superusers/managers), <filename>info</filename> (executables for superusers/managers), <filename>info</filename>
(documentation for info browser) or <filename>share</filename> (documentation for info browser) or <filename>share</filename>
(architecture independent files). See man &man.hier.7; for details, (architecture independent files). See &man.hier.7; for details;
the rules governing the rules governing
<filename>/usr</filename> pretty much apply to <filename>/usr</filename> pretty much apply to
<filename>/usr/local</filename> too. The exception are ports <filename>/usr/local</filename> too. The exception are ports
@ -5819,7 +5819,7 @@ lib/X11/oneko/sounds/cat.au
<programlisting>@unexec rmdir %D/share/doc/gimp 2>/dev/null || true</programlisting> <programlisting>@unexec rmdir %D/share/doc/gimp 2>/dev/null || true</programlisting>
<para>This will neither print any error messages nor cause <para>This will neither print any error messages nor cause
<command>pkg_delete</command> to exit abnormally even if &man.pkg.delete.1; to exit abnormally even if
<filename><makevar>PREFIX</makevar>/share/doc/gimp</filename> is not <filename><makevar>PREFIX</makevar>/share/doc/gimp</filename> is not
empty due to other ports installing some files in there.</para> empty due to other ports installing some files in there.</para>
</sect1> </sect1>
@ -5962,7 +5962,7 @@ drweb:*:426:426:Dr.Web Mail Scanner:/nonexistent:/sbin/nologin</programlisting>
<filename><makevar>PREFIX</makevar>/etc</filename>, do <filename><makevar>PREFIX</makevar>/etc</filename>, do
<emphasis>not</emphasis> just install them and list them in <emphasis>not</emphasis> just install them and list them in
<filename>pkg-plist</filename>. That will cause <filename>pkg-plist</filename>. That will cause
<command>pkg_delete</command> to delete files carefully edited by &man.pkg.delete.1; to delete files carefully edited by
the user and a new installation to wipe them out.</para> the user and a new installation to wipe them out.</para>
<para>Instead, install sample files with a suffix <para>Instead, install sample files with a suffix
@ -6007,7 +6007,7 @@ drweb:*:426:426:Dr.Web Mail Scanner:/nonexistent:/sbin/nologin</programlisting>
Please use the correct <command>make</command> variable as Please use the correct <command>make</command> variable as
each make variable conveys radically different meanings to each make variable conveys radically different meanings to
both users, and to automated systems that parse both users, and to automated systems that parse
<filename>Makefiles</filename>.</para> <filename>Makefile</filename>s.</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>