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

Nittage. Clarify some verbiage, fix many a typo. Also, the copyright holder

Browse source 
is the FreeBSD Documentation Project, not a blank space (the holder tag had been
omitted).
This commit is contained in:
Daniel Harris 2000-07-09 02:00:25 +00:00
parent f2ff8a34ec
commit 78e6a57e4b
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=7547
2 changed files with 78 additions and 76 deletions
en_US.ISO8859-1/books/porters-handbook
book.sgml
en_US.ISO_8859-1/books/porters-handbook
book.sgml

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

@ -1,7 +1,7 @@
<!-- <!--
The FreeBSD Documentation Project The FreeBSD Documentation Project
$FreeBSD: doc/en_US.ISO_8859-1/books/porters-handbook/book.sgml,v 1.110 2000/07/07 09:18:58 kris Exp $ $FreeBSD: doc/en_US.ISO_8859-1/books/porters-handbook/book.sgml,v 1.111 2000/07/08 10:17:08 obrien Exp $
--> -->
<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [ <!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
@ -36,6 +36,7 @@
<copyright> <copyright>
<year>2000</year> <year>2000</year>
<holder>The FreeBSD Documentation Project</holder>
</copyright> </copyright>
&bookinfo.legalnotice; &bookinfo.legalnotice;
@ -57,7 +58,7 @@
all port Makefiles include. Even if you do not hack Makefiles all port Makefiles include. Even if you do not hack Makefiles
daily, it is well commented, and you will still gain much daily, it is well commented, and you will still gain much
knowledge from it. Additionally, you may send specific questions knowledge from it. Additionally, you may send specific questions
to &a.ports;.</para> to the &a.ports;.</para>
<note> <note>
<para>Only a fraction of the variables <para>Only a fraction of the variables
@ -346,14 +347,14 @@ lib/X11/oneko/mouse.xpm
<note> <note>
<para>In the past, we asked you to upload new port submissions in <para>In the past, we asked you to upload new port submissions in
our ftp site (<hostid role="fqdn">ftp.FreeBSD.org</hostid>). This our ftp site (<hostid role="fqdn">ftp.FreeBSD.org</hostid>). This
is no longer recommended as read access is turned off on that is no longer recommended as read access is turned off on the
<filename>incoming/</filename> directory of that site due to the <filename>incoming/</filename> directory of that site due to the
large amount of pirated software showing up there.</para> large amount of pirated software showing up there.</para>
</note> </note>
<para>We will look at your port, get back to you if necessary, and put <para>We will look at your port, get back to you if necessary, and put
it in the tree. Your name will also appear in the list of it in the tree. Your name will also appear in the list of
&ldquo;Additional FreeBSD contributors&rdquo; on the FreeBSD &ldquo;Additional FreeBSD contributors&rdquo; in the FreeBSD
Handbook and other files. Isn't that great?!? <!-- smiley Handbook and other files. Isn't that great?!? <!-- smiley
-->:-)</para> -->:-)</para>
</sect1> </sect1>
@ -544,7 +545,7 @@ lib/X11/oneko/mouse.xpm
whatever changes are necessary to get the port to compile properly whatever changes are necessary to get the port to compile properly
under the current version of FreeBSD. Keep <emphasis>careful under the current version of FreeBSD. Keep <emphasis>careful
track</emphasis> of everything you do, as you will be automating track</emphasis> of everything you do, as you will be automating
the process shortly. Everything, including the deletion, addition the process shortly. Everything, including the deletion, addition,
or modification of files should be doable using an automated script or modification of files should be doable using an automated script
or patch file when your port is finished.</para> or patch file when your port is finished.</para>
@ -588,10 +589,10 @@ lib/X11/oneko/mouse.xpm
<sect1> <sect1>
<title>Configuring</title> <title>Configuring</title>
<para>Include any additional customization commands to your <para>Include any additional customization commands in your
<filename>configure</filename> script and save it in the <filename>configure</filename> script and save it in the
<filename>scripts</filename> subdirectory. As mentioned above, you <filename>scripts</filename> subdirectory. As mentioned above, you
can also do this as <filename>Makefile</filename> targets and/or can also do this with <filename>Makefile</filename> targets and/or
scripts with the name <filename>pre-configure</filename> or scripts with the name <filename>pre-configure</filename> or
<filename>post-configure</filename>.</para> <filename>post-configure</filename>.</para>
</sect1> </sect1>
@ -599,7 +600,7 @@ lib/X11/oneko/mouse.xpm
<sect1> <sect1>
<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 Makefile. This
will allow &ldquo;overnight builds&rdquo; to skip your port if the will allow &ldquo;overnight builds&rdquo; 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
@ -654,7 +655,7 @@ lib/X11/oneko/mouse.xpm
<sect1> <sect1>
<title><makevar>PORTNAME</makevar> and <makevar>PORTVERSION</makevar></title> <title><makevar>PORTNAME</makevar> and <makevar>PORTVERSION</makevar></title>
<para>You should set <makevar>PORTNAME</makevar> to be the <para>You should set <makevar>PORTNAME</makevar> to the
base name of your port, and <makevar>PORTVERSION</makevar> base name of your port, and <makevar>PORTVERSION</makevar>
to the version number of the port.</para> to the version number of the port.</para>
</sect1> </sect1>
@ -759,7 +760,7 @@ lib/X11/oneko/mouse.xpm
<makevar>MASTER_SITE_PERL_CPAN</makevar>, <makevar>MASTER_SITE_PERL_CPAN</makevar>,
<makevar>MASTER_SITE_TEX_CTAN</makevar>, and <makevar>MASTER_SITE_TEX_CTAN</makevar>, and
<makevar>MASTER_SITE_SUNSITE</makevar>. Simply set <makevar>MASTER_SITE_SUNSITE</makevar>. Simply set
<makevar>MASTER_SITE_SUBDIR</makevar> to the path with in the <makevar>MASTER_SITE_SUBDIR</makevar> to the path within the
archive. Here is an example:</para> archive. Here is an example:</para>
<programlisting> <programlisting>
@ -788,7 +789,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<literal>foozolix-1.0/</literal> in front of the filenames, then set <literal>foozolix-1.0/</literal> in front of the filenames, then set
<literal>PATCH_DIST_STRIP=-p1</literal>.</para> <literal>PATCH_DIST_STRIP=-p1</literal>.</para>
<para>Do not worry if the patches are compressed, they will be <para>Do not worry if the patches are compressed; they will be
decompressed automatically if the filenames end with decompressed automatically if the filenames end with
<filename>.gz</filename> or <filename>.Z</filename>.</para> <filename>.gz</filename> or <filename>.Z</filename>.</para>
@ -804,11 +805,11 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<filename>patch-<replaceable>xx</replaceable></filename>.</para> <filename>patch-<replaceable>xx</replaceable></filename>.</para>
<note> <note>
<para>Note the tarball will have been extracted alongside the <para>Note that the tarball will have been extracted alongside the
regular source by then, so there is no need to explicitly extract regular source by then, so there is no need to explicitly extract
it if it is a regular gzip'd or compress'd tarball. If you do the it if it is a regular gzip'd or compress'd tarball. If you do the
latter, take extra care not to overwrite something that already latter, take extra care not to overwrite something that already
exists in that directory. Also do not forget to add a command to exists in that directory. Also, do not forget to add a command to
remove the copied patch in the <maketarget>pre-clean</maketarget> remove the copied patch in the <maketarget>pre-clean</maketarget>
target.</para> target.</para>
</note> </note>
@ -820,8 +821,8 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<para>Set your mail-address here. Please. <!-- smiley <para>Set your mail-address here. Please. <!-- smiley
--><emphasis>:-)</emphasis></para> --><emphasis>:-)</emphasis></para>
<para>For detailed description of the responsibility of maintainers, <para>For a detailed description of the responsibilities of maintainers,
refer to <ulink url="../handbook/policies.html#POLICIES-MAINTAINER">MAINTAINER on refer to the <ulink url="../handbook/policies.html#POLICIES-MAINTAINER">MAINTAINER on
Makefiles</ulink> section.</para> Makefiles</ulink> section.</para>
</sect1> </sect1>
@ -841,7 +842,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
on. It is a list of on. It is a list of
<replaceable>lib</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> <replaceable>lib</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional>
tuples where <replaceable>lib</replaceable> is the name of the tuples where <replaceable>lib</replaceable> is the name of the
shared library, and <replaceable>dir</replaceable> is the shared library, <replaceable>dir</replaceable> is the
directory in which to find it in case it is not available, and directory in which to find it in case it is not available, and
<replaceable>target</replaceable> is the target to call in that <replaceable>target</replaceable> is the target to call in that
directory. For example, <programlisting> LIB_DEPENDS= directory. For example, <programlisting> LIB_DEPENDS=
@ -862,7 +863,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<para>The dependency is checked twice, once from within the <para>The dependency is checked twice, once from within the
<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 in to the package so that dependency is put into the package so that
<command>pkg_add</command> will automatically install it if it is <command>pkg_add</command> will automatically install it if it is
not on the user's system.</para> not on the user's system.</para>
</sect2> </sect2>
@ -874,7 +875,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
on during run-time. It is a list of on during run-time. It is a list of
<replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional>
tuples where <replaceable>path</replaceable> is the name of the tuples where <replaceable>path</replaceable> is the name of the
executable or file, and <replaceable>dir</replaceable> is the executable or file, <replaceable>dir</replaceable> is the
directory in which to find it in case it is not available, and directory in which to find it in case it is not available, and
<replaceable>target</replaceable> is the target to call in that <replaceable>target</replaceable> is the target to call in that
directory. If <replaceable>path</replaceable> starts with a slash directory. If <replaceable>path</replaceable> starts with a slash
@ -911,7 +912,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \
dependency is put in to the package so that dependency is put in to the package so that
<command>pkg_add</command> will automatically install it if it is <command>pkg_add</command> 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 part can be omitted if it is the same as
<makevar>DEPENDS_TARGET</makevar>.</para> <makevar>DEPENDS_TARGET</makevar>.</para>
</sect2> </sect2>
@ -929,7 +930,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \
ports tree to build and install it if it is not found.</para> ports tree to build and install it if it is not found.</para>
<note> <note>
<para>&ldquo;build&rdquo; here means everything from extracting to <para>&ldquo;build&rdquo; here means everything from extraction to
compilation. The dependency is checked from within the compilation. The dependency is checked from within the
<maketarget>extract</maketarget> target. The <maketarget>extract</maketarget> target. The
<replaceable>target</replaceable> part can be omitted if it is <replaceable>target</replaceable> part can be omitted if it is
@ -1017,7 +1018,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract</programlisting>
<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 behaviour you want can be accomplished. It will cause the way the behaviour you want can be accomplished. It will cause the
other port to be always build (and installed, by default), and the other port to always be built (and installed, by default), and the
dependency will go into the packages as well. If this is really dependency will go into the packages as well. If this is really
what you need, I recommend you write it as what you need, I recommend you write it as
<literal>BUILD_DEPENDS</literal> and <literal>BUILD_DEPENDS</literal> and
@ -1606,7 +1607,7 @@ Options:
in <emphasis>three</emphasis> places in <emphasis>three</emphasis> places
(<filename>Makefile</filename> and (<filename>Makefile</filename> and
<literal>@exec</literal>/<literal>@unexec</literal> of <literal>@exec</literal>/<literal>@unexec</literal> of
<filename>PLIST</filename>; see below). However, if you have a <filename>PLIST</filename>; see below). However, if you have
Japanese (or other multibyte encoding) info files, you will have Japanese (or other multibyte encoding) info files, you will have
to use the extra arguments to <command>install-info</command> to use the extra arguments to <command>install-info</command>
because <command>makeinfo</command> cannot handle those texinfo because <command>makeinfo</command> cannot handle those texinfo
@ -1981,7 +1982,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<title>Licensing Problems</title> <title>Licensing Problems</title>
<para>Some software packages have restrictive licenses or can be in <para>Some software packages have restrictive licenses or can be in
violation to the law (PKP's patent on public key crypto, ITAR (export violation of the law (PKP's patent on public key crypto, ITAR (export
of crypto software) to name just two of them). What we can do with of crypto software) to name just two of them). What we can do with
them varies a lot, depending on the exact wordings of the respective them varies a lot, depending on the exact wordings of the respective
licenses.</para> licenses.</para>
@ -1989,7 +1990,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<note> <note>
<para>It is your responsibility as a porter to read the licensing <para>It is your responsibility as a porter to read the licensing
terms of the software and make sure that the FreeBSD project will terms of the software and make sure that the FreeBSD project will
not be held accountable of violating them by redistributing the not be held accountable for violating them by redistributing the
source or compiled binaries either via ftp or CD-ROM. If in doubt, source or compiled binaries either via ftp or CD-ROM. If in doubt,
please contact the &a.ports;.</para> please contact the &a.ports;.</para>
</note> </note>
@ -2060,11 +2061,11 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
is <filename>superedit.bak</filename>, then send us the result of is <filename>superedit.bak</filename>, then send us the result of
<command>diff -ruN superedit.bak superedit</command>). Please examine <command>diff -ruN superedit.bak superedit</command>). Please examine
the output to make sure all the changes make sense. The best way to the output to make sure all the changes make sense. The best way to
send us the diff is by including it to &man.send-pr.1; (category send us the diff is by including it via &man.send-pr.1; (category
<literal>ports</literal>). Please mention any added or deleted files <literal>ports</literal>). Please mention any added or deleted files
in the message, as they have to be explicitly specified to CVS when in the message, as they have to be explicitly specified to CVS when
doing a commit. If the diff is more than about 20KB, please compress doing a commit. If the diff is more than about 20KB, please compress
and uuencode it; otherwise, just include it in as is in the PR.</para> and uuencode it; otherwise, just include it in the PR as is.</para>
<note> <note>
<para>Once again, please use &man.diff.1; and not &man.shar.1; to send <para>Once again, please use &man.diff.1; and not &man.shar.1; to send
@ -2090,7 +2091,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<para>Do strip binaries. If the original source already strips the <para>Do strip binaries. If the original source already strips the
binaries, fine; otherwise you should add a binaries, fine; otherwise you should add a
<literal>post-install</literal> rule to to it yourself. Here is an <literal>post-install</literal> rule to to it yourself. Here is an
example;</para> example:</para>
<programlisting> <programlisting>
post-install: post-install:
@ -2106,7 +2107,7 @@ post-install:
<para>Do use the macros provided in <filename>bsd.port.mk</filename> <para>Do use the macros provided in <filename>bsd.port.mk</filename>
to ensure correct modes and ownership of files in your own to ensure correct modes and ownership of files in your own
<maketarget>*-install</maketarget> targets. They are:</para> <maketarget>*-install</maketarget> targets.</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -2851,7 +2852,7 @@ post-install:
currently no way for the packages to read variables from currently no way for the packages to read variables from
<filename>/etc/make.conf</filename>.)</para> <filename>/etc/make.conf</filename>.)</para>
<para>Also you can use the <filename>pkg/MESSAGE</filename> file to <para>You can also use the <filename>pkg/MESSAGE</filename> file to
display messages upon installation. See the <link display messages upon installation. See the <link
linkend="porting-message">using linkend="porting-message">using
<filename>pkg/MESSAGE</filename></link> section for <filename>pkg/MESSAGE</filename></link> section for
@ -2859,7 +2860,7 @@ post-install:
<note> <note>
<para><filename>MESSAGE</filename> does not need to be added to <para><filename>MESSAGE</filename> does not need to be added to
<filename>pkg/PLIST</filename>).</para> <filename>pkg/PLIST</filename>.</para>
</note> </note>
</sect1> </sect1>
@ -2963,7 +2964,7 @@ post-install:
down to every stage of the build and install processes.</para> down to every stage of the build and install processes.</para>
<para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port <para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port
truly require it (i.e., it links against X libs or it needs to truly requires it (i.e., it links against X libs or it needs to
reference files in <makevar>X11BASE</makevar>).</para> reference files in <makevar>X11BASE</makevar>).</para>
<para>The variable <makevar>PREFIX</makevar> can be reassigned in your <para>The variable <makevar>PREFIX</makevar> can be reassigned in your
@ -3054,7 +3055,7 @@ lib/X11/oneko/sounds/cat.au
<filename>net/cvsup-mirror</filename> for an example.</para> <filename>net/cvsup-mirror</filename> for an example.</para>
<para>If your port must use the same user/group ID number when it is <para>If your port must use the same user/group ID number when it is
installed a binary package as when it was compiled, then you must installed as a binary package as when it was compiled, then you must
choose a free UID from 50 to 99 and register it below. Look at choose a free UID from 50 to 99 and register it below. Look at
<filename>japanese/Wnn</filename> for an example.</para> <filename>japanese/Wnn</filename> for an example.</para>
@ -3586,7 +3587,7 @@ pre-install:
<para>As you already know, ports are classified in several categories. <para>As you already know, ports are classified in several categories.
But for this to work, it is important that porters and users understand But for this to work, it is important that porters and users understand
what each category and how we decide what to put in each what each category is for and how we decide what to put in each
category.</para> category.</para>
<sect1> <sect1>
@ -3929,16 +3930,16 @@ pre-install:
<row> <row>
<entry><filename>www</filename></entry> <entry><filename>www</filename></entry>
<entry>Software related to the World Wide Web. HTML language <entry>Software related to the World Wide Web. HTML language
support belong here too.</entry> support belongs here too.</entry>
</row> </row>
<row> <row>
<entry>x11</entry> <entry>x11</entry>
<entry>The X window system and friends. This category is only <entry>The X window system and friends. This category is only
for software that directly support the window system. Do not for software that directly supports the window system. Do not
put regular X applications here. If your port is an X put regular X applications here. If your port is an X
application, define <makevar>USE_XLIB</makevar> (implied by application, define <makevar>USE_XLIB</makevar> (implied by
<makevar>USE_IMAKE</makevar>) and put it in appropriate <makevar>USE_IMAKE</makevar>) and put it in the appropriate
categories. Also, many of them go into other categories. Also, many of them go into other
<filename>x11-*</filename> categories (see below).</entry> <filename>x11-*</filename> categories (see below).</entry>
</row> </row>
@ -4030,8 +4031,8 @@ pre-install:
<para>If you are not sure about the category, please put a comment to <para>If you are not sure about the category, please put a comment to
that effect in your <command>send-pr</command> submission so we can that effect in your <command>send-pr</command> submission so we can
discuss it before we import it. If you are a committer, send a note discuss it before we import it. If you are a committer, send a note
&a.ports; so we can discuss it first&mdash;too often new ports are to the &a.ports; so we can discuss it first&mdash;too often new ports are
imported to a wrong category only to be moved right away.</para> imported to the wrong category only to be moved right away.</para>
</sect1> </sect1>
</chapter> </chapter>

