[31621] trunk/doc-new/guide/xml
simon at macports.org
simon at macports.org
Fri Nov 30 11:09:41 PST 2007
Revision: 31621
http://trac.macosforge.org/projects/macports/changeset/31621
Author: simon at macports.org
Date: 2007-11-30 11:09:37 -0800 (Fri, 30 Nov 2007)
Log Message:
-----------
doc-new: Whitespace change only to fix indentation.
Modified Paths:
--------------
trunk/doc-new/guide/xml/guide.xml
trunk/doc-new/guide/xml/internals.xml
trunk/doc-new/guide/xml/portfile-global-keywords.7.xml
trunk/doc-new/guide/xml/portfile-global-variables.7.xml
trunk/doc-new/guide/xml/portfile-phase.7.xml
trunk/doc-new/guide/xml/portfile-startupitem.7.xml
trunk/doc-new/guide/xml/portfile-tcl.7.xml
Modified: trunk/doc-new/guide/xml/guide.xml
===================================================================
--- trunk/doc-new/guide/xml/guide.xml 2007-11-30 18:25:42 UTC (rev 31620)
+++ trunk/doc-new/guide/xml/guide.xml 2007-11-30 19:09:37 UTC (rev 31621)
@@ -44,11 +44,14 @@
</legalnotice>
</bookinfo>
- <xi:include href="intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="intro.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="installing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="installing.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="using.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="using.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="portfiledev.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
@@ -56,9 +59,13 @@
<xi:include href="portfileref.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="internals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="internals.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="project.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="project.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="glossary.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="glossary.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
</book>
Modified: trunk/doc-new/guide/xml/internals.xml
===================================================================
--- trunk/doc-new/guide/xml/internals.xml 2007-11-30 18:25:42 UTC (rev 31620)
+++ trunk/doc-new/guide/xml/internals.xml 2007-11-30 19:09:37 UTC (rev 31621)
@@ -11,7 +11,7 @@
<title>MacPorts File Hierarchy</title>
<xi:include href="../../man/xml/porthier.7.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="internals.configuration-files">
Modified: trunk/doc-new/guide/xml/portfile-global-keywords.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-global-keywords.7.xml 2007-11-30 18:25:42 UTC (rev 31620)
+++ trunk/doc-new/guide/xml/portfile-global-keywords.7.xml 2007-11-30 19:09:37 UTC (rev 31621)
@@ -2,629 +2,629 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
- <section>
- <title>Global Keywords</title>
+<section>
+ <title>Global Keywords</title>
- <para>MacPorts keywords are used to specify required or optional items
- within a Portfile, or to override default options used by MacPorts base
- for individual ports. Keywords are to be used within the "global" and
- "variant" sections of Portfiles, and not within optional port phase
- declarations.</para>
+ <para>MacPorts keywords are used to specify required or optional items
+ within a Portfile, or to override default options used by MacPorts base
+ for individual ports. Keywords are to be used within the "global" and
+ "variant" sections of Portfiles, and not within optional port phase
+ declarations.</para>
- <para>The global keywords listed below specify information for ports as a
- whole, whereas the keywords listed under a port phase specify information
- to be used during a particular installation phase.</para>
+ <para>The global keywords listed below specify information for ports as a
+ whole, whereas the keywords listed under a port phase specify information
+ to be used during a particular installation phase.</para>
- <section>
- <title>General</title>
+ <section>
+ <title>General</title>
- <para>The list of global keywords.</para>
+ <para>The list of global keywords.</para>
- <variablelist>
- <varlistentry>
- <term>PortSystem</term>
+ <variablelist>
+ <varlistentry>
+ <term>PortSystem</term>
- <listitem>
- <para>The top line of every Portfile; it must be followed by a
- blank line. It defines which version of the Portfile interpreter
- will be used.</para>
+ <listitem>
+ <para>The top line of every Portfile; it must be followed by a
+ blank line. It defines which version of the Portfile interpreter
+ will be used.</para>
- <programlisting>PortSystem 1.0
+ <programlisting>PortSystem 1.0
</programlisting>
- </listitem>
- </varlistentry>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>name</term>
+ <varlistentry>
+ <term>name</term>
- <listitem>
- <para>The name of the Port; it should be lowercase.</para>
+ <listitem>
+ <para>The name of the Port; it should be lowercase.</para>
- <programlisting>name foo</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>name foo</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>version</term>
+ <varlistentry>
+ <term>version</term>
- <listitem>
- <para>The version of the ported software.</para>
+ <listitem>
+ <para>The version of the ported software.</para>
- <programlisting>version 1.23.45</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>version 1.23.45</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>revision</term>
+ <varlistentry>
+ <term>revision</term>
- <listitem>
- <para>Optional keyword (default is 0) that is used to track port
- revisions. It should not be incremented for port revisions unless
- it would benefit users to upgrade an installed port, and cleared
- when the port is updated to a newer version.</para>
+ <listitem>
+ <para>Optional keyword (default is 0) that is used to track port
+ revisions. It should not be incremented for port revisions unless
+ it would benefit users to upgrade an installed port, and cleared
+ when the port is updated to a newer version.</para>
- <programlisting>revision 1</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>revision 1</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>epoch</term>
+ <varlistentry>
+ <term>epoch</term>
- <listitem>
- <para>Optional keyword (default is 0) that is used if the new port
- version looks older than the previous version (for example 1.10
- -> 1.2). Often the epoch is formatted like a date, but it can
- simple a number like 1.</para>
+ <listitem>
+ <para>Optional keyword (default is 0) that is used if the new port
+ version looks older than the previous version (for example 1.10
+ -> 1.2). Often the epoch is formatted like a date, but it can
+ simple a number like 1.</para>
- <programlisting>epoch 20070924</programlisting>
+ <programlisting>epoch 20070924</programlisting>
- <programlisting>epoch 1</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>epoch 1</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>categories</term>
+ <varlistentry>
+ <term>categories</term>
- <listitem>
- <para>The category under which the ported software falls. The
- first category should be the same as the directory within which
- the Portfile is stored; secondary and tertiary categories may be
- selected.</para>
+ <listitem>
+ <para>The category under which the ported software falls. The
+ first category should be the same as the directory within which
+ the Portfile is stored; secondary and tertiary categories may be
+ selected.</para>
- <programlisting>categories net security</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>categories net security</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>maintainers</term>
+ <varlistentry>
+ <term>maintainers</term>
- <listitem>
- <para>A port's maintainer is a person or persons who take
- responsibility for keeping the port up-to-date, and the maintainer
- keyword lists maintainer email addresses(s). However, many
- maintainers wish to hide these addresses from spambots; to do so
- follow these conventions:</para>
+ <listitem>
+ <para>A port's maintainer is a person or persons who take
+ responsibility for keeping the port up-to-date, and the maintainer
+ keyword lists maintainer email addresses(s). However, many
+ maintainers wish to hide these addresses from spambots; to do so
+ follow these conventions:</para>
- <itemizedlist>
- <listitem>
- <para>For addresses in domain @macports.org, simply omit the
- domain name.</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>For addresses in domain @macports.org, simply omit the
+ domain name.</para>
+ </listitem>
- <listitem>
- <para>For addresses in other domains, say
- <email>account at example.org</email>, use the convention
- example.org:account to specify the address.</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>For addresses in other domains, say
+ <email>account at example.org</email>, use the convention
+ example.org:account to specify the address.</para>
+ </listitem>
+ </itemizedlist>
- <para>In the example below, the maintainer email addresses
- <email>jdoe at macports.org</email> and
- <email>julesverne at example.org</email> are hidden using these
- conventions.</para>
+ <para>In the example below, the maintainer email addresses
+ <email>jdoe at macports.org</email> and
+ <email>julesverne at example.org</email> are hidden using these
+ conventions.</para>
- <programlisting>maintainers jdoe \
+ <programlisting>maintainers jdoe \
example.org:julesverne</programlisting>
- </listitem>
- </varlistentry>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>description</term>
+ <varlistentry>
+ <term>description</term>
- <listitem>
- <para>A one-sentence description of the ported software.</para>
+ <listitem>
+ <para>A one-sentence description of the ported software.</para>
- <programlisting>description A classic shooter arcade game.</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>description A classic shooter arcade game.</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>long_description</term>
+ <varlistentry>
+ <term>long_description</term>
- <listitem>
- <para>A long description of the ported software. Break long lines
- with escaped newlines.</para>
+ <listitem>
+ <para>A long description of the ported software. Break long lines
+ with escaped newlines.</para>
- <programlisting>description A classic shooter arcade game derived from \
+ <programlisting>description A classic shooter arcade game derived from \
the game alien-munchers. Not suitable for \
children under two years old. </programlisting>
- </listitem>
- </varlistentry>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>homepage</term>
+ <varlistentry>
+ <term>homepage</term>
- <listitem>
- <para>Port application's homepage.</para>
+ <listitem>
+ <para>Port application's homepage.</para>
- <programlisting>homepage http://www.somesite.org/apps</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>homepage http://www.somesite.org/apps</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>platforms</term>
+ <varlistentry>
+ <term>platforms</term>
- <listitem>
- <para>The platforms on which the port has been tested.</para>
+ <listitem>
+ <para>The platforms on which the port has been tested.</para>
- <programlisting>platforms darwin freebsd</programlisting>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <programlisting>platforms darwin freebsd</programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <section>
- <title>Dependencies</title>
+ <section>
+ <title>Dependencies</title>
- <para>Free and open source software is highly modular, and MacPorts
- ports often require that other ports be installed beforehand; these
- prerequisites for a given port are called a port's
- <quote>dependencies</quote>.</para>
+ <para>Free and open source software is highly modular, and MacPorts
+ ports often require that other ports be installed beforehand; these
+ prerequisites for a given port are called a port's
+ <quote>dependencies</quote>.</para>
- <para>There are three types of MacPorts dependencies: library, build,
- and run dependencies. Dependency types are important for proper port
- upgrade and uninstall behavior. For example, you may not uninstall a
- port that is a library dependency for another port, though you may
- remove one with a build dependency; likewise, upgrading a port will
- upgrade its library and build dependencies also, but not its run
- dependencies.</para>
+ <para>There are three types of MacPorts dependencies: library, build,
+ and run dependencies. Dependency types are important for proper port
+ upgrade and uninstall behavior. For example, you may not uninstall a
+ port that is a library dependency for another port, though you may
+ remove one with a build dependency; likewise, upgrading a port will
+ upgrade its library and build dependencies also, but not its run
+ dependencies.</para>
- <variablelist>
- <varlistentry>
- <term>depends_lib</term>
+ <variablelist>
+ <varlistentry>
+ <term>depends_lib</term>
- <term>depends_lib-append</term>
+ <term>depends_lib-append</term>
- <term>depends_lib-delete</term>
+ <term>depends_lib-delete</term>
- <listitem>
- <para>The list of dependencies to check before phases
- <option>configure</option>, <option>build</option>,
- <option>destroot</option>, <option>install</option>, and
- <option>package</option>. Library dependencies are needed both at
- build time (for headers and libraries to link against) and at run
- time.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>The list of dependencies to check before phases
+ <option>configure</option>, <option>build</option>,
+ <option>destroot</option>, <option>install</option>, and
+ <option>package</option>. Library dependencies are needed both at
+ build time (for headers and libraries to link against) and at run
+ time.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>depends_build</term>
+ <varlistentry>
+ <term>depends_build</term>
- <term>depends_build-append</term>
+ <term>depends_build-append</term>
- <term>depends_build-delete</term>
+ <term>depends_build-delete</term>
- <listitem>
- <para>The list of dependencies to check before phases
- <option>build</option>, <option>destroot</option>,
- <option>install</option>, and <option>package</option>. Build
- dependencies are needed when software is compiled, but not needed
- at all once the software is compiled and installed.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>The list of dependencies to check before phases
+ <option>build</option>, <option>destroot</option>,
+ <option>install</option>, and <option>package</option>. Build
+ dependencies are needed when software is compiled, but not needed
+ at all once the software is compiled and installed.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>depends_run</term>
+ <varlistentry>
+ <term>depends_run</term>
- <term>depends_run-append</term>
+ <term>depends_run-append</term>
- <term>depends_run-delete</term>
+ <term>depends_run-delete</term>
- <listitem>
- <para>The list of dependencies to check before phases
- <option>destroot</option>, <option>install</option>, and
- <option>package</option>. Run dependencies are needed when the
- software is run, but not to compile it.</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <listitem>
+ <para>The list of dependencies to check before phases
+ <option>destroot</option>, <option>install</option>, and
+ <option>package</option>. Run dependencies are needed when the
+ software is run, but not to compile it.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <section>
- <title>Port and Non-Port Dependencies</title>
+ <section>
+ <title>Port and Non-Port Dependencies</title>
- <para>Port dependencies should be provided by MacPorts ports whenever
- possible, however dependencies may be provided by vendor-supplied
- software when satisfying a dependency by a port is not practical or
- desirable for a special reason. Dependencies of this type are called
- non-port dependencies.</para>
+ <para>Port dependencies should be provided by MacPorts ports whenever
+ possible, however dependencies may be provided by vendor-supplied
+ software when satisfying a dependency by a port is not practical or
+ desirable for a special reason. Dependencies of this type are called
+ non-port dependencies.</para>
- <para>Port dependencies, the preferred type, are specified as shown in
- these examples:</para>
+ <para>Port dependencies, the preferred type, are specified as shown in
+ these examples:</para>
- <programlisting>depends_lib port:rrdtool port:apache2
+ <programlisting>depends_lib port:rrdtool port:apache2
depends_build port:apache2 port:php5</programlisting>
- <para>Non-port dependencies are specified as shown in these
- examples:</para>
+ <para>Non-port dependencies are specified as shown in these
+ examples:</para>
- <programlisting>depends_lib lib:libX11.6:xorg
+ <programlisting>depends_lib lib:libX11.6:xorg
depends_build bin:rrdtool</programlisting>
- </section>
</section>
+ </section>
- <section>
- <title>Variants</title>
+ <section>
+ <title>Variants</title>
- <para>MacPorts variants are conditional modifications of port
- installation behavior that may be invoked by a user at the time of port
- install.</para>
+ <para>MacPorts variants are conditional modifications of port
+ installation behavior that may be invoked by a user at the time of port
+ install.</para>
- <variablelist>
- <varlistentry>
- <term>variant [requires variant] [conflicts variant] [description
- description]</term>
+ <variablelist>
+ <varlistentry>
+ <term>variant [requires variant] [conflicts variant] [description
+ description]</term>
- <listitem>
- <para>The variant declaration may contain any keywords that can be
- placed in a Portfile's global section. If you wish to execute
- system (shell) calls or Tcl extensions during the execution of a
- port phase, you should place those statements within a
- <literal>variant_isset</literal> conditional within a phase
- declaration and not within the variant declaration itself.
- Dependencies and conflicts with other variants in the same port
- can be expressed with requires and conflicts. See the isset Tcl
- extension.</para>
+ <listitem>
+ <para>The variant declaration may contain any keywords that can be
+ placed in a Portfile's global section. If you wish to execute
+ system (shell) calls or Tcl extensions during the execution of a
+ port phase, you should place those statements within a
+ <literal>variant_isset</literal> conditional within a phase
+ declaration and not within the variant declaration itself.
+ Dependencies and conflicts with other variants in the same port
+ can be expressed with requires and conflicts. See the isset Tcl
+ extension.</para>
- <itemizedlist>
- <listitem>
- <para>Default: no</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: no</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>variant gnome requires glib {
- configure.args-append --with-gnome
- depends_lib-append port:gnome-session
+ <programlisting>variant gnome requires glib {
+ configure.args-append --with-gnome
+ depends_lib-append port:gnome-session
}</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>default_variants</term>
+ <varlistentry>
+ <term>default_variants</term>
- <listitem>
- <para>If variants are defined, then the default_variants value
- lists which variants are enabled by default. This allows for
- Portfile modularity and also allows users to suppress default
- variants if they wish.</para>
+ <listitem>
+ <para>If variants are defined, then the default_variants value
+ lists which variants are enabled by default. This allows for
+ Portfile modularity and also allows users to suppress default
+ variants if they wish.</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>default_variants +ssl +tcpd
+ <programlisting>default_variants +ssl +tcpd
</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>Default variants may be suppressed by preceding a variant
- name with a "-" as shown in this example.</para>
+ <listitem>
+ <para>Default variants may be suppressed by preceding a variant
+ name with a "-" as shown in this example.</para>
- <programlisting><prompt>%%</prompt> <userinput>port install foo -ssl</userinput></programlisting>
- </listitem>
- </varlistentry>
+ <programlisting><prompt>%%</prompt> <userinput>port install foo -ssl</userinput></programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>universal_variant</term>
+ <varlistentry>
+ <term>universal_variant</term>
- <listitem>
- <para>When using MacPorts on Mac OS X, a universal variant is
- defined by default to configure ports with universal flags. The
- variant can be overridden if the default code does not work (see
- the Configure Universal section below), or suppressed if a
- universal variant is not possible for the port with this
- keyword.</para>
+ <listitem>
+ <para>When using MacPorts on Mac OS X, a universal variant is
+ defined by default to configure ports with universal flags. The
+ variant can be overridden if the default code does not work (see
+ the Configure Universal section below), or suppressed if a
+ universal variant is not possible for the port with this
+ keyword.</para>
- <itemizedlist>
- <listitem>
- <para>Default: yes</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: yes</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>universal_variant no</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <programlisting>universal_variant no</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <section>
- <title>Livecheck / Distcheck</title>
+ <section>
+ <title>Livecheck / Distcheck</title>
- <para>Options livecheck and distcheck are especially useful for port
- maintainers, but others may also find this information valuable.</para>
+ <para>Options livecheck and distcheck are especially useful for port
+ maintainers, but others may also find this information valuable.</para>
- <para>Livecheck checks to see if MacPorts can query the developer's
- download site to determine if a newer version of the software has become
- available since the port was installed.</para>
+ <para>Livecheck checks to see if MacPorts can query the developer's
+ download site to determine if a newer version of the software has become
+ available since the port was installed.</para>
- <variablelist>
- <varlistentry>
- <term>livecheck.check</term>
+ <variablelist>
+ <varlistentry>
+ <term>livecheck.check</term>
- <listitem>
- <para>Specify what kind of update check to perform.</para>
+ <listitem>
+ <para>Specify what kind of update check to perform.</para>
- <para>Open source mirror site options are to use the project's
- latest file release from <option>sourceforge</option> or
- <option>googlecode</option>, or the project's
- <literal>date_updated</literal> XML tag for
- <option>freshmeat</option>.</para>
+ <para>Open source mirror site options are to use the project's
+ latest file release from <option>sourceforge</option> or
+ <option>googlecode</option>, or the project's
+ <literal>date_updated</literal> XML tag for
+ <option>freshmeat</option>.</para>
- <para>Generic download site options are to specify a
- <option>moddate</option> (modification date) of a URL resource), a
- <option>regex</option> (retrieve the version by applying a regex
- to a URL resource), <option>regexm</option> (retrieve the version
- by applying a multi-line regex to a URL resource),
- <option>md5</option> (compares the md5 sum of a URL resource) or
- <option>none</option> (no check).</para>
+ <para>Generic download site options are to specify a
+ <option>moddate</option> (modification date) of a URL resource), a
+ <option>regex</option> (retrieve the version by applying a regex
+ to a URL resource), <option>regexm</option> (retrieve the version
+ by applying a multi-line regex to a URL resource),
+ <option>md5</option> (compares the md5 sum of a URL resource) or
+ <option>none</option> (no check).</para>
- <itemizedlist>
- <listitem>
- <para>Default: sourceforge or googlecode if the master_sites
- is one of these, else freshmeat.</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: sourceforge or googlecode if the master_sites
+ is one of these, else freshmeat.</para>
+ </listitem>
- <listitem>
- <para>Values: freshmeat sourceforge googlecode moddate regex
- regexm md5 none</para>
- </listitem>
+ <listitem>
+ <para>Values: freshmeat sourceforge googlecode moddate regex
+ regexm md5 none</para>
+ </listitem>
- <listitem>
- <para>Examples:</para>
+ <listitem>
+ <para>Examples:</para>
- <programlisting>livecheck.check regex
+ <programlisting>livecheck.check regex
livecheck.url http://dev.mysql.com/
livecheck.regex "Generally Available (${major_version}\\.\[0-9.\]+)"
</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>livecheck.name</term>
+ <varlistentry>
+ <term>livecheck.name</term>
- <listitem>
- <para>Name of the project for live checks; only used with
- freshmeat, sourceforge, and googlecode livechecks.</para>
+ <listitem>
+ <para>Name of the project for live checks; only used with
+ freshmeat, sourceforge, and googlecode livechecks.</para>
- <itemizedlist>
- <listitem>
- <para>Default: <varname>${name}</varname> or the
- sourceforge/freshmeat/googlecode project name if it can be
- guessed from <literal>master_sites</literal>.</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${name}</varname> or the
+ sourceforge/freshmeat/googlecode project name if it can be
+ guessed from <literal>master_sites</literal>.</para>
+ </listitem>
- <listitem>
- <para>Values:
- <replaceable>any_project_name</replaceable></para>
- </listitem>
+ <listitem>
+ <para>Values:
+ <replaceable>any_project_name</replaceable></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>livecheck.name hibernate</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>livecheck.name hibernate</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>livecheck.distname</term>
+ <varlistentry>
+ <term>livecheck.distname</term>
- <listitem>
- <para>Name of the file release for sourceforge and googlecode
- checks. You may use this keyword without livecheck.version if you
- replace the version part of the name with "(.*)".</para>
+ <listitem>
+ <para>Name of the file release for sourceforge and googlecode
+ checks. You may use this keyword without livecheck.version if you
+ replace the version part of the name with "(.*)".</para>
- <itemizedlist>
- <listitem>
- <para>Default: SourceForge:
- <varname>${livecheck.name}</varname> ; GoogleCode: first
- ${distfiles} item</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: SourceForge:
+ <varname>${livecheck.name}</varname> ; GoogleCode: first
+ ${distfiles} item</para>
+ </listitem>
- <listitem>
- <para>Values: <replaceable>filename</replaceable></para>
- </listitem>
+ <listitem>
+ <para>Values: <replaceable>filename</replaceable></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>livecheck.distname faad2.src</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>livecheck.distname faad2.src</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>livecheck.version</term>
+ <varlistentry>
+ <term>livecheck.version</term>
- <listitem>
- <para>Version of the project for a check; used for regex-based
- checks.</para>
+ <listitem>
+ <para>Version of the project for a check; used for regex-based
+ checks.</para>
- <itemizedlist>
- <listitem>
- <para>Default: <varname>${version}</varname></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${version}</varname></para>
+ </listitem>
- <listitem>
- <para>Values: <replaceable>any_version</replaceable></para>
- </listitem>
+ <listitem>
+ <para>Values: <replaceable>any_version</replaceable></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>livecheck.version ${name}-${version}</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>livecheck.version ${name}-${version}</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>livecheck.url</term>
+ <varlistentry>
+ <term>livecheck.url</term>
- <listitem>
- <para>URL to query for a check.</para>
+ <listitem>
+ <para>URL to query for a check.</para>
- <itemizedlist>
- <listitem>
- <para>Default:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default:</para>
- <itemizedlist>
- <listitem>
- <para>homepage or the first hit among the following
- sites</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>homepage or the first hit among the following
+ sites</para>
+ </listitem>
- <listitem>
- <para>http://freshmeat.net/projects-xml/${livecheck.name}/${livecheck.name}.xml</para>
- </listitem>
+ <listitem>
+ <para>http://freshmeat.net/projects-xml/${livecheck.name}/${livecheck.name}.xml</para>
+ </listitem>
- <listitem>
- <para>http://sourceforge.net/export/rss2_projfiles.php?project=${livecheck.name}</para>
- </listitem>
+ <listitem>
+ <para>http://sourceforge.net/export/rss2_projfiles.php?project=${livecheck.name}</para>
+ </listitem>
- <listitem>
- <para>http://code.google.com/p/${livecheck.name}/downloads/list</para>
- </listitem>
- </itemizedlist>
- </listitem>
+ <listitem>
+ <para>http://code.google.com/p/${livecheck.name}/downloads/list</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>Values: <replaceable>any_url</replaceable></para>
- </listitem>
+ <listitem>
+ <para>Values: <replaceable>any_url</replaceable></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>livecheck.url http://ftp.gnu.org/gnu/bison/</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>livecheck.url http://ftp.gnu.org/gnu/bison/</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>livecheck.regex</term>
+ <varlistentry>
+ <term>livecheck.regex</term>
- <listitem>
- <para>Regular expression to parse the resource for regex checks.
- Be sure to use a regular expression grouping around the version
- component.</para>
+ <listitem>
+ <para>Regular expression to parse the resource for regex checks.
+ Be sure to use a regular expression grouping around the version
+ component.</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
- <listitem>
- <para>Values: <replaceable>any_regex</replaceable></para>
- </listitem>
+ <listitem>
+ <para>Values: <replaceable>any_regex</replaceable></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>livecheck.regex 4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>livecheck.regex 4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>livecheck.md5</term>
+ <varlistentry>
+ <term>livecheck.md5</term>
- <listitem>
- <para>md5 checksum to use for an md5 comparison.</para>
+ <listitem>
+ <para>md5 checksum to use for an md5 comparison.</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
- <listitem>
- <para>Values:
- <replaceable>any_md5_checksum</replaceable></para>
- </listitem>
+ <listitem>
+ <para>Values:
+ <replaceable>any_md5_checksum</replaceable></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>livecheck md5 37e6a5b6516a680c7178b72021d3b706</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
+ <programlisting>livecheck md5 37e6a5b6516a680c7178b72021d3b706</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <para>Distcheck reports whether or not the distfile(s) specified in a
- Portfile are still available on the developer's download site. Examples
- are given below.</para>
+ <para>Distcheck reports whether or not the distfile(s) specified in a
+ Portfile are still available on the developer's download site. Examples
+ are given below.</para>
- <variablelist>
- <varlistentry>
- <term>distcheck.check</term>
+ <variablelist>
+ <varlistentry>
+ <term>distcheck.check</term>
- <listitem>
- <para>This option can be used to disable distcheck. It specifies
- what kind of check should be performed on distfiles: moddate
- (check if the Portfile is older than the distfile) or none (no
- check).</para>
+ <listitem>
+ <para>This option can be used to disable distcheck. It specifies
+ what kind of check should be performed on distfiles: moddate
+ (check if the Portfile is older than the distfile) or none (no
+ check).</para>
- <itemizedlist>
- <listitem>
- <para>Default: moddate</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: moddate</para>
+ </listitem>
- <listitem>
- <para>Values: moddate none</para>
- </listitem>
+ <listitem>
+ <para>Values: moddate none</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>distcheck.check none</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <programlisting>distcheck.check none</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
+</section>
Modified: trunk/doc-new/guide/xml/portfile-global-variables.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-global-variables.7.xml 2007-11-30 18:25:42 UTC (rev 31620)
+++ trunk/doc-new/guide/xml/portfile-global-variables.7.xml 2007-11-30 19:09:37 UTC (rev 31621)
@@ -2,143 +2,143 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
- <section>
- <title>Global Variables</title>
+<section>
+ <title>Global Variables</title>
- <para>Global variables are variables available to any Portfile. For a list
- of additional variables available to ports that are assigned to a MacPorts
- Portgroup, see portgroup(7).</para>
+ <para>Global variables are variables available to any Portfile. For a list
+ of additional variables available to ports that are assigned to a MacPorts
+ Portgroup, see portgroup(7).</para>
- <variablelist>
- <varlistentry>
- <term>prefix</term>
+ <variablelist>
+ <varlistentry>
+ <term>prefix</term>
- <listitem>
- <para>Installation prefix, set in
- <filename>${prefix}/etc/macports/macports.conf</filename> —may be
- overridden on a per port basis. For example, aqua applications are
- installed in <filename>/Applications/MacPorts</filename>.</para>
+ <listitem>
+ <para>Installation prefix, set in
+ <filename>${prefix}/etc/macports/macports.conf</filename> —may be
+ overridden on a per port basis. For example, aqua applications are
+ installed in <filename>/Applications/MacPorts</filename>.</para>
- <para>Default: /opt/local</para>
- </listitem>
- </varlistentry>
+ <para>Default: /opt/local</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>binpath</term>
+ <varlistentry>
+ <term>binpath</term>
- <listitem>
- <para>Default PATH to use in finding executables.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Default PATH to use in finding executables.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>libpath</term>
+ <varlistentry>
+ <term>libpath</term>
- <listitem>
- <para>Path to the MacPorts TCL libraries.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Path to the MacPorts TCL libraries.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>portpath</term>
+ <varlistentry>
+ <term>portpath</term>
- <listitem>
- <para>Full path to the Portfile location.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Full path to the Portfile location.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>filesdir</term>
+ <varlistentry>
+ <term>filesdir</term>
- <listitem>
- <para>Path to port files relative to
- <varname>${portpath}</varname>.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Path to port files relative to
+ <varname>${portpath}</varname>.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>workpath</term>
+ <varlistentry>
+ <term>workpath</term>
- <listitem>
- <para>Full path to work directory.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Full path to work directory.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>worksrcpath</term>
+ <varlistentry>
+ <term>worksrcpath</term>
- <listitem>
- <para>Full path to extracted source code. Equivalent to
- <varname>${workpath}/${worksrcdir}</varname>.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Full path to extracted source code. Equivalent to
+ <varname>${workpath}/${worksrcdir}</varname>.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>destroot</term>
+ <varlistentry>
+ <term>destroot</term>
- <listitem>
- <para>Full path into which software will be destrooted. Equivalent
- to <filename>${workpath}/destroot</filename>.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Full path into which software will be destrooted. Equivalent
+ to <filename>${workpath}/destroot</filename>.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>distpath</term>
+ <varlistentry>
+ <term>distpath</term>
- <listitem>
- <para>Location to store downloaded distfiles.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Location to store downloaded distfiles.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>install.user</term>
+ <varlistentry>
+ <term>install.user</term>
- <listitem>
- <para>The Unix user at the time of port installation.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>The Unix user at the time of port installation.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>install.group</term>
+ <varlistentry>
+ <term>install.group</term>
- <listitem>
- <para>The Unix group at the time of port installation.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>The Unix group at the time of port installation.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>os.platform</term>
+ <varlistentry>
+ <term>os.platform</term>
- <listitem>
- <para>Identifies platform type (ie, "darwin", "freebsd",
- etc).</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Identifies platform type (ie, "darwin", "freebsd",
+ etc).</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>os.arch</term>
+ <varlistentry>
+ <term>os.arch</term>
- <listitem>
- <para>Identifies hardware type (ie, "powerpc", "intel").</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Identifies hardware type (ie, "powerpc", "intel").</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>os.version</term>
+ <varlistentry>
+ <term>os.version</term>
- <listitem>
- <para>The version number of the host operating system (ie "8.0" for
- Darwin 8.0).</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>The version number of the host operating system (ie "8.0" for
+ Darwin 8.0).</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>os.major</term>
+ <varlistentry>
+ <term>os.major</term>
- <listitem>
- <para>The major version number of the host operating system (ie "8"
- for Darwin 8.0).</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <listitem>
+ <para>The major version number of the host operating system (ie "8"
+ for Darwin 8.0).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</section>
Modified: trunk/doc-new/guide/xml/portfile-phase.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-phase.7.xml 2007-11-30 18:25:42 UTC (rev 31620)
+++ trunk/doc-new/guide/xml/portfile-phase.7.xml 2007-11-30 19:09:37 UTC (rev 31621)
@@ -2,8 +2,8 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
- <section>
- <title>Port Phases</title>
+<section>
+ <title>Port Phases</title>
<section>
<title>Installation Phase Keywords</title>
@@ -122,1872 +122,1873 @@
</section>
- <section>
- <title>Fetch Phase Keywords</title>
+ <section>
+ <title>Fetch Phase Keywords</title>
- <para>The list of keywords related to the fetch phase.</para>
+ <para>The list of keywords related to the fetch phase.</para>
- <variablelist>
- <varlistentry>
- <term>master_sites</term>
+ <variablelist>
+ <varlistentry>
+ <term>master_sites</term>
- <listitem>
- <para>A list of URLs from which a port's download file(s) may be
- retrieved. For multiple master_sites, they are searched in order
- until a file matching <varname>${distfile}</varname> is
- found.</para>
+ <listitem>
+ <para>A list of URLs from which a port's download file(s) may be
+ retrieved. For multiple master_sites, they are searched in order
+ until a file matching <varname>${distfile}</varname> is
+ found.</para>
- <itemizedlist>
- <listitem>
- <para>Default: ???</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
- <listitem>
- <para>Examples:</para>
+ <listitem>
+ <para>Examples:</para>
- <programlisting>master_sites http://www.somesite.org/files/ \
+ <programlisting>master_sites http://www.somesite.org/files/ \
http://www.somemirror.org/somesite_org/files/
</programlisting>
- <para>You may also use mirror site lists predefined by
- MacPorts. Here the sourceforge and gnu mirrors are
- used.</para>
+ <para>You may also use mirror site lists predefined by
+ MacPorts. Here the sourceforge and gnu mirrors are
+ used.</para>
- <programlisting>master_sites sourceforge gnu
+ <programlisting>master_sites sourceforge gnu
</programlisting>
- <para>When using mirror master_sites, the subdirectory
- <varname>${name}</varname> is checked on every mirror. If the
- mirror subdirectory does not match ${name}, then you may
- specify it using after the mirror separated by a colon.</para>
+ <para>When using mirror master_sites, the subdirectory
+ <varname>${name}</varname> is checked on every mirror. If the
+ mirror subdirectory does not match ${name}, then you may
+ specify it using after the mirror separated by a colon.</para>
- <programlisting>master_sites sourceforge:widget \
+ <programlisting>master_sites sourceforge:widget \
gnu:widget
</programlisting>
- <para>For ports that must fetch multiple download files from
- different locations, you must label the files with tags and
- match the tags in a distfiles statement. The format is
- <literal>mirror:subdirectory:tag</literal>.</para>
+ <para>For ports that must fetch multiple download files from
+ different locations, you must label the files with tags and
+ match the tags in a distfiles statement. The format is
+ <literal>mirror:subdirectory:tag</literal>.</para>
- <para>In the example below, file_one.tar.gz is fetched from
- sourceforge mirrors in subdirectory
- <varname>${name}</varname>; file tagtwo.tar.gz is fetched from
- the gnu mirrors in subdirectory sources.</para>
+ <para>In the example below, file_one.tar.gz is fetched from
+ sourceforge mirrors in subdirectory
+ <varname>${name}</varname>; file tagtwo.tar.gz is fetched from
+ the gnu mirrors in subdirectory sources.</para>
- <programlisting>master_sites sourceforge::tagone \
+ <programlisting>master_sites sourceforge::tagone \
gnu:sources:tagtwo
distfiles file_one.tar.gz:tagone \
file_two.tar.gz:tagtwo</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>patch_sites</term>
+ <varlistentry>
+ <term>patch_sites</term>
- <listitem>
- <para>A list of sites from which a port's patchfiles may be
- downloaded, where applicable.</para>
+ <listitem>
+ <para>A list of sites from which a port's patchfiles may be
+ downloaded, where applicable.</para>
- <itemizedlist>
- <listitem>
- <para>Default: <varname>${master_sites}</varname></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${master_sites}</varname></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>patch_sites ftp://ftp.patchcityrepo.com/pub/magic/patches</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>patch_sites ftp://ftp.patchcityrepo.com/pub/magic/patches</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>distname</term>
+
+ <listitem>
+ <para>The name of the distribution filename, not including the
+ extract suffix.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${name}-${version}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>distname ${name}</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>distfiles</term>
+
+ <listitem>
+ <para>The full distribution filename, including the extract
+ suffix. Used to specify non-default distribution filenames; this
+ keyword must be specified (and tags used) when a port has multiple
+ download files (see master_sites).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default:
+ <varname>${distname}${extract.suffix}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>distfiles ${name}-dev_src.tgz
+
+
+distfiles file_one.tar.gz:tagone \
+ file_two.tar.gz:tagtwo</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>extract.suffix</term>
+
+ <listitem>
+ <para>This keyword is used to specify the extract suffix
+ type.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <filename>.tar.gz</filename></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>extract.suffix .tgz</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>extract.mkdir</term>
+
+ <listitem>
+ <para>This option is used to specify if the directory
+ <filename>worksrcdir</filename> is part of the distfile or if it
+ should be created automatically and the distfiles should be
+ extracted there instead. This is useful for distfiles with a flat
+ structure which would pollute the <filename>worksrcdir</filename>
+ with lots of files.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>extract.mkdir yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>use_bzip2</term>
+
+ <listitem>
+ <para>This keyword is for downloads that are tarred and bzipped.
+ When invoked, it automatically sets:</para>
+
+ <literallayout>extract.suffix = .tar.bz
+extract.cmd = bzip
+
+</literallayout>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>use_bzip2 yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>use_zip</term>
+
+ <listitem>
+ <para>This keyword is for downloads are zipped. When invoked, it
+ automatically sets:</para>
+
+ <literallayout>extract.suffix = .zip
+extract.cmd = unzip
+extract.pre_args = -q
+extract.post_args = "-d ${portpath}/${workdir}"
+
+</literallayout>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>use_zip yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <section>
+ <title>Fetch from CVS</title>
+
+ <para><ulink url="http://www.nongnu.org/cvs/">CVS</ulink> may be used
+ as an alternative method of fetching distribution files using the
+ keywords in this section. However, fetching via CVS may cause
+ non-reproducible builds, so it is strongly discouraged.</para>
+
+ <variablelist>
<varlistentry>
- <term>distname</term>
+ <term>cvs.root</term>
<listitem>
- <para>The name of the distribution filename, not including the
- extract suffix.</para>
+ <para>Specify the url from which to fetch files.</para>
<itemizedlist>
<listitem>
- <para>Default: <varname>${name}-${version}</varname></para>
+ <para>Default: none</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>distname ${name}</programlisting>
+ <programlisting>cvs.root :pserver:anonymous at cvs.sv.gnu.org:/sources/emacs</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>distfiles</term>
+ <term>cvs.tag</term>
<listitem>
- <para>The full distribution filename, including the extract
- suffix. Used to specify non-default distribution filenames; this
- keyword must be specified (and tags used) when a port has multiple
- download files (see master_sites).</para>
+ <para>Optional for fetching with CVS, this specifies the code
+ revision to checkout.</para>
<itemizedlist>
<listitem>
- <para>Default:
- <varname>${distname}${extract.suffix}</varname></para>
+ <para>Default: none</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>distfiles ${name}-dev_src.tgz
-
-
-distfiles file_one.tar.gz:tagone \
- file_two.tar.gz:tagtwo</programlisting>
+ <programlisting>cvs.tag HEAD</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>extract.suffix</term>
+ <term>cvs.date</term>
<listitem>
- <para>This keyword is used to specify the extract suffix
- type.</para>
+ <para>A date that identifies the CVS code set to
+ checkout.</para>
<itemizedlist>
<listitem>
- <para>Default: <filename>.tar.gz</filename></para>
+ <para>Default: none</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>extract.suffix .tgz</programlisting>
+ <programlisting>cvs.date "12-April-2007"</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>extract.mkdir</term>
+ <term>cvs.module</term>
<listitem>
- <para>This option is used to specify if the directory
- <filename>worksrcdir</filename> is part of the distfile or if it
- should be created automatically and the distfiles should be
- extracted there instead. This is useful for distfiles with a flat
- structure which would pollute the <filename>worksrcdir</filename>
- with lots of files.</para>
+ <para>A CVS module from which to check out the code.</para>
<itemizedlist>
<listitem>
- <para>Default: <option>no</option></para>
+ <para>Default: none</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>extract.mkdir yes</programlisting>
+ <programlisting>cvs.module Sources</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
+ </variablelist>
+ </section>
+ <section>
+ <title>Fetch from Subversion</title>
+
+ <para><ulink url="http://subversion.tigris.org/">Subversion</ulink>
+ may be used as an alternative method of fetching distribution files
+ using the keywords in this section. However, fetching via Subversion
+ may cause non-reproducible builds, so it is strongly
+ discouraged.</para>
+
+ <variablelist>
<varlistentry>
- <term>use_bzip2</term>
+ <term>svn.url</term>
<listitem>
- <para>This keyword is for downloads that are tarred and bzipped.
- When invoked, it automatically sets:</para>
+ <para>This specifies the url from which to fetch files.</para>
- <literallayout>extract.suffix = .tar.bz
-extract.cmd = bzip
-
-</literallayout>
-
<itemizedlist>
<listitem>
- <para>Default: <option>no</option></para>
+ <para>Default: none</para>
</listitem>
<listitem>
- <para>Example:</para>
+ <para>Examples:</para>
- <programlisting>use_bzip2 yes</programlisting>
+ <programlisting>svn.url http://www.domain.com/svn-repo/mydirectory
+svn.url svn://www.domain.com/svn-repo/mydirectory
+</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>use_zip</term>
+ <term>svn.tag</term>
<listitem>
- <para>This keyword is for downloads are zipped. When invoked, it
- automatically sets:</para>
+ <para>Optional tag for fetching with Subversion, this specifies
+ the code revision to checkout; it corresponds to the -r option
+ in the svn cli. You must use backslashes to escape characters
+ that are meaningful to the Tcl interpreter, such as braces and
+ double quotes.</para>
- <literallayout>extract.suffix = .zip
-extract.cmd = unzip
-extract.pre_args = -q
-extract.post_args = "-d ${portpath}/${workdir}"
-
-</literallayout>
-
<itemizedlist>
<listitem>
- <para>Default: <option>no</option></para>
+ <para>Default: none</para>
</listitem>
<listitem>
- <para>Example:</para>
+ <para>Examples:</para>
- <programlisting>use_zip yes</programlisting>
+ <programlisting>svn.tag 37192
+svn.tag \{\"2006-02-17 15:30 +0230\"\}</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
+ </section>
+ </section>
- <section>
- <title>Fetch from CVS</title>
+ <section>
+ <title>Checksum Phase Keywords</title>
- <para><ulink url="http://www.nongnu.org/cvs/">CVS</ulink> may be used
- as an alternative method of fetching distribution files using the
- keywords in this section. However, fetching via CVS may cause
- non-reproducible builds, so it is strongly discouraged.</para>
+ <para>The list of keywords related to the checksum phase.</para>
- <variablelist>
- <varlistentry>
- <term>cvs.root</term>
+ <variablelist>
+ <varlistentry>
+ <term>checksums</term>
+ <listitem>
+ <para>Checksum(s) of the distribution files. For ports with
+ multiple distribution files, filenames must be included to
+ associate files with their checksums.</para>
+
+ <itemizedlist>
<listitem>
- <para>Specify the url from which to fetch files.</para>
+ <para>Default: ???</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <listitem>
+ <para>Examples:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>checksums md5 dafa161bc9c61e57636a6085c87c1fe8 \
+ sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
+ rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23</programlisting>
- <programlisting>cvs.root :pserver:anonymous at cvs.sv.gnu.org:/sources/emacs</programlisting>
- </listitem>
- </itemizedlist>
+ <programlisting>checksums ${distname}${extract.suffix} md5 dafa161bc9c61e57636a6085c87c1fe8 \
+ sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
+ rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23 \
+ hobbit.tar.gz md5 3b8d02c6cf6239b9bdadbc6543c5a683 \
+ sha1 27874638b23e66d39ed94fe716ca25c967f6e993 \
+ rmd160 82b9991f3bf0ceedbf74c188c5fa44b98b5e40c9</programlisting>
</listitem>
- </varlistentry>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <varlistentry>
- <term>cvs.tag</term>
+ <section>
+ <title>Extract Phase Keywords</title>
- <listitem>
- <para>Optional for fetching with CVS, this specifies the code
- revision to checkout.</para>
+ <para>The list of keywords related to the extract phase.</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <variablelist>
+ <varlistentry>
+ <term>extract.only</term>
- <listitem>
- <para>Example:</para>
+ <term>extract.only-append</term>
- <programlisting>cvs.tag HEAD</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <term>extract.only-delete</term>
- <varlistentry>
- <term>cvs.date</term>
+ <listitem>
+ <para>List of files to extract into
+ <varname>${worksrcpath}</varname>; the default is
+ <varname>${distfiles}</varname>. Only use if default extract
+ behavior is not correct for your port.</para>
+ <itemizedlist>
<listitem>
- <para>A date that identifies the CVS code set to
- checkout.</para>
+ <para>Default: none</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>extract.only foo.tar.gz
- <programlisting>cvs.date "12-April-2007"</programlisting>
- </listitem>
- </itemizedlist>
+</programlisting>
</listitem>
- </varlistentry>
+ </itemizedlist>
+ </listitem>
- <varlistentry>
- <term>cvs.module</term>
+ <listitem>
+ <para>List modifier examples:</para>
- <listitem>
- <para>A CVS module from which to check out the code.</para>
+ <programlisting>extract.only-append bar.tar.gz
+extract.only-delete foo.tar.gz</programlisting>
+ </listitem>
+ </varlistentry>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <varlistentry>
+ <term>extract.cmd</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Command to perform extraction.</para>
- <programlisting>cvs.module Sources</programlisting>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Default: gzip</para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section>
- <title>Fetch from Subversion</title>
+ <listitem>
+ <para>Example:</para>
- <para><ulink url="http://subversion.tigris.org/">Subversion</ulink>
- may be used as an alternative method of fetching distribution files
- using the keywords in this section. However, fetching via Subversion
- may cause non-reproducible builds, so it is strongly
- discouraged.</para>
+ <programlisting>extract.cmd gunzip</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <variablelist>
- <varlistentry>
- <term>svn.url</term>
+ <varlistentry>
+ <term>extract.args</term>
+ <term>extract.pre_args</term>
+
+ <term>extract.post_args</term>
+
+ <listitem>
+ <para>Main arguments to extract.cmd; additional arguments passed
+ before and after the main arguments.</para>
+
+ <itemizedlist>
<listitem>
- <para>This specifies the url from which to fetch files.</para>
+ <para>Default: ${distpath}/${distfile}</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Examples:</para>
+ <programlisting>extract.args ${distpath}/${distfile}
- <programlisting>svn.url http://www.domain.com/svn-repo/mydirectory
-svn.url svn://www.domain.com/svn-repo/mydirectory
</programlisting>
- </listitem>
- </itemizedlist>
</listitem>
- </varlistentry>
+ </itemizedlist>
+ </listitem>
- <varlistentry>
- <term>svn.tag</term>
+ <listitem>
+ <para>The following argument modifiers are available:</para>
+ <itemizedlist>
<listitem>
- <para>Optional tag for fetching with Subversion, this specifies
- the code revision to checkout; it corresponds to the -r option
- in the svn cli. You must use backslashes to escape characters
- that are meaningful to the Tcl interpreter, such as braces and
- double quotes.</para>
+ <para>extract.pre_args default: "-dc"</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <listitem>
+ <para>extract.post_args default: " | tar -xf"</para>
+ </listitem>
- <listitem>
- <para>Examples:</para>
+ <listitem>
+ <para>Examples:</para>
- <programlisting>svn.tag 37192
-svn.tag \{\"2006-02-17 15:30 +0230\"\}</programlisting>
- </listitem>
- </itemizedlist>
+ <programlisting>extract.pre_args xf
+extract.post_args "| gnutar –x"</programlisting>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
- </section>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <section>
- <title>Checksum Phase Keywords</title>
+ <section>
+ <title>Patch Phase Keywords</title>
- <para>The list of keywords related to the checksum phase.</para>
+ <para>The list of keywords related to the patch phase.</para>
- <variablelist>
- <varlistentry>
- <term>checksums</term>
+ <variablelist>
+ <varlistentry>
+ <term>patch.dir</term>
- <listitem>
- <para>Checksum(s) of the distribution files. For ports with
- multiple distribution files, filenames must be included to
- associate files with their checksums.</para>
+ <listitem>
+ <para>Specify the base path for patch files.</para>
- <itemizedlist>
- <listitem>
- <para>Default: ???</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${worksrcpath}</varname></para>
+ </listitem>
- <listitem>
- <para>Examples:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>checksums md5 dafa161bc9c61e57636a6085c87c1fe8 \
- sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
- rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23</programlisting>
+ <programlisting>patch.dir ${worksrcpath}/util</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <programlisting>checksums ${distname}${extract.suffix} md5 dafa161bc9c61e57636a6085c87c1fe8 \
- sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
- rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23 \
- hobbit.tar.gz md5 3b8d02c6cf6239b9bdadbc6543c5a683 \
- sha1 27874638b23e66d39ed94fe716ca25c967f6e993 \
- rmd160 82b9991f3bf0ceedbf74c188c5fa44b98b5e40c9</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <varlistentry>
+ <term>patch.cmd</term>
- <section>
- <title>Extract Phase Keywords</title>
+ <listitem>
+ <para>Specify the command to be used for patching files.</para>
- <para>The list of keywords related to the extract phase.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <command>patch</command></para>
+ </listitem>
- <variablelist>
- <varlistentry>
- <term>extract.only</term>
+ <listitem>
+ <para>Example:</para>
- <term>extract.only-append</term>
+ <programlisting>patch.cmd cat</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <term>extract.only-delete</term>
+ <varlistentry>
+ <term>patchfiles</term>
- <listitem>
- <para>List of files to extract into
- <varname>${worksrcpath}</varname>; the default is
- <varname>${distfiles}</varname>. Only use if default extract
- behavior is not correct for your port.</para>
+ <term>patchfiles-append</term>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <term>patchfiles-delete</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Specify patch files to be applied for a port; list modifiers
+ specify patchfiles to be added or removed from a previous
+ patchfile declaration.</para>
- <programlisting>extract.only foo.tar.gz
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>patchfiles patch-Makefile.in \
+ patch-source.c
+
</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>List modifier examples:</para>
+ <listitem>
+ <para>List modifier examples:</para>
- <programlisting>extract.only-append bar.tar.gz
-extract.only-delete foo.tar.gz</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>patchfiles-append patch-configure
+patchfiles-delete patch-src-Makefile.in
+</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>extract.cmd</term>
+ <varlistentry>
+ <term>patch.args</term>
- <listitem>
- <para>Command to perform extraction.</para>
+ <term>patch.pre_args</term>
- <itemizedlist>
- <listitem>
- <para>Default: gzip</para>
- </listitem>
+ <term>patch.post_args</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Main arguments to patch.cmd; optional argument modifiers
+ pass arguments before and after the main arguments.</para>
- <programlisting>extract.cmd gunzip</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
- <varlistentry>
- <term>extract.args</term>
+ <listitem>
+ <para>Example:</para>
- <term>extract.pre_args</term>
+ <programlisting>patch.args ???
- <term>extract.post_args</term>
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>Main arguments to extract.cmd; additional arguments passed
- before and after the main arguments.</para>
+ <listitem>
+ <para>The following argument modifiers are available:</para>
- <itemizedlist>
- <listitem>
- <para>Default: ${distpath}/${distfile}</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>patch.pre_args default: -p0</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>patch.post_args default: none</para>
+ </listitem>
- <programlisting>extract.args ${distpath}/${distfile}
+ <listitem>
+ <para>Examples:</para>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ <programlisting>patch.pre_args -p1
+patch.post_args ???</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <listitem>
- <para>The following argument modifiers are available:</para>
+ <section>
+ <title>Configure Phase Keywords</title>
- <itemizedlist>
- <listitem>
- <para>extract.pre_args default: "-dc"</para>
- </listitem>
+ <para>The list of keywords related to the configure phase.</para>
- <listitem>
- <para>extract.post_args default: " | tar -xf"</para>
- </listitem>
+ <para>MacPorts base sets some important default configure options, so
+ should use the -append version of most configure keywords so you don't
+ overwrite them. For example, MacPorts base sets default
+ <literal>configure.cflags</literal> so you should always use
+ <literal>configure.cflags-append</literal> to set additional CFLAGS in
+ Portfiles.</para>
- <listitem>
- <para>Examples:</para>
+ <variablelist>
+ <varlistentry>
+ <term>configure.env</term>
- <programlisting>extract.pre_args xf
-extract.post_args "| gnutar –x"</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <term>configure.env-append</term>
- <section>
- <title>Patch Phase Keywords</title>
+ <term>configure.env-delete</term>
- <para>The list of keywords related to the patch phase.</para>
+ <listitem>
+ <para>Set environment variables for configure; list modifiers add
+ and delete items from a previous Portfile configure.env keyword,
+ or a default set by MacPorts base. If available, it is encouraged
+ to use the predefined options (like configure.cflags) instead of
+ modifying configure.env directly</para>
- <variablelist>
- <varlistentry>
- <term>patch.dir</term>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>CFLAGS=-I${prefix}/include
+ LDFLAGS=-L${prefix}/lib</literal></para>
+ </listitem>
- <listitem>
- <para>Specify the base path for patch files.</para>
+ <listitem>
+ <para>Example:</para>
- <itemizedlist>
- <listitem>
- <para>Default: <varname>${worksrcpath}</varname></para>
- </listitem>
+ <programlisting>configure.env QTDIR=${prefix}/lib/qt3
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>List modifier examples:</para>
- <programlisting>patch.dir ${worksrcpath}/util</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>configure.env-append ABI=32
+configure.env-delete TCLROOT=${prefix}</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>patch.cmd</term>
+ <varlistentry>
+ <term>configure.cflags</term>
- <listitem>
- <para>Specify the command to be used for patching files.</para>
+ <term>configure.cflags-append</term>
- <itemizedlist>
- <listitem>
- <para>Default: <command>patch</command></para>
- </listitem>
+ <term>configure.cflags-delete</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Set CFLAGS compiler flags; list modifiers add or delete
+ items from a previous Portfile configure.cflags keyword or the
+ default set by MacPorts base.</para>
- <programlisting>patch.cmd cat</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-O2</literal></para>
+ </listitem>
- <varlistentry>
- <term>patchfiles</term>
+ <listitem>
+ <para>Example:</para>
- <term>patchfiles-append</term>
+ <programlisting>configure.cflags -Os -flat_namespace
- <term>patchfiles-delete</term>
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>Specify patch files to be applied for a port; list modifiers
- specify patchfiles to be added or removed from a previous
- patchfile declaration.</para>
+ <listitem>
+ <para>List modifier examples:</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <programlisting>configure.cflags-append "-undefined suppress"
+configure.cflags-delete -O2</programlisting>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Example:</para>
+ <varlistentry>
+ <term>configure.ldflags</term>
- <programlisting>patchfiles patch-Makefile.in \
- patch-source.c
+ <term>configure.ldflags-append</term>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ <term>configure.ldflags-delete</term>
- <listitem>
- <para>List modifier examples:</para>
+ <listitem>
+ <para>Set LDFLAGS compiler flags; list modifiers add or delete
+ items from a previous Portfile configure.ldflags keyword or the
+ default set by MacPorts base.</para>
- <programlisting>patchfiles-append patch-configure
-patchfiles-delete patch-src-Makefile.in
-</programlisting>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-L${prefix}/lib</literal></para>
+ </listitem>
- <varlistentry>
- <term>patch.args</term>
+ <listitem>
+ <para>Example:</para>
- <term>patch.pre_args</term>
+ <programlisting>configure.ldflags -L${worksrcpath}/zlib -lz
- <term>patch.post_args</term>
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>Main arguments to patch.cmd; optional argument modifiers
- pass arguments before and after the main arguments.</para>
+ <listitem>
+ <para>List modifier examples:</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <programlisting>configure.ldflags-append "-L/usr/X11R6/lib -L${worksrcpath}/lib"
+configure.ldflags-delete -L${prefix}/lib/db44</programlisting>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Example:</para>
+ <varlistentry>
+ <term>configure.cppflags</term>
- <programlisting>patch.args ???
+ <term>configure.cppflags-append</term>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ <term>configure.cppflags-delete</term>
- <listitem>
- <para>The following argument modifiers are available:</para>
+ <listitem>
+ <para>Set CPPFLAGS to be passed to the C processor; list modifiers
+ add or delete items from a previous Portfile configure.cppflags
+ keyword or the default set by MacPorts base.</para>
- <itemizedlist>
- <listitem>
- <para>patch.pre_args default: -p0</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-I${prefix}/include</literal></para>
+ </listitem>
- <listitem>
- <para>patch.post_args default: none</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Examples:</para>
+ <programlisting>configure.cppflags -I${worksrcpath}/include
- <programlisting>patch.pre_args -p1
-patch.post_args ???</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <section>
- <title>Configure Phase Keywords</title>
+ <listitem>
+ <para>List modifier examples:</para>
- <para>The list of keywords related to the configure phase.</para>
+ <programlisting>configure.cppflags-append "-I/usr/X11R6/lib -I${worksrcpath}/lib -DHAVE_RRD_12X"
+configure.cppflags-delete -I${prefix}/lib/db44</programlisting>
+ </listitem>
+ </varlistentry>
- <para>MacPorts base sets some important default configure options, so
- should use the -append version of most configure keywords so you don't
- overwrite them. For example, MacPorts base sets default
- <literal>configure.cflags</literal> so you should always use
- <literal>configure.cflags-append</literal> to set additional CFLAGS in
- Portfiles.</para>
+ <!-- fortran compiler options -->
- <variablelist>
- <varlistentry>
- <term>configure.env</term>
+ <varlistentry>
+ <term>configure.fflags</term>
- <term>configure.env-append</term>
+ <term>configure.fflags-append</term>
- <term>configure.env-delete</term>
+ <term>configure.fflags-delete</term>
- <listitem>
- <para>Set environment variables for configure; list modifiers add
- and delete items from a previous Portfile configure.env keyword,
- or a default set by MacPorts base. If available, it is encouraged
- to use the predefined options (like configure.cflags) instead of
- modifying configure.env directly</para>
+ <listitem>
+ <para>Set FFLAGS to be passed to the Fortran compiler; list
+ modifiers add or delete items from a previous Portfile
+ configure.fflags keyword or the default set by MacPorts
+ base.</para>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>CFLAGS=-I${prefix}/include
- LDFLAGS=-L${prefix}/lib</literal></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-O2</literal></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>configure.env QTDIR=${prefix}/lib/qt3
+ <programlisting>configure.fflags -Os
+
</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>List modifier examples:</para>
+ <varlistentry>
+ <term>configure.fcflags</term>
- <programlisting>configure.env-append ABI=32
-configure.env-delete TCLROOT=${prefix}</programlisting>
- </listitem>
- </varlistentry>
+ <term>configure.fcflags-append</term>
- <varlistentry>
- <term>configure.cflags</term>
+ <term>configure.fcflags-delete</term>
- <term>configure.cflags-append</term>
+ <listitem>
+ <para>Set FCFLAGS to be passed to the Fortran compiler; list
+ modifiers add or delete items from a previous Portfile
+ configure.fcflags keyword or the default set by MacPorts
+ base.</para>
- <term>configure.cflags-delete</term>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-O2</literal></para>
+ </listitem>
- <listitem>
- <para>Set CFLAGS compiler flags; list modifiers add or delete
- items from a previous Portfile configure.cflags keyword or the
- default set by MacPorts base.</para>
+ <listitem>
+ <para>Example:</para>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>-O2</literal></para>
- </listitem>
+ <programlisting>configure.fcflags -Os
- <listitem>
- <para>Example:</para>
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <programlisting>configure.cflags -Os -flat_namespace
+ <varlistentry>
+ <term>configure.f90flags</term>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ <term>configure.f90flags-append</term>
- <listitem>
- <para>List modifier examples:</para>
+ <term>configure.f90flags-delete</term>
- <programlisting>configure.cflags-append "-undefined suppress"
-configure.cflags-delete -O2</programlisting>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Set F90FLAGS to be passed to the Fortran 90 compiler; list
+ modifiers add or delete items from a previous Portfile
+ configure.f90flags keyword or the default set by MacPorts
+ base.</para>
- <varlistentry>
- <term>configure.ldflags</term>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-O2</literal></para>
+ </listitem>
- <term>configure.ldflags-append</term>
+ <listitem>
+ <para>Example:</para>
- <term>configure.ldflags-delete</term>
+ <programlisting>configure.f90flags -Os
- <listitem>
- <para>Set LDFLAGS compiler flags; list modifiers add or delete
- items from a previous Portfile configure.ldflags keyword or the
- default set by MacPorts base.</para>
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>-L${prefix}/lib</literal></para>
- </listitem>
+ <!-- fortran compiler options end -->
- <listitem>
- <para>Example:</para>
+ <!-- compiler selection arguments -->
- <programlisting>configure.ldflags -L${worksrcpath}/zlib -lz
+ <varlistentry>
+ <term>configure.cc</term>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ <listitem>
+ <para>Set CC compiler flags for selecting a C compiler;</para>
- <listitem>
- <para>List modifier examples:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <programlisting>configure.ldflags-append "-L/usr/X11R6/lib -L${worksrcpath}/lib"
-configure.ldflags-delete -L${prefix}/lib/db44</programlisting>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Example:</para>
- <varlistentry>
- <term>configure.cppflags</term>
+ <programlisting>configure.cc ${prefix}/bin/gcc-mp-4.2</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <term>configure.cppflags-append</term>
+ <varlistentry>
+ <term>configure.cpp</term>
- <term>configure.cppflags-delete</term>
+ <listitem>
+ <para>Set CPP compiler flags for selecting a C
+ preprocessor;</para>
- <listitem>
- <para>Set CPPFLAGS to be passed to the C processor; list modifiers
- add or delete items from a previous Portfile configure.cppflags
- keyword or the default set by MacPorts base.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>-I${prefix}/include</literal></para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>configure.cpp /usr/bin/cpp-3.3</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <programlisting>configure.cppflags -I${worksrcpath}/include
+ <varlistentry>
+ <term>configure.cxx</term>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ <listitem>
+ <para>Set CXX compiler flags for selecting a C++ compiler;</para>
- <listitem>
- <para>List modifier examples:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <programlisting>configure.cppflags-append "-I/usr/X11R6/lib -I${worksrcpath}/lib -DHAVE_RRD_12X"
-configure.cppflags-delete -I${prefix}/lib/db44</programlisting>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Example:</para>
- <!-- fortran compiler options -->
+ <programlisting>configure.cpp /usr/bin/g++-4.0</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>configure.fflags</term>
+ <varlistentry>
+ <term>configure.objc</term>
- <term>configure.fflags-append</term>
+ <listitem>
+ <para>Set OBJC compiler flags for selecting an Objective-C
+ compiler;</para>
- <term>configure.fflags-delete</term>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <listitem>
- <para>Set FFLAGS to be passed to the Fortran compiler; list
- modifiers add or delete items from a previous Portfile
- configure.fflags keyword or the default set by MacPorts
- base.</para>
+ <listitem>
+ <para>Example:</para>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>-O2</literal></para>
- </listitem>
+ <programlisting>configure.objc /usr/bin/gcc-4.0</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Example:</para>
+ <varlistentry>
+ <term>configure.fc</term>
- <programlisting>configure.fflags -Os
+ <listitem>
+ <para>Set FC compiler flags for selecting a Fortran
+ compiler;</para>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <varlistentry>
- <term>configure.fcflags</term>
+ <listitem>
+ <para>Example:</para>
- <term>configure.fcflags-append</term>
+ <programlisting>configure.fc ${prefix}/bin/gfortran-mp-4.2</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <term>configure.fcflags-delete</term>
+ <varlistentry>
+ <term>configure.f77</term>
- <listitem>
- <para>Set FCFLAGS to be passed to the Fortran compiler; list
- modifiers add or delete items from a previous Portfile
- configure.fcflags keyword or the default set by MacPorts
- base.</para>
+ <listitem>
+ <para>Set F77 compiler flags for selecting a Fortran 77
+ compiler;</para>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>-O2</literal></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>configure.fcflags -Os
+ <programlisting>configure.f77 ${prefix}/bin/gfortran-mp-4.2</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>configure.f90</term>
- <varlistentry>
- <term>configure.f90flags</term>
+ <listitem>
+ <para>Set F90 compiler flags for selecting a Fortran 90
+ compiler;</para>
- <term>configure.f90flags-append</term>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <term>configure.f90flags-delete</term>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Set F90FLAGS to be passed to the Fortran 90 compiler; list
- modifiers add or delete items from a previous Portfile
- configure.f90flags keyword or the default set by MacPorts
- base.</para>
+ <programlisting>configure.f90 ${prefix}/bin/gfortran-mp-4.2</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>-O2</literal></para>
- </listitem>
+ <varlistentry>
+ <term>configure.javac</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Set JAVAC compiler flags for selecting a Java
+ compiler;</para>
- <programlisting>configure.f90flags -Os
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Example:</para>
- <!-- fortran compiler options end -->
+ <programlisting>configure.javac ${prefix}/bin/jikes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <!-- compiler selection arguments -->
+ <varlistentry>
+ <term>configure.compiler</term>
- <varlistentry>
- <term>configure.cc</term>
+ <listitem>
+ <para>Select a compiler suite to fill the compiler environment
+ variables. All variables/tools a compiler suite can provide are
+ set. Manually set variables are not overwritten. Dependencies are
+ not added for you, as they may be just build- or also
+ run-dependencies. Keep in mind that not all compiler suites might
+ be available on your platform.</para>
- <listitem>
- <para>Set CC compiler flags for selecting a C compiler;</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>gcc-3.3</literal>Mac OS X 10.3</para>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <para>Default: <literal>gcc-4.0</literal>Mac OS X 10.4,
+ 10.5</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Options:</para>
- <programlisting>configure.cc ${prefix}/bin/gcc-mp-4.2</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>gcc-3.3 gcc-4.0 apple-gcc-3.3 apple-gcc-4.0 macports-gcc-3.3 macports-gcc-3.4 macports-gcc-4.0 macports-gcc-4.1 macports-gcc-4.2 macports-gcc-4.3</programlisting>
+ </listitem>
- <varlistentry>
- <term>configure.cpp</term>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Set CPP compiler flags for selecting a C
- preprocessor;</para>
+ <programlisting>configure.compiler macports-gcc-4.2</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <!-- compiler selection arguments end -->
- <listitem>
- <para>Example:</para>
+ <!-- interpreter selection arguments -->
- <programlisting>configure.cpp /usr/bin/cpp-3.3</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>configure.perl</term>
- <varlistentry>
- <term>configure.cxx</term>
+ <listitem>
+ <para>Set PERL flag for selecting a Perl interpreter;</para>
- <listitem>
- <para>Set CXX compiler flags for selecting a C++ compiler;</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>configure.perl ${prefix}/bin/perl5.8</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <programlisting>configure.cpp /usr/bin/g++-4.0</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>configure.python</term>
- <varlistentry>
- <term>configure.objc</term>
+ <listitem>
+ <para>Set PYTHON flag for selecting a Python interpreter;</para>
- <listitem>
- <para>Set OBJC compiler flags for selecting an Objective-C
- compiler;</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>configure.python ${prefix}/bin/python3.0</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <programlisting>configure.objc /usr/bin/gcc-4.0</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>configure.ruby</term>
- <varlistentry>
- <term>configure.fc</term>
+ <listitem>
+ <para>Set RUBY flag for selecting a Ruby interpreter;</para>
- <listitem>
- <para>Set FC compiler flags for selecting a Fortran
- compiler;</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>configure.ruby ${prefix}/bin/ruby</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <programlisting>configure.fc ${prefix}/bin/gfortran-mp-4.2</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <!-- interpreter selection arguments end -->
- <varlistentry>
- <term>configure.f77</term>
+ <!-- other tools selection arguments -->
- <listitem>
- <para>Set F77 compiler flags for selecting a Fortran 77
- compiler;</para>
+ <varlistentry>
+ <term>configure.install</term>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>Set INSTALL flag for selecting an install tool; used for
+ copying files and creating directories</para>
- <listitem>
- <para>Example:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>/usr/bin/install</literal></para>
+ </listitem>
- <programlisting>configure.f77 ${prefix}/bin/gfortran-mp-4.2</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Example:</para>
- <varlistentry>
- <term>configure.f90</term>
+ <programlisting>configure.install ${prefix}/bin/ginstall</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Set F90 compiler flags for selecting a Fortran 90
- compiler;</para>
+ <varlistentry>
+ <term>configure.awk</term>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>Set AWK flag for selecting an awk executable</para>
- <listitem>
- <para>Example:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <programlisting>configure.f90 ${prefix}/bin/gfortran-mp-4.2</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Example:</para>
- <varlistentry>
- <term>configure.javac</term>
+ <programlisting>configure.awk ${prefix}/bin/gawk</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Set JAVAC compiler flags for selecting a Java
- compiler;</para>
+ <varlistentry>
+ <term>configure.bison</term>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>Set BISON flag for selecting a bison executable, a parser
+ generator</para>
- <listitem>
- <para>Example:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <programlisting>configure.javac ${prefix}/bin/jikes</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Example:</para>
- <varlistentry>
- <term>configure.compiler</term>
+ <programlisting>configure.bison /usr/bin/bison</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Select a compiler suite to fill the compiler environment
- variables. All variables/tools a compiler suite can provide are
- set. Manually set variables are not overwritten. Dependencies are
- not added for you, as they may be just build- or also
- run-dependencies. Keep in mind that not all compiler suites might
- be available on your platform.</para>
+ <varlistentry>
+ <term>configure.pkg_config</term>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>gcc-3.3</literal>Mac OS X 10.3</para>
+ <listitem>
+ <para>Set PKG_CONFIG flag for helping find pkg_config, a tool for
+ retrieving information about installed libraries.</para>
- <para>Default: <literal>gcc-4.0</literal>Mac OS X 10.4,
- 10.5</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <listitem>
- <para>Options:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>gcc-3.3 gcc-4.0 apple-gcc-3.3 apple-gcc-4.0 macports-gcc-3.3 macports-gcc-3.4 macports-gcc-4.0 macports-gcc-4.1 macports-gcc-4.2 macports-gcc-4.3</programlisting>
- </listitem>
+ <programlisting>configure.pkg_config ${prefix}/bin/pkg-config</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Example:</para>
+ <varlistentry>
+ <term>configure.pkg_config_path</term>
- <programlisting>configure.compiler macports-gcc-4.2</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Set PKG_CONFIG_PATH flag for telling pkg_config where to
+ search for information about installed libraries.</para>
- <!-- compiler selection arguments end -->
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal></literal></para>
+ </listitem>
- <!-- interpreter selection arguments -->
+ <listitem>
+ <para>Example:</para>
- <varlistentry>
- <term>configure.perl</term>
+ <programlisting>configure.pkg_config_path ${prefix}/lib/pkgconfig:${x11prefix}/lib/pkgconfig</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Set PERL flag for selecting a Perl interpreter;</para>
+ <!-- other tools selection arguments end -->
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <varlistentry>
+ <term>configure.args</term>
- <listitem>
- <para>Example:</para>
+ <term>configure.pre_args</term>
- <programlisting>configure.perl ${prefix}/bin/perl5.8</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <term>configure.post_args</term>
- <varlistentry>
- <term>configure.python</term>
+ <listitem>
+ <para>Main arguments to configure.cmd; optional argument modifiers
+ pass arguments before and after the main arguments.</para>
- <listitem>
- <para>Set PYTHON flag for selecting a Python interpreter;</para>
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>configure.args --bindir=${prefix}/bin
- <programlisting>configure.python ${prefix}/bin/python3.0</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <varlistentry>
- <term>configure.ruby</term>
+ <listitem>
+ <para>The following argument modifiers are available:</para>
- <listitem>
- <para>Set RUBY flag for selecting a Ruby interpreter;</para>
+ <itemizedlist>
+ <listitem>
+ <para>configure.pre_args default: --prefix=${prefix}</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Default: <literal></literal></para>
- </listitem>
+ <listitem>
+ <para>configure.post_args default: none</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Examples:</para>
- <programlisting>configure.ruby ${prefix}/bin/ruby</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <programlisting>configure.pre_args --prefix=${prefix}/share/bro
+configure.post_args OPT="-D__DARWIN_UNIX03"</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <!-- interpreter selection arguments end -->
+ <section>
+ <title>Configure Universal</title>
- <!-- other tools selection arguments -->
+ <para>Universal keywords are used to make a port compile on the OS X
+ platform to run on either PPC or Intel.</para>
+ <note>
+ <para>There is a default universal variant made available to all
+ ports by MacPorts base, so redefining universal keywords should only
+ be done to make a given port compile if the default options fail to
+ do so.</para>
+ </note>
+
+ <variablelist>
<varlistentry>
- <term>configure.install</term>
+ <term>configure.universal_args</term>
<listitem>
- <para>Set INSTALL flag for selecting an install tool; used for
- copying files and creating directories</para>
+ <para>Arguments used in the configure script to build the port
+ universal.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal>/usr/bin/install</literal></para>
+ <para>Default: --disable-dependency-tracking</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.install ${prefix}/bin/ginstall</programlisting>
+ <programlisting></programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>configure.awk</term>
+ <term>configure.universal_cflags</term>
<listitem>
- <para>Set AWK flag for selecting an awk executable</para>
+ <para>Arguments appended to the configure script to build the
+ port universal.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: -sysroot /Developer/SDKs/MacOSX10.4u.sdk
+ -arch i386 -arch ppc</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.awk ${prefix}/bin/gawk</programlisting>
+ <programlisting></programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>configure.bison</term>
+ <term>configure.universal_cppflags</term>
<listitem>
- <para>Set BISON flag for selecting a bison executable, a parser
- generator</para>
+ <para>Additional flags to put in the CPPFLAGS environment
+ variable when invoking the configure script.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: ???</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.bison /usr/bin/bison</programlisting>
+ <programlisting></programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>configure.pkg_config</term>
+ <term>configure.universal_cxxflags</term>
<listitem>
- <para>Set PKG_CONFIG flag for helping find pkg_config, a tool for
- retrieving information about installed libraries.</para>
+ <para>Additional flags to put in the CXXFLAGS environment
+ variable when invoking the configure script.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: -isysroot /Developer/SDKs/MacOSX10.4u.sdk
+ -arch i386 -arch ppc</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.pkg_config ${prefix}/bin/pkg-config</programlisting>
+ <programlisting></programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>configure.pkg_config_path</term>
+ <term>configure.universal_ldflags</term>
<listitem>
- <para>Set PKG_CONFIG_PATH flag for telling pkg_config where to
- search for information about installed libraries.</para>
+ <para>Additional flags to put in the LDFLAGS environment
+ variable when invoking the configure script.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: -arch i386 -arch ppc</para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.pkg_config_path ${prefix}/lib/pkgconfig:${x11prefix}/lib/pkgconfig</programlisting>
+ <programlisting></programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
+ </variablelist>
+ </section>
- <!-- other tools selection arguments end -->
+ <section>
+ <title>Automake and Autoconf</title>
+ <para>The list of configure keywords available for ports that need
+ automake and/or autoconf.</para>
+
+ <variablelist>
<varlistentry>
- <term>configure.args</term>
+ <term>use_automake</term>
- <term>configure.pre_args</term>
-
- <term>configure.post_args</term>
-
<listitem>
- <para>Main arguments to configure.cmd; optional argument modifiers
- pass arguments before and after the main arguments.</para>
+ <para>Whether or not to use automake; the default is
+ "no".</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <programlisting>use_automake yes</programlisting>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Example:</para>
+ <varlistentry>
+ <term>automake.env</term>
- <programlisting>configure.args --bindir=${prefix}/bin
+ <listitem>
+ <para>Environment variables to pass to automake.</para>
-</programlisting>
- </listitem>
- </itemizedlist>
+ <programlisting>automake.env CFLAGS=-I${prefix}/include</programlisting>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>automake.args</term>
+
<listitem>
- <para>The following argument modifiers are available:</para>
+ <para>Arguments to pass to automake.</para>
- <itemizedlist>
- <listitem>
- <para>configure.pre_args default: --prefix=${prefix}</para>
- </listitem>
+ <programlisting>automake.args --foreign</programlisting>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>configure.post_args default: none</para>
- </listitem>
+ <varlistentry>
+ <term>automake.dir</term>
- <listitem>
- <para>Examples:</para>
+ <listitem>
+ <para>Directory in which to run
+ <varname>${automake.cmd}</varname>; the default is
+ <varname>${worksrcpath}</varname>.</para>
- <programlisting>configure.pre_args --prefix=${prefix}/share/bro
-configure.post_args OPT="-D__DARWIN_UNIX03"</programlisting>
- </listitem>
- </itemizedlist>
+ <programlisting>automake.dir ./src</programlisting>
</listitem>
</varlistentry>
- </variablelist>
- <section>
- <title>Configure Universal</title>
+ <varlistentry>
+ <term>use_autoconf</term>
- <para>Universal keywords are used to make a port compile on the OS X
- platform to run on either PPC or Intel.</para>
+ <listitem>
+ <para>Whether or not to use autoconf; the default is
+ "no".</para>
- <note>
- <para>There is a default universal variant made available to all
- ports by MacPorts base, so redefining universal keywords should only
- be done to make a given port compile if the default options fail to
- do so.</para>
- </note>
+ <programlisting>use_autoconf yes</programlisting>
+ </listitem>
+ </varlistentry>
- <variablelist>
- <varlistentry>
- <term>configure.universal_args</term>
+ <varlistentry>
+ <term>autoconf.env</term>
- <listitem>
- <para>Arguments used in the configure script to build the port
- universal.</para>
+ <listitem>
+ <para>Environmental variables to pass to autoconf.</para>
- <itemizedlist>
- <listitem>
- <para>Default: --disable-dependency-tracking</para>
- </listitem>
+ <programlisting>autoconf.env CFLAGS=-I${prefix}/include/gtk12</programlisting>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Example:</para>
+ <varlistentry>
+ <term>autoconf.args</term>
- <programlisting></programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Arguments to pass to autoconf.</para>
- <varlistentry>
- <term>configure.universal_cflags</term>
+ <programlisting>autoconf.args -l src/aclocaldir</programlisting>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Arguments appended to the configure script to build the
- port universal.</para>
+ <varlistentry>
+ <term>autoconf.dir</term>
- <itemizedlist>
- <listitem>
- <para>Default: -sysroot /Developer/SDKs/MacOSX10.4u.sdk
- -arch i386 -arch ppc</para>
- </listitem>
+ <listitem>
+ <para>Directory in which to run
+ <varname>${autoconf.cmd}</varname>; the default is
+ <varname>${worksrcpath}</varname>.</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>autoconf.dir src</programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+ </section>
- <programlisting></programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <section>
+ <title>Build Phase Keywords</title>
- <varlistentry>
- <term>configure.universal_cppflags</term>
+ <para>The list of keywords related to the build phase.</para>
- <listitem>
- <para>Additional flags to put in the CPPFLAGS environment
- variable when invoking the configure script.</para>
+ <variablelist>
+ <varlistentry>
+ <term>build.cmd</term>
- <itemizedlist>
- <listitem>
- <para>Default: ???</para>
- </listitem>
+ <listitem>
+ <para>Make command to run in <varname>${worksrcdir}</varname>; the
+ default is "make".</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>build.cmd pbxbuild</programlisting>
+ </listitem>
+ </varlistentry>
- <programlisting></programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>build.type</term>
- <varlistentry>
- <term>configure.universal_cxxflags</term>
+ <listitem>
+ <para>Defines which "make" is required: "gnu" or "bsd". Sets
+ build.cmd to either "gnumake" or "bsdmake" accordingly.</para>
- <listitem>
- <para>Additional flags to put in the CXXFLAGS environment
- variable when invoking the configure script.</para>
+ <programlisting>build.type gnu</programlisting>
+ </listitem>
+ </varlistentry>
- <itemizedlist>
- <listitem>
- <para>Default: -isysroot /Developer/SDKs/MacOSX10.4u.sdk
- -arch i386 -arch ppc</para>
- </listitem>
+ <varlistentry>
+ <term>build.args</term>
- <listitem>
- <para>Example:</para>
+ <term>build.pre_args</term>
- <programlisting></programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ <term>build.post_args</term>
- <varlistentry>
- <term>configure.universal_ldflags</term>
+ <listitem>
+ <para>Main arguments to build.cmd; optional argument modifiers
+ pass arguments before and after the main arguments.</para>
+ <itemizedlist>
<listitem>
- <para>Additional flags to put in the LDFLAGS environment
- variable when invoking the configure script.</para>
-
- <itemizedlist>
- <listitem>
- <para>Default: -arch i386 -arch ppc</para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting></programlisting>
- </listitem>
- </itemizedlist>
+ <para>Default: none</para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section>
- <title>Automake and Autoconf</title>
-
- <para>The list of configure keywords available for ports that need
- automake and/or autoconf.</para>
-
- <variablelist>
- <varlistentry>
- <term>use_automake</term>
-
<listitem>
- <para>Whether or not to use automake; the default is
- "no".</para>
+ <para>Example:</para>
- <programlisting>use_automake yes</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>build.args -DNOWARN
- <varlistentry>
- <term>automake.env</term>
-
- <listitem>
- <para>Environment variables to pass to automake.</para>
-
- <programlisting>automake.env CFLAGS=-I${prefix}/include</programlisting>
+</programlisting>
</listitem>
- </varlistentry>
+ </itemizedlist>
+ </listitem>
- <varlistentry>
- <term>automake.args</term>
+ <listitem>
+ <para>The following argument modifiers are available:</para>
+ <itemizedlist>
<listitem>
- <para>Arguments to pass to automake.</para>
-
- <programlisting>automake.args --foreign</programlisting>
+ <para>build.pre_args default:
+ <varname>${build.target.current}</varname></para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>automake.dir</term>
-
<listitem>
- <para>Directory in which to run
- <varname>${automake.cmd}</varname>; the default is
- <varname>${worksrcpath}</varname>.</para>
-
- <programlisting>automake.dir ./src</programlisting>
+ <para>build.post_args default: none</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>use_autoconf</term>
-
<listitem>
- <para>Whether or not to use autoconf; the default is
- "no".</para>
+ <para>Examples:</para>
- <programlisting>use_autoconf yes</programlisting>
+ <programlisting>build.pre_args -project AudioSlicer.xcode
+build.post_args CFLAGS_SYS="-DUSE_FREETYPE -DPREFER_FREETYPE"</programlisting>
</listitem>
- </varlistentry>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>autoconf.env</term>
+ <varlistentry>
+ <term>build.target</term>
- <listitem>
- <para>Environmental variables to pass to autoconf.</para>
+ <term>build.target-append</term>
- <programlisting>autoconf.env CFLAGS=-I${prefix}/include/gtk12</programlisting>
- </listitem>
- </varlistentry>
+ <term>build.target-delete</term>
- <varlistentry>
- <term>autoconf.args</term>
+ <listitem>
+ <para>Build target to pass to ${build.cmd}; list modifiers add or
+ delete items from a previous Portfile build.target keyword or the
+ default set by MacPorts base.</para>
+ <itemizedlist>
<listitem>
- <para>Arguments to pass to autoconf.</para>
-
- <programlisting>autoconf.args -l src/aclocaldir</programlisting>
+ <para>Default: all</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>autoconf.dir</term>
-
<listitem>
- <para>Directory in which to run
- <varname>${autoconf.cmd}</varname>; the default is
- <varname>${worksrcpath}</varname>.</para>
+ <para>Example:</para>
- <programlisting>autoconf.dir src</programlisting>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
- </section>
+ <programlisting>build.target all-src
- <section>
- <title>Build Phase Keywords</title>
-
- <para>The list of keywords related to the build phase.</para>
-
- <variablelist>
- <varlistentry>
- <term>build.cmd</term>
-
- <listitem>
- <para>Make command to run in <varname>${worksrcdir}</varname>; the
- default is "make".</para>
-
- <programlisting>build.cmd pbxbuild</programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>build.type</term>
-
- <listitem>
- <para>Defines which "make" is required: "gnu" or "bsd". Sets
- build.cmd to either "gnumake" or "bsdmake" accordingly.</para>
-
- <programlisting>build.type gnu</programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>build.args</term>
-
- <term>build.pre_args</term>
-
- <term>build.post_args</term>
-
- <listitem>
- <para>Main arguments to build.cmd; optional argument modifiers
- pass arguments before and after the main arguments.</para>
-
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>build.args -DNOWARN
-
</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>The following argument modifiers are available:</para>
+ <listitem>
+ <para>List modifier examples:</para>
- <itemizedlist>
- <listitem>
- <para>build.pre_args default:
- <varname>${build.target.current}</varname></para>
- </listitem>
-
- <listitem>
- <para>build.post_args default: none</para>
- </listitem>
-
- <listitem>
- <para>Examples:</para>
-
- <programlisting>build.pre_args -project AudioSlicer.xcode
-build.post_args CFLAGS_SYS="-DUSE_FREETYPE -DPREFER_FREETYPE"</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>build.target</term>
-
- <term>build.target-append</term>
-
- <term>build.target-delete</term>
-
- <listitem>
- <para>Build target to pass to ${build.cmd}; list modifiers add or
- delete items from a previous Portfile build.target keyword or the
- default set by MacPorts base.</para>
-
- <itemizedlist>
- <listitem>
- <para>Default: all</para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>build.target all-src
-
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>build.target-append doc extra
+ <programlisting>build.target-append doc extra
build.target-delete compat</programlisting>
- </listitem>
- </varlistentry>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>use_parallel_build</term>
+ <varlistentry>
+ <term>use_parallel_build</term>
- <listitem>
- <para>This keyword is for specifying whether or not it is safe for
- a port to use multiple cpus or multiple cores in parallel during
- its build phase. If a port is declared to be builadble this way,
- the option <option>-j N</option> may be passed to the
- <command>make</command> command if parallel builds are enabled
- system-wide. This can be obtained by setting
- <varname>buildmakejobs</varname> in
- <filename>macports.conf</filename>. The integer <option>N</option>
- refers to the number of parallel build threads.</para>
+ <listitem>
+ <para>This keyword is for specifying whether or not it is safe for
+ a port to use multiple cpus or multiple cores in parallel during
+ its build phase. If a port is declared to be builadble this way,
+ the option <option>-j N</option> may be passed to the
+ <command>make</command> command if parallel builds are enabled
+ system-wide. This can be obtained by setting
+ <varname>buildmakejobs</varname> in
+ <filename>macports.conf</filename>. The integer <option>N</option>
+ refers to the number of parallel build threads.</para>
- <itemizedlist>
- <listitem>
- <para>Default: <option>no</option></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>use_parallel_build yes</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <programlisting>use_parallel_build yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <section>
- <title>Destroot Phase Keywords</title>
+ <section>
+ <title>Destroot Phase Keywords</title>
- <para>The list of keywords related to the destroot phase.</para>
+ <para>The list of keywords related to the destroot phase.</para>
- <variablelist>
- <varlistentry>
- <term>destroot.cmd</term>
+ <variablelist>
+ <varlistentry>
+ <term>destroot.cmd</term>
- <listitem>
- <para>Install command to run relative to
- <varname>${worksrcdir}</varname>; default is
- <varname>${build.cmd}</varname>.</para>
+ <listitem>
+ <para>Install command to run relative to
+ <varname>${worksrcdir}</varname>; default is
+ <varname>${build.cmd}</varname>.</para>
- <programlisting>destroot.cmd pbxbuild</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>destroot.cmd pbxbuild</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>destroot.type</term>
+ <varlistentry>
+ <term>destroot.type</term>
- <listitem>
- <para>Defines which "make" is required: either "gnu" or "bsd".
- Sets install.cmd to either "gnumake" or "bsdmake"
- accordingly.</para>
+ <listitem>
+ <para>Defines which "make" is required: either "gnu" or "bsd".
+ Sets install.cmd to either "gnumake" or "bsdmake"
+ accordingly.</para>
- <programlisting>destroot.type gnu</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>destroot.type gnu</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>destroot.args</term>
+ <varlistentry>
+ <term>destroot.args</term>
- <term>destroot.pre_args</term>
+ <term>destroot.pre_args</term>
- <term>destroot.post_args</term>
+ <term>destroot.post_args</term>
- <listitem>
- <para>Main arguments to ${destroot.cmd}; optional argument
- modifiers pass arguments before and after the main
- arguments.</para>
+ <listitem>
+ <para>Main arguments to ${destroot.cmd}; optional argument
+ modifiers pass arguments before and after the main
+ arguments.</para>
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>destroot.args BINDIR=${prefix}/bin
+ <programlisting>destroot.args BINDIR=${prefix}/bin
</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>The following argument modifiers are available:</para>
+ <listitem>
+ <para>The following argument modifiers are available:</para>
- <itemizedlist>
- <listitem>
- <para>destroot.pre_args default:
- <varname>${destroot.target}</varname></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>destroot.pre_args default:
+ <varname>${destroot.target}</varname></para>
+ </listitem>
- <listitem>
- <para>destroot.post_args default: none</para>
- </listitem>
+ <listitem>
+ <para>destroot.post_args default: none</para>
+ </listitem>
- <listitem>
- <para>Examples:</para>
+ <listitem>
+ <para>Examples:</para>
- <programlisting>destroot.pre_args -project AudioSlicer.xcode
+ <programlisting>destroot.pre_args -project AudioSlicer.xcode
destroot.post_args INSTDIR=${destroot}${prefix}</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>destroot.target</term>
+ <varlistentry>
+ <term>destroot.target</term>
- <term>destroot.target-append</term>
+ <term>destroot.target-append</term>
- <term>destroot.target-delete</term>
+ <term>destroot.target-delete</term>
- <listitem>
- <para>Install target to pass to ${destroot.cmd}; list modifiers
- add or delete items from a previous Portfile destroot.target
- keyword or the default set by MacPorts base.</para>
+ <listitem>
+ <para>Install target to pass to ${destroot.cmd}; list modifiers
+ add or delete items from a previous Portfile destroot.target
+ keyword or the default set by MacPorts base.</para>
- <itemizedlist>
- <listitem>
- <para>Default: <literal>install</literal></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>install</literal></para>
+ </listitem>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Example:</para>
- <programlisting>destroot.target install install-config install-commandmode
+ <programlisting>destroot.target install install-config install-commandmode
</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>List modifier examples:</para>
+ <listitem>
+ <para>List modifier examples:</para>
- <programlisting>destroot.target-append install-plugins
+ <programlisting>destroot.target-append install-plugins
destroot.target-delete install-commandmode</programlisting>
- </listitem>
- </varlistentry>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>destroot.destdir</term>
+ <varlistentry>
+ <term>destroot.destdir</term>
- <listitem>
- <para>Arguments passed to ${destroot.cmd} to install correctly
- into the destroot.</para>
+ <listitem>
+ <para>Arguments passed to ${destroot.cmd} to install correctly
+ into the destroot.</para>
- <programlisting>destroot.destdir prefix=${destroot}${prefix}</programlisting>
+ <programlisting>destroot.destdir prefix=${destroot}${prefix}</programlisting>
- <note>
- <para>If an application's Makefile properly supports the DESTDIR
- variable, MacPorts will automatically destroot the port
- properly. A port must destroot properly or the port will not
- install correctly, upgrade, or uninstall. If not, you may need
- to set this variable, or even patch the application's
- Makefile.</para>
- </note>
- </listitem>
- </varlistentry>
+ <note>
+ <para>If an application's Makefile properly supports the DESTDIR
+ variable, MacPorts will automatically destroot the port
+ properly. A port must destroot properly or the port will not
+ install correctly, upgrade, or uninstall. If not, you may need
+ to set this variable, or even patch the application's
+ Makefile.</para>
+ </note>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>destroot.keepdirs</term>
+ <varlistentry>
+ <term>destroot.keepdirs</term>
- <listitem>
- <para>A list of directories that should not be removed if empty
- upon destroot completion.</para>
+ <listitem>
+ <para>A list of directories that should not be removed if empty
+ upon destroot completion.</para>
- <programlisting>destroot.keepdirs \
- ${destroot}${prefix}/var/run \
- ${destroot}${prefix}/var/log \
- ${destroot}${prefix}/var/cache/mrtg</programlisting>
- </listitem>
- </varlistentry>
+ <programlisting>destroot.keepdirs \
+ ${destroot}${prefix}/var/run \
+ ${destroot}${prefix}/var/log \
+ ${destroot}${prefix}/var/cache/mrtg</programlisting>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>destroot.violate_mtree</term>
+ <varlistentry>
+ <term>destroot.violate_mtree</term>
- <listitem>
- <para>MacPorts tests for compliance to the common directory
- structure in ${prefix}; the default is "no". If a port is not
- compliant with the standard, set it to "yes".</para>
+ <listitem>
+ <para>MacPorts tests for compliance to the common directory
+ structure in ${prefix}; the default is "no". If a port is not
+ compliant with the standard, set it to "yes".</para>
- <programlisting>destroot.violate_mtree yes</programlisting>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <programlisting>destroot.violate_mtree yes</programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
+
+</section>
Modified: trunk/doc-new/guide/xml/portfile-startupitem.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-startupitem.7.xml 2007-11-30 18:25:42 UTC (rev 31620)
+++ trunk/doc-new/guide/xml/portfile-startupitem.7.xml 2007-11-30 19:09:37 UTC (rev 31621)
@@ -2,283 +2,283 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
- <section>
- <title>StartupItems</title>
+<section>
+ <title>StartupItems</title>
- <para>A StartupItem is a MacPort facility to run "daemons," a Unix term
- for programs that run continuously in the background, rather than under
- the direct control of a user; for example, mail servers, network
- listeners, etc. Ports that use StartupItem keywords create Mac OS X
- scripts for <ulink
- url="http://developer.apple.com/macosx/launchd.html">launchd</ulink>,
- which is the Apple facility introduced with OS X 10.4 to replace xinetd
- for starting and managing daemons. To support
- <command>launchd</command>, a program named <command>daemondo</command>
- is provided by MacPorts base that serves as an adapter between OS X's
- <command>launchd</command> and daemons (<quote>executable</quote>
- StartupItems) or traditional Unix startup scripts that start daemons
- (<quote>script</quote> StartupItems).</para>
+ <para>A StartupItem is a MacPort facility to run "daemons," a Unix term
+ for programs that run continuously in the background, rather than under
+ the direct control of a user; for example, mail servers, network
+ listeners, etc. Ports that use StartupItem keywords create Mac OS X
+ scripts for <ulink
+ url="http://developer.apple.com/macosx/launchd.html">launchd</ulink>,
+ which is the Apple facility introduced with OS X 10.4 to replace xinetd
+ for starting and managing daemons. To support
+ <command>launchd</command>, a program named <command>daemondo</command>
+ is provided by MacPorts base that serves as an adapter between OS X's
+ <command>launchd</command> and daemons (<quote>executable</quote>
+ StartupItems) or traditional Unix startup scripts that start daemons
+ (<quote>script</quote> StartupItems).</para>
- <para>There are three categories of StartupItem keywords. Those that
- trigger StartupItem creation and logging, those that specify attributes
- of <quote>executable</quote> StartupItems, and those that specify
- attributes of <quote>script</quote> StartupItems.</para>
+ <para>There are three categories of StartupItem keywords. Those that
+ trigger StartupItem creation and logging, those that specify attributes
+ of <quote>executable</quote> StartupItems, and those that specify
+ attributes of <quote>script</quote> StartupItems.</para>
- <note>
- <para>The variable <varname>startupitem_type</varname> in
- ${prefix}/etc/macports/macports.conf may be set to
- <option>none</option> to globally override all StartupItem keywords
- found in Portfiles; this prevents StartupItems from being
- created.</para>
- </note>
+ <note>
+ <para>The variable <varname>startupitem_type</varname> in
+ ${prefix}/etc/macports/macports.conf may be set to
+ <option>none</option> to globally override all StartupItem keywords
+ found in Portfiles; this prevents StartupItems from being
+ created.</para>
+ </note>
- <section>
- <title>StartupItem Attributes</title>
+ <section>
+ <title>StartupItem Attributes</title>
- <para>The keywords in this section may be used with either
- <quote>executable</quote> or <quote>script</quote> StartupItems (see
- below).</para>
+ <para>The keywords in this section may be used with either
+ <quote>executable</quote> or <quote>script</quote> StartupItems (see
+ below).</para>
- <variablelist>
- <varlistentry>
- <term>startupitem.create</term>
+ <variablelist>
+ <varlistentry>
+ <term>startupitem.create</term>
+ <listitem>
+ <para>Trigger the creation of a StartupItem.</para>
+
+ <itemizedlist>
<listitem>
- <para>Trigger the creation of a StartupItem.</para>
+ <para>Type: optional</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Default: no</para>
+ </listitem>
- <listitem>
- <para>Default: no</para>
- </listitem>
+ <listitem>
+ <para>Values: yes no</para>
+ </listitem>
- <listitem>
- <para>Values: yes no</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Example:</para>
+ <programlisting>startupitem.create yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <programlisting>startupitem.create yes</programlisting>
- </listitem>
- </itemizedlist>
+ <varlistentry>
+ <term>startupitem.name</term>
+
+ <listitem>
+ <para>Sets the name for the StartupItem.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Type: required</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>startupitem.name</term>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
<listitem>
- <para>Sets the name for the StartupItem.</para>
+ <para>Values: <replaceable>any_name</replaceable></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: required</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <programlisting>startupitem.name OpenSSH</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Values: <replaceable>any_name</replaceable></para>
- </listitem>
+ <varlistentry>
+ <term>startupitem.logfile</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Path to a logfile for logging events about the lifetime of
+ the StartupItem. Depending on the type of StartupItem, and the
+ manner in which it is started, standard output from the daemon
+ may also be directed to the logfile.</para>
- <programlisting>startupitem.name OpenSSH</programlisting>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Type: optional</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>startupitem.logfile</term>
+ <listitem>
+ <para>Default: <filename>/dev/null</filename></para>
+ </listitem>
<listitem>
- <para>Path to a logfile for logging events about the lifetime of
- the StartupItem. Depending on the type of StartupItem, and the
- manner in which it is started, standard output from the daemon
- may also be directed to the logfile.</para>
+ <para>Values: <replaceable>/file/path</replaceable></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Default: <filename>/dev/null</filename></para>
- </listitem>
+ <programlisting>startupitem.logfile ${prefix}/var/log/mydaemon.log</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Values: <replaceable>/file/path</replaceable></para>
- </listitem>
+ <varlistentry>
+ <term>startupitem.logevents</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Control whether or not to log events to the log file. If
+ logevents is set, events with timestamps are logged to the
+ logfile.</para>
- <programlisting>startupitem.logfile ${prefix}/var/log/mydaemon.log</programlisting>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Type: optional</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>startupitem.logevents</term>
+ <listitem>
+ <para>Default: no</para>
+ </listitem>
<listitem>
- <para>Control whether or not to log events to the log file. If
- logevents is set, events with timestamps are logged to the
- logfile.</para>
+ <para>Values: yes no</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Default: no</para>
- </listitem>
+ <programlisting>startupitem.logevents yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Values: yes no</para>
- </listitem>
+ <varlistentry>
+ <term>startupitem.netchange</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>Cause the daemon to be restarted when a change in network
+ state is detected.</para>
- <programlisting>startupitem.logevents yes</programlisting>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Type: optional</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>startupitem.netchange</term>
+ <listitem>
+ <para>Default: no</para>
+ </listitem>
<listitem>
- <para>Cause the daemon to be restarted when a change in network
- state is detected.</para>
+ <para>Values: yes no</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Default: no</para>
- </listitem>
+ <programlisting>startupitem.netchange yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <listitem>
- <para>Values: yes no</para>
- </listitem>
+ <section>
+ <title>Executable StartupItems</title>
- <listitem>
- <para>Example:</para>
+ <para>Daemons run continuously, so monitoring the health of daemon
+ processes and restarting them if they die is an important
+ StartupItems' feature. <quote>Executable</quote> StartupItems are
+ preferred over <quote>script</quote> StartupItems because
+ <command>daemondo</command> launches the daemon
+ <emphasis>directly</emphasis>, rather than
+ <emphasis>indirectly</emphasis> via a script, and therefore it
+ automatically knows how to monitor a daemon process and restart it if
+ it dies. Daemons used with <quote>executable</quote> StartupItems may
+ be programs or scripts (shell, perl, python, etc.), but when a script
+ the script <emphasis>itself</emphasis> must be the daemon, rather than
+ a script that launches a daemon. <quote>Script</quote> StartupItems
+ are to be used for the latter.</para>
- <programlisting>startupitem.netchange yes</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
+ <note>
+ <para>For a given port, the <quote>executable</quote> StartupItem
+ keyword may not be used with any keywords in the
+ <quote>script</quote> StartupItem category.</para>
+ </note>
- <section>
- <title>Executable StartupItems</title>
+ <variablelist>
+ <varlistentry>
+ <term>startupitem.executable</term>
- <para>Daemons run continuously, so monitoring the health of daemon
- processes and restarting them if they die is an important
- StartupItems' feature. <quote>Executable</quote> StartupItems are
- preferred over <quote>script</quote> StartupItems because
- <command>daemondo</command> launches the daemon
- <emphasis>directly</emphasis>, rather than
- <emphasis>indirectly</emphasis> via a script, and therefore it
- automatically knows how to monitor a daemon process and restart it if
- it dies. Daemons used with <quote>executable</quote> StartupItems may
- be programs or scripts (shell, perl, python, etc.), but when a script
- the script <emphasis>itself</emphasis> must be the daemon, rather than
- a script that launches a daemon. <quote>Script</quote> StartupItems
- are to be used for the latter.</para>
+ <listitem>
+ <para>Specifies the name of the daemon to be run in the
+ background. It may have multiple arguments, but they must be
+ appropriate for a call to exec; arbitrary shell code may not be
+ used.</para>
- <note>
- <para>For a given port, the <quote>executable</quote> StartupItem
- keyword may not be used with any keywords in the
- <quote>script</quote> StartupItem category.</para>
- </note>
+ <itemizedlist>
+ <listitem>
+ <para>Type: optional</para>
+ </listitem>
- <variablelist>
- <varlistentry>
- <term>startupitem.executable</term>
+ <listitem>
+ <para>Default: no</para>
+ </listitem>
<listitem>
- <para>Specifies the name of the daemon to be run in the
- background. It may have multiple arguments, but they must be
- appropriate for a call to exec; arbitrary shell code may not be
- used.</para>
+ <para>Values: <replaceable>/path/to/daemon</replaceable>
+ [<replaceable>args</replaceable>]</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Default: no</para>
- </listitem>
+ <programlisting>startupitem.executable ${prefix}/sbin/vm-pop3d -d 10 -t 600</programlisting>
+ </listitem>
+ </itemizedlist>
- <listitem>
- <para>Values: <replaceable>/path/to/daemon</replaceable>
- [<replaceable>args</replaceable>]</para>
- </listitem>
+ <note>
+ <para>Do not to wrap the value in quotes if passing arguments
+ to the daemon; unlike with<quote>script</quote> StartupItem
+ values, executable StartupItem value elements must be tagged
+ separately as shown in this example .plist file
+ snippet.</para>
- <listitem>
- <para>Example:</para>
+ <programlisting><key>ProgramArguments</key>
+<array>
+ <string>/opt/local/bin/daemondo</string>
+ <string>--label=vm-pop3d</string>
+ <string>--start-cmd</string>
+ <string>/opt/local/sbin/vm-pop3d</string>
+ <string>-d</string>
+ <string>10</string>
+ <string>-t</string>
+ <string>600</string>
+ <string>;</string>
+</array></programlisting>
+ </note>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <programlisting>startupitem.executable ${prefix}/sbin/vm-pop3d -d 10 -t 600</programlisting>
- </listitem>
- </itemizedlist>
+ <section>
+ <title>Script StartupItems</title>
- <note>
- <para>Do not to wrap the value in quotes if passing arguments
- to the daemon; unlike with<quote>script</quote> StartupItem
- values, executable StartupItem value elements must be tagged
- separately as shown in this example .plist file
- snippet.</para>
+ <para>StartupItems of type <quote>script</quote> use
+ <command>daemondo</command> to launch a daemon
+ <emphasis>indirectly</emphasis> via a startup script. A typical
+ snippet of a startup script that may be used with a
+ <quote>script</quote> StartupItem is shown below. Notice that the
+ script is not a daemon; rather the script indirectly launches the
+ vm-pop3d daemon.</para>
- <programlisting><key>ProgramArguments</key>
- <array>
- <string>/opt/local/bin/daemondo</string>
- <string>--label=vm-pop3d</string>
- <string>--start-cmd</string>
- <string>/opt/local/sbin/vm-pop3d</string>
- <string>-d</string>
- <string>10</string>
- <string>-t</string>
- <string>600</string>
- <string>;</string>
- </array></programlisting>
- </note>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
-
- <section>
- <title>Script StartupItems</title>
-
- <para>StartupItems of type <quote>script</quote> use
- <command>daemondo</command> to launch a daemon
- <emphasis>indirectly</emphasis> via a startup script. A typical
- snippet of a startup script that may be used with a
- <quote>script</quote> StartupItem is shown below. Notice that the
- script is not a daemon; rather the script indirectly launches the
- vm-pop3d daemon.</para>
-
- <programlisting>#!/bin/sh
+ <programlisting>#!/bin/sh
#
case "$1" in
start)
@@ -288,213 +288,213 @@
[... trimmed ...]</programlisting>
- <para>But if a script itself is a daemon, use the
- <quote>executable</quote> StartupItem type since that way it will be
- launched directly and its health tracked automatically. When using
- <quote>script</quote> StartupItems, the
- <code>startupitem.pidfile</code> keyword must be used if you want
- <command>daemondo</command> to monitor a daemon process and restart it
- if it dies.</para>
+ <para>But if a script itself is a daemon, use the
+ <quote>executable</quote> StartupItem type since that way it will be
+ launched directly and its health tracked automatically. When using
+ <quote>script</quote> StartupItems, the
+ <code>startupitem.pidfile</code> keyword must be used if you want
+ <command>daemondo</command> to monitor a daemon process and restart it
+ if it dies.</para>
- <note>
- <para>For a given port, StartupItem keywords in category
- <quote>script</quote> may not be used with an
- <quote>executable</quote> StartupItem keyword.</para>
- </note>
+ <note>
+ <para>For a given port, StartupItem keywords in category
+ <quote>script</quote> may not be used with an
+ <quote>executable</quote> StartupItem keyword.</para>
+ </note>
- <variablelist>
- <varlistentry>
- <term>startupitem.start</term>
+ <variablelist>
+ <varlistentry>
+ <term>startupitem.start</term>
- <term>startupitem.stop</term>
+ <term>startupitem.stop</term>
- <term>startupitem.restart</term>
+ <term>startupitem.restart</term>
+ <listitem>
+ <para>Specify a shell script to start, stop, and restart the
+ daemon. In the absence of a restart key, the daemon will be
+ restarted by taking the stop action, followed by the start
+ action.</para>
+
+ <itemizedlist>
<listitem>
- <para>Specify a shell script to start, stop, and restart the
- daemon. In the absence of a restart key, the daemon will be
- restarted by taking the stop action, followed by the start
- action.</para>
+ <para>Type: optional</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
- <listitem>
- <para>Default: none</para>
- </listitem>
+ <listitem>
+ <para>Values: <replaceable>shell_script</replaceable></para>
+ </listitem>
- <listitem>
- <para>Values: <replaceable>shell_script</replaceable></para>
- </listitem>
+ <listitem>
+ <para>Examples:</para>
- <listitem>
- <para>Examples:</para>
-
- <programlisting>startupitem.start "${prefix}/share/mysql/mysql.server start"
+ <programlisting>startupitem.start "${prefix}/share/mysql/mysql.server start"
startupitem.stop "${prefix}/share/mysql/mysql.server stop"
startupitem.restart "${prefix}/share/mysql/mysql.server restart"</programlisting>
- </listitem>
- </itemizedlist>
+ </listitem>
+ </itemizedlist>
- <note>
- <para>Wrap the stop, start, and restart values in quotes so
- they will be placed in the wrapper as a single command.</para>
- </note>
+ <note>
+ <para>Wrap the stop, start, and restart values in quotes so
+ they will be placed in the wrapper as a single command.</para>
+ </note>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>startupitem.init</term>
+
+ <listitem>
+ <para>Shell code that will be executed prior to any of the
+ options <code>startupitem.start</code>,
+ <code>startupitem.stop</code> and
+ <code>startupitem.restart</code>.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Type: optional</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>startupitem.init</term>
+ <listitem>
+ <para>Default: no</para>
+ </listitem>
<listitem>
- <para>Shell code that will be executed prior to any of the
- options <code>startupitem.start</code>,
- <code>startupitem.stop</code> and
- <code>startupitem.restart</code>.</para>
+ <para>Values: <replaceable>shell_script</replaceable></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Default: no</para>
- </listitem>
+ <programlisting>startupitem.init "BIN=${prefix}/sbin/bacula-fd"</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Values: <replaceable>shell_script</replaceable></para>
- </listitem>
+ <varlistentry>
+ <term>startupitem.pidfile</term>
- <listitem>
- <para>Example:</para>
+ <listitem>
+ <para>This keyword must be defined properly for
+ <command>daemondo</command> to be able to monitor daemons
+ launched via <quote>script</quote> StartupItems and restart them
+ if they die. It specifies two things: a process id (PID) file
+ handling method, and a pidfile name and path.</para>
- <programlisting>startupitem.init "BIN=${prefix}/sbin/bacula-fd"</programlisting>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Type: optional</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>startupitem.pidfile</term>
+ <listitem>
+ <para>Default: [none] |
+ [<filename>${prefix}/var/run/${name}.pid</filename>]</para>
+ </listitem>
<listitem>
- <para>This keyword must be defined properly for
- <command>daemondo</command> to be able to monitor daemons
- launched via <quote>script</quote> StartupItems and restart them
- if they die. It specifies two things: a process id (PID) file
- handling method, and a pidfile name and path.</para>
+ <para>Values [none auto manual clean]
+ [<replaceable>/path/to/pidfile</replaceable>]</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Type: optional</para>
- </listitem>
+ <listitem>
+ <para>Example:</para>
- <listitem>
- <para>Default: [none] |
- [<filename>${prefix}/var/run/${name}.pid</filename>]</para>
- </listitem>
+ <programlisting>startupitem.pidfile auto ${prefix}/var/run/${name}.pidfile</programlisting>
+ </listitem>
+ </itemizedlist>
- <listitem>
- <para>Values [none auto manual clean]
- [<replaceable>/path/to/pidfile</replaceable>]</para>
- </listitem>
+ <para>PID file handling options:</para>
- <listitem>
- <para>Example:</para>
+ <itemizedlist>
+ <listitem>
+ <para><option>none</option> - daemondo will not create or
+ track a PID file, so it won't know when a daemon
+ dies.</para>
+ </listitem>
- <programlisting>startupitem.pidfile auto ${prefix}/var/run/${name}.pidfile</programlisting>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para><option>auto</option> - The started process is
+ expected to create a PID file that contains the PID of the
+ running daemon; daemondo then reads the PID from the file
+ and tracks the process. The started process must delete the
+ PID file if this is necessary.</para>
+ </listitem>
- <para>PID file handling options:</para>
+ <listitem>
+ <para><option>clean</option> - The started process is
+ expected to create a PID file that contains the PID of the
+ running daemon; daemondo then reads the PID from the file
+ and tracks the process, and deletes the PID file if it
+ detects the daemon has died.</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para><option>none</option> - daemondo will not create or
- track a PID file, so it won't know when a daemon
- dies.</para>
- </listitem>
-
- <listitem>
- <para><option>auto</option> - The started process is
- expected to create a PID file that contains the PID of the
- running daemon; daemondo then reads the PID from the file
- and tracks the process. The started process must delete the
- PID file if this is necessary.</para>
- </listitem>
-
- <listitem>
- <para><option>clean</option> - The started process is
- expected to create a PID file that contains the PID of the
- running daemon; daemondo then reads the PID from the file
- and tracks the process, and deletes the PID file if it
- detects the daemon has died.</para>
- </listitem>
-
- <listitem>
- <para><option>manual</option> - This option should only be
- used if an <quote>executable</quote> StartupItem could be
- used (daemondo launches a daemon directly)
- <emphasis>and</emphasis> a port author wants a PID file
- written for some special use. A PID file is not needed to
- detect process death for daemons launched directly by
- daemondo. As with executale StartupItems, daemondo remembers
- the PID of the launched process and tracks it
- automatically.</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para><option>manual</option> - This option should only be
+ used if an <quote>executable</quote> StartupItem could be
+ used (daemondo launches a daemon directly)
+ <emphasis>and</emphasis> a port author wants a PID file
+ written for some special use. A PID file is not needed to
+ detect process death for daemons launched directly by
+ daemondo. As with executale StartupItems, daemondo remembers
+ the PID of the launched process and tracks it
+ automatically.</para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <section>
- <title>Loading / Unloading StartupItems into launchd</title>
+ <section>
+ <title>Loading / Unloading StartupItems into launchd</title>
- <para>A port with a StartupItem places a link to a .plist file for the
- port's daemon within <filename>/Library/LaunchDaemons/</filename>. A
- .plist file is an XML file; MacPorts installs .plist files tagged as
- <quote>disabled</quote> for the sake of security. You may enable a
- startup script (tag the.plist file as <quote>enabled</quote>) and load
- it into <command>launchd</command> with a single command as
- shown.</para>
+ <para>A port with a StartupItem places a link to a .plist file for the
+ port's daemon within <filename>/Library/LaunchDaemons/</filename>. A
+ .plist file is an XML file; MacPorts installs .plist files tagged as
+ <quote>disabled</quote> for the sake of security. You may enable a
+ startup script (tag the.plist file as <quote>enabled</quote>) and load
+ it into <command>launchd</command> with a single command as
+ shown.</para>
- <programlisting><prompt>%%</prompt> <userinput>sudo launchctl load -w /Library/LaunchDaemons/org.macports.mysql5.plist</userinput></programlisting>
+ <programlisting><prompt>%%</prompt> <userinput>sudo launchctl load -w /Library/LaunchDaemons/org.macports.mysql5.plist</userinput></programlisting>
- <para>You may stop a running startup script, disable it (tag the.plist
- file as <quote>disabled</quote>), and unload it from
- <command>launchd</command> with a single command as shown.</para>
+ <para>You may stop a running startup script, disable it (tag the.plist
+ file as <quote>disabled</quote>), and unload it from
+ <command>launchd</command> with a single command as shown.</para>
- <programlisting><prompt>%%</prompt> <userinput>sudo launchctl unload -w /Library/LaunchDaemons/org.macports.mysql5.plist</userinput></programlisting>
- </section>
+ <programlisting><prompt>%%</prompt> <userinput>sudo launchctl unload -w /Library/LaunchDaemons/org.macports.mysql5.plist</userinput></programlisting>
+ </section>
- <section>
- <title>StartupItem Internals</title>
+ <section>
+ <title>StartupItem Internals</title>
- <para>During port installation a MacPorts StartupItem creates a .plist
- file in <filename>${prefix}/etc/LaunchDaemons/</filename>, and places
- a symbolic link to the .plist file within
- <filename>/Library/LaunchDaemons/</filename>.</para>
+ <para>During port installation a MacPorts StartupItem creates a .plist
+ file in <filename>${prefix}/etc/LaunchDaemons/</filename>, and places
+ a symbolic link to the .plist file within
+ <filename>/Library/LaunchDaemons/</filename>.</para>
- <para>For example, the StartupItem for the mysql5 port is
- <filename>org.macports.mysql5.plist</filename>, and it is linked as
- shown.</para>
+ <para>For example, the StartupItem for the mysql5 port is
+ <filename>org.macports.mysql5.plist</filename>, and it is linked as
+ shown.</para>
- <programlisting><prompt>%%</prompt> <userinput>ls -l /Library/LaunchDaemons</userinput></programlisting>
+ <programlisting><prompt>%%</prompt> <userinput>ls -l /Library/LaunchDaemons</userinput></programlisting>
- <screen>org.macports.mysql5.plist ->
+ <screen>org.macports.mysql5.plist ->
/opt/local/etc/LaunchDaemons/org.macports.mysql5/org.macports.mysql5.plist</screen>
- <para>For <quote>script</quote> StartupItems, in addition to a .plist
- file, a wrapper is also created.<programlisting><prompt>%%</prompt> <userinput>ls -l /opt/local/etc/LaunchDaemons/org.macports.mysql5/</userinput></programlisting><screen>-rwxr-xr-x 2 root wheel 475 Aug 2 14:16 mysql5.wrapper
+ <para>For <quote>script</quote> StartupItems, in addition to a .plist
+ file, a wrapper is also created.<programlisting><prompt>%%</prompt> <userinput>ls -l /opt/local/etc/LaunchDaemons/org.macports.mysql5/</userinput></programlisting><screen>-rwxr-xr-x 2 root wheel 475 Aug 2 14:16 mysql5.wrapper
-rw-r--r-- 2 root wheel 975 Aug 2 14:16 org.macports.mysql5.plist</screen>The
- wrapper manipulates the script as specified in the startupitem.start
- and startupitem.stop keywords. An example wrapper script snippet is
- shown below.</para>
+ wrapper manipulates the script as specified in the startupitem.start
+ and startupitem.stop keywords. An example wrapper script snippet is
+ shown below.</para>
- <programlisting>#!/bin/sh
+ <programlisting>#!/bin/sh
#
# MacPorts generated daemondo support script
@@ -511,5 +511,5 @@
}
[... trimmed ...]</programlisting>
- </section>
- </section>
+ </section>
+</section>
Modified: trunk/doc-new/guide/xml/portfile-tcl.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-tcl.7.xml 2007-11-30 18:25:42 UTC (rev 31620)
+++ trunk/doc-new/guide/xml/portfile-tcl.7.xml 2007-11-30 19:09:37 UTC (rev 31621)
@@ -2,8 +2,8 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
- <section>
- <title>Tcl Extensions</title>
+<section>
+ <title>Tcl Extensions</title>
- <para>TODO: Describe Tcl Extensions here ..</para>
- </section>
+ <para>TODO: Describe Tcl Extensions here ..</para>
+</section>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20071130/44afefbe/attachment-0001.html
More information about the macports-changes
mailing list