77
en_US.ISO_8859-1/books/porters-handbook/book.sgml
View file

@ -1,7 +1,7 @@
<!-- <!--
The FreeBSD Documentation Project The FreeBSD Documentation Project
$FreeBSD: doc/en_US.ISO_8859-1/books/porters-handbook/book.sgml,v 1.110 2000/07/07 09:18:58 kris Exp $ $FreeBSD: doc/en_US.ISO_8859-1/books/porters-handbook/book.sgml,v 1.111 2000/07/08 10:17:08 obrien Exp $
--> -->
<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [ <!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
@ -36,6 +36,7 @@
<copyright> <copyright>
<year>2000</year> <year>2000</year>
<holder>The FreeBSD Documentation Project</holder>
</copyright> </copyright>
&bookinfo.legalnotice; &bookinfo.legalnotice;
@ -57,7 +58,7 @@
all port Makefiles include. Even if you do not hack Makefiles all port Makefiles include. Even if you do not hack Makefiles
daily, it is well commented, and you will still gain much daily, it is well commented, and you will still gain much
knowledge from it. Additionally, you may send specific questions knowledge from it. Additionally, you may send specific questions
to &a.ports;.</para> to the &a.ports;.</para>
<note> <note>
<para>Only a fraction of the variables <para>Only a fraction of the variables
@ -346,14 +347,14 @@ lib/X11/oneko/mouse.xpm
<note> <note>
<para>In the past, we asked you to upload new port submissions in <para>In the past, we asked you to upload new port submissions in
our ftp site (<hostid role="fqdn">ftp.FreeBSD.org</hostid>). This our ftp site (<hostid role="fqdn">ftp.FreeBSD.org</hostid>). This
is no longer recommended as read access is turned off on that is no longer recommended as read access is turned off on the
<filename>incoming/</filename> directory of that site due to the <filename>incoming/</filename> directory of that site due to the
large amount of pirated software showing up there.</para> large amount of pirated software showing up there.</para>
</note> </note>
<para>We will look at your port, get back to you if necessary, and put <para>We will look at your port, get back to you if necessary, and put
it in the tree. Your name will also appear in the list of it in the tree. Your name will also appear in the list of
&ldquo;Additional FreeBSD contributors&rdquo; on the FreeBSD &ldquo;Additional FreeBSD contributors&rdquo; in the FreeBSD
Handbook and other files. Isn't that great?!? <!-- smiley Handbook and other files. Isn't that great?!? <!-- smiley
-->:-)</para> -->:-)</para>
</sect1> </sect1>
@ -544,7 +545,7 @@ lib/X11/oneko/mouse.xpm
whatever changes are necessary to get the port to compile properly whatever changes are necessary to get the port to compile properly
under the current version of FreeBSD. Keep <emphasis>careful under the current version of FreeBSD. Keep <emphasis>careful
track</emphasis> of everything you do, as you will be automating track</emphasis> of everything you do, as you will be automating
the process shortly. Everything, including the deletion, addition the process shortly. Everything, including the deletion, addition,
or modification of files should be doable using an automated script or modification of files should be doable using an automated script
or patch file when your port is finished.</para> or patch file when your port is finished.</para>
@ -588,10 +589,10 @@ lib/X11/oneko/mouse.xpm
<sect1> <sect1>
<title>Configuring</title> <title>Configuring</title>
<para>Include any additional customization commands to your <para>Include any additional customization commands in your
<filename>configure</filename> script and save it in the <filename>configure</filename> script and save it in the
<filename>scripts</filename> subdirectory. As mentioned above, you <filename>scripts</filename> subdirectory. As mentioned above, you
can also do this as <filename>Makefile</filename> targets and/or can also do this with <filename>Makefile</filename> targets and/or
scripts with the name <filename>pre-configure</filename> or scripts with the name <filename>pre-configure</filename> or
<filename>post-configure</filename>.</para> <filename>post-configure</filename>.</para>
</sect1> </sect1>
@ -599,7 +600,7 @@ lib/X11/oneko/mouse.xpm
<sect1> <sect1>
<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 Makefile. This
will allow &ldquo;overnight builds&rdquo; to skip your port if the will allow &ldquo;overnight builds&rdquo; 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
@ -654,7 +655,7 @@ lib/X11/oneko/mouse.xpm
<sect1> <sect1>
<title><makevar>PORTNAME</makevar> and <makevar>PORTVERSION</makevar></title> <title><makevar>PORTNAME</makevar> and <makevar>PORTVERSION</makevar></title>
<para>You should set <makevar>PORTNAME</makevar> to be the <para>You should set <makevar>PORTNAME</makevar> to the
base name of your port, and <makevar>PORTVERSION</makevar> base name of your port, and <makevar>PORTVERSION</makevar>
to the version number of the port.</para> to the version number of the port.</para>
</sect1> </sect1>
@ -759,7 +760,7 @@ lib/X11/oneko/mouse.xpm
<makevar>MASTER_SITE_PERL_CPAN</makevar>, <makevar>MASTER_SITE_PERL_CPAN</makevar>,
<makevar>MASTER_SITE_TEX_CTAN</makevar>, and <makevar>MASTER_SITE_TEX_CTAN</makevar>, and
<makevar>MASTER_SITE_SUNSITE</makevar>. Simply set <makevar>MASTER_SITE_SUNSITE</makevar>. Simply set
<makevar>MASTER_SITE_SUBDIR</makevar> to the path with in the <makevar>MASTER_SITE_SUBDIR</makevar> to the path within the
archive. Here is an example:</para> archive. Here is an example:</para>
<programlisting> <programlisting>
@ -788,7 +789,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<literal>foozolix-1.0/</literal> in front of the filenames, then set <literal>foozolix-1.0/</literal> in front of the filenames, then set
<literal>PATCH_DIST_STRIP=-p1</literal>.</para> <literal>PATCH_DIST_STRIP=-p1</literal>.</para>
<para>Do not worry if the patches are compressed, they will be <para>Do not worry if the patches are compressed; they will be
decompressed automatically if the filenames end with decompressed automatically if the filenames end with
<filename>.gz</filename> or <filename>.Z</filename>.</para> <filename>.gz</filename> or <filename>.Z</filename>.</para>
@ -804,11 +805,11 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<filename>patch-<replaceable>xx</replaceable></filename>.</para> <filename>patch-<replaceable>xx</replaceable></filename>.</para>
<note> <note>
<para>Note the tarball will have been extracted alongside the <para>Note that the tarball will have been extracted alongside the
regular source by then, so there is no need to explicitly extract regular source by then, so there is no need to explicitly extract
it if it is a regular gzip'd or compress'd tarball. If you do the it if it is a regular gzip'd or compress'd tarball. If you do the
latter, take extra care not to overwrite something that already latter, take extra care not to overwrite something that already
exists in that directory. Also do not forget to add a command to exists in that directory. Also, do not forget to add a command to
remove the copied patch in the <maketarget>pre-clean</maketarget> remove the copied patch in the <maketarget>pre-clean</maketarget>
target.</para> target.</para>
</note> </note>
@ -820,8 +821,8 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<para>Set your mail-address here. Please. <!-- smiley <para>Set your mail-address here. Please. <!-- smiley
--><emphasis>:-)</emphasis></para> --><emphasis>:-)</emphasis></para>
<para>For detailed description of the responsibility of maintainers, <para>For a detailed description of the responsibilities of maintainers,
refer to <ulink url="../handbook/policies.html#POLICIES-MAINTAINER">MAINTAINER on refer to the <ulink url="../handbook/policies.html#POLICIES-MAINTAINER">MAINTAINER on
Makefiles</ulink> section.</para> Makefiles</ulink> section.</para>
</sect1> </sect1>
@ -841,7 +842,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
on. It is a list of on. It is a list of
<replaceable>lib</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> <replaceable>lib</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional>
tuples where <replaceable>lib</replaceable> is the name of the tuples where <replaceable>lib</replaceable> is the name of the
shared library, and <replaceable>dir</replaceable> is the shared library, <replaceable>dir</replaceable> is the
directory in which to find it in case it is not available, and directory in which to find it in case it is not available, and
<replaceable>target</replaceable> is the target to call in that <replaceable>target</replaceable> is the target to call in that
directory. For example, <programlisting> LIB_DEPENDS= directory. For example, <programlisting> LIB_DEPENDS=
@ -862,7 +863,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
<para>The dependency is checked twice, once from within the <para>The dependency is checked twice, once from within the
<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 in to the package so that dependency is put into the package so that
<command>pkg_add</command> will automatically install it if it is <command>pkg_add</command> will automatically install it if it is
not on the user's system.</para> not on the user's system.</para>
</sect2> </sect2>
@ -874,7 +875,7 @@ MASTER_SITE_SUBDIR= applications</programlisting>
on during run-time. It is a list of on during run-time. It is a list of
<replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional>
tuples where <replaceable>path</replaceable> is the name of the tuples where <replaceable>path</replaceable> is the name of the
executable or file, and <replaceable>dir</replaceable> is the executable or file, <replaceable>dir</replaceable> is the
directory in which to find it in case it is not available, and directory in which to find it in case it is not available, and
<replaceable>target</replaceable> is the target to call in that <replaceable>target</replaceable> is the target to call in that
directory. If <replaceable>path</replaceable> starts with a slash directory. If <replaceable>path</replaceable> starts with a slash
@ -911,7 +912,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \
dependency is put in to the package so that dependency is put in to the package so that
<command>pkg_add</command> will automatically install it if it is <command>pkg_add</command> 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 part can be omitted if it is the same as
<makevar>DEPENDS_TARGET</makevar>.</para> <makevar>DEPENDS_TARGET</makevar>.</para>
</sect2> </sect2>
@ -929,7 +930,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \
ports tree to build and install it if it is not found.</para> ports tree to build and install it if it is not found.</para>
<note> <note>
<para>&ldquo;build&rdquo; here means everything from extracting to <para>&ldquo;build&rdquo; here means everything from extraction to
compilation. The dependency is checked from within the compilation. The dependency is checked from within the
<maketarget>extract</maketarget> target. The <maketarget>extract</maketarget> target. The
<replaceable>target</replaceable> part can be omitted if it is <replaceable>target</replaceable> part can be omitted if it is
@ -1017,7 +1018,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract</programlisting>
<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 behaviour you want can be accomplished. It will cause the way the behaviour you want can be accomplished. It will cause the
other port to be always build (and installed, by default), and the other port to always be built (and installed, by default), and the
dependency will go into the packages as well. If this is really dependency will go into the packages as well. If this is really
what you need, I recommend you write it as what you need, I recommend you write it as
<literal>BUILD_DEPENDS</literal> and <literal>BUILD_DEPENDS</literal> and
@ -1606,7 +1607,7 @@ Options:
in <emphasis>three</emphasis> places in <emphasis>three</emphasis> places
(<filename>Makefile</filename> and (<filename>Makefile</filename> and
<literal>@exec</literal>/<literal>@unexec</literal> of <literal>@exec</literal>/<literal>@unexec</literal> of
<filename>PLIST</filename>; see below). However, if you have a <filename>PLIST</filename>; see below). However, if you have
Japanese (or other multibyte encoding) info files, you will have Japanese (or other multibyte encoding) info files, you will have
to use the extra arguments to <command>install-info</command> to use the extra arguments to <command>install-info</command>
because <command>makeinfo</command> cannot handle those texinfo because <command>makeinfo</command> cannot handle those texinfo
@ -1981,7 +1982,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<title>Licensing Problems</title> <title>Licensing Problems</title>
<para>Some software packages have restrictive licenses or can be in <para>Some software packages have restrictive licenses or can be in
violation to the law (PKP's patent on public key crypto, ITAR (export violation of the law (PKP's patent on public key crypto, ITAR (export
of crypto software) to name just two of them). What we can do with of crypto software) to name just two of them). What we can do with
them varies a lot, depending on the exact wordings of the respective them varies a lot, depending on the exact wordings of the respective
licenses.</para> licenses.</para>
@ -1989,7 +1990,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<note> <note>
<para>It is your responsibility as a porter to read the licensing <para>It is your responsibility as a porter to read the licensing
terms of the software and make sure that the FreeBSD project will terms of the software and make sure that the FreeBSD project will
not be held accountable of violating them by redistributing the not be held accountable for violating them by redistributing the
source or compiled binaries either via ftp or CD-ROM. If in doubt, source or compiled binaries either via ftp or CD-ROM. If in doubt,
please contact the &a.ports;.</para> please contact the &a.ports;.</para>
</note> </note>
@ -2060,11 +2061,11 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
is <filename>superedit.bak</filename>, then send us the result of is <filename>superedit.bak</filename>, then send us the result of
<command>diff -ruN superedit.bak superedit</command>). Please examine <command>diff -ruN superedit.bak superedit</command>). Please examine
the output to make sure all the changes make sense. The best way to the output to make sure all the changes make sense. The best way to
send us the diff is by including it to &man.send-pr.1; (category send us the diff is by including it via &man.send-pr.1; (category
<literal>ports</literal>). Please mention any added or deleted files <literal>ports</literal>). Please mention any added or deleted files
in the message, as they have to be explicitly specified to CVS when in the message, as they have to be explicitly specified to CVS when
doing a commit. If the diff is more than about 20KB, please compress doing a commit. If the diff is more than about 20KB, please compress
and uuencode it; otherwise, just include it in as is in the PR.</para> and uuencode it; otherwise, just include it in the PR as is.</para>
<note> <note>
<para>Once again, please use &man.diff.1; and not &man.shar.1; to send <para>Once again, please use &man.diff.1; and not &man.shar.1; to send
@ -2090,7 +2091,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<para>Do strip binaries. If the original source already strips the <para>Do strip binaries. If the original source already strips the
binaries, fine; otherwise you should add a binaries, fine; otherwise you should add a
<literal>post-install</literal> rule to to it yourself. Here is an <literal>post-install</literal> rule to to it yourself. Here is an
example;</para> example:</para>
<programlisting> <programlisting>
post-install: post-install:
@ -2106,7 +2107,7 @@ post-install:
<para>Do use the macros provided in <filename>bsd.port.mk</filename> <para>Do use the macros provided in <filename>bsd.port.mk</filename>
to ensure correct modes and ownership of files in your own to ensure correct modes and ownership of files in your own
<maketarget>*-install</maketarget> targets. They are:</para> <maketarget>*-install</maketarget> targets.</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -2851,7 +2852,7 @@ post-install:
currently no way for the packages to read variables from currently no way for the packages to read variables from
<filename>/etc/make.conf</filename>.)</para> <filename>/etc/make.conf</filename>.)</para>
<para>Also you can use the <filename>pkg/MESSAGE</filename> file to <para>You can also use the <filename>pkg/MESSAGE</filename> file to
display messages upon installation. See the <link display messages upon installation. See the <link
linkend="porting-message">using linkend="porting-message">using
<filename>pkg/MESSAGE</filename></link> section for <filename>pkg/MESSAGE</filename></link> section for
@ -2859,7 +2860,7 @@ post-install:
<note> <note>
<para><filename>MESSAGE</filename> does not need to be added to <para><filename>MESSAGE</filename> does not need to be added to
<filename>pkg/PLIST</filename>).</para> <filename>pkg/PLIST</filename>.</para>
</note> </note>
</sect1> </sect1>
@ -2963,7 +2964,7 @@ post-install:
down to every stage of the build and install processes.</para> down to every stage of the build and install processes.</para>
<para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port <para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port
truly require it (i.e., it links against X libs or it needs to truly requires it (i.e., it links against X libs or it needs to
reference files in <makevar>X11BASE</makevar>).</para> reference files in <makevar>X11BASE</makevar>).</para>
<para>The variable <makevar>PREFIX</makevar> can be reassigned in your <para>The variable <makevar>PREFIX</makevar> can be reassigned in your
@ -3054,7 +3055,7 @@ lib/X11/oneko/sounds/cat.au
<filename>net/cvsup-mirror</filename> for an example.</para> <filename>net/cvsup-mirror</filename> for an example.</para>
<para>If your port must use the same user/group ID number when it is <para>If your port must use the same user/group ID number when it is
installed a binary package as when it was compiled, then you must installed as a binary package as when it was compiled, then you must
choose a free UID from 50 to 99 and register it below. Look at choose a free UID from 50 to 99 and register it below. Look at
<filename>japanese/Wnn</filename> for an example.</para> <filename>japanese/Wnn</filename> for an example.</para>
@ -3586,7 +3587,7 @@ pre-install:
<para>As you already know, ports are classified in several categories. <para>As you already know, ports are classified in several categories.
But for this to work, it is important that porters and users understand But for this to work, it is important that porters and users understand
what each category and how we decide what to put in each what each category is for and how we decide what to put in each
category.</para> category.</para>
<sect1> <sect1>
@ -3929,16 +3930,16 @@ pre-install:
<row> <row>
<entry><filename>www</filename></entry> <entry><filename>www</filename></entry>
<entry>Software related to the World Wide Web. HTML language <entry>Software related to the World Wide Web. HTML language
support belong here too.</entry> support belongs here too.</entry>
</row> </row>
<row> <row>
<entry>x11</entry> <entry>x11</entry>
<entry>The X window system and friends. This category is only <entry>The X window system and friends. This category is only
for software that directly support the window system. Do not for software that directly supports the window system. Do not
put regular X applications here. If your port is an X put regular X applications here. If your port is an X
application, define <makevar>USE_XLIB</makevar> (implied by application, define <makevar>USE_XLIB</makevar> (implied by
<makevar>USE_IMAKE</makevar>) and put it in appropriate <makevar>USE_IMAKE</makevar>) and put it in the appropriate
categories. Also, many of them go into other categories. Also, many of them go into other
<filename>x11-*</filename> categories (see below).</entry> <filename>x11-*</filename> categories (see below).</entry>
</row> </row>
@ -4030,8 +4031,8 @@ pre-install:
<para>If you are not sure about the category, please put a comment to <para>If you are not sure about the category, please put a comment to
that effect in your <command>send-pr</command> submission so we can that effect in your <command>send-pr</command> submission so we can
discuss it before we import it. If you are a committer, send a note discuss it before we import it. If you are a committer, send a note
&a.ports; so we can discuss it first&mdash;too often new ports are to the &a.ports; so we can discuss it first&mdash;too often new ports are
imported to a wrong category only to be moved right away.</para> imported to the wrong category only to be moved right away.</para>
</sect1> </sect1>
</chapter> </chapter>