[31178] trunk/doc-new-test
simon at macports.org
simon at macports.org
Sat Nov 17 10:20:28 PST 2007
Revision: 31178
http://trac.macosforge.org/projects/macports/changeset/31178
Author: simon at macports.org
Date: 2007-11-17 10:20:26 -0800 (Sat, 17 Nov 2007)
Log Message:
-----------
doc-new-test: Integrated the man pages more into the guide.
The portfile-* man files are now "normal" xml files for the guide and are
xincluded into it. When the man files are generated the xml are modified so
they are valid man xml files and then generated. With this change the guide
looks better and the structure of the man xml files is clearer.
Modified Paths:
--------------
trunk/doc-new-test/Makefile
trunk/doc-new-test/guide/xml/portfile-phase.7.xml
trunk/doc-new-test/guide/xml/portfile-startupitem.7.xml
trunk/doc-new-test/guide/xml/portfile-tcl.7.xml
trunk/doc-new-test/guide/xml/portfileref.xml
trunk/doc-new-test/man/xml/portfile.7.xml
Added Paths:
-----------
trunk/doc-new-test/guide/xml/portfile-global-keywords.7.xml
trunk/doc-new-test/guide/xml/portfile-global-variables.7.xml
Removed Paths:
-------------
trunk/doc-new-test/guide/xml/portfile-global.7.xml
Modified: trunk/doc-new-test/Makefile
===================================================================
--- trunk/doc-new-test/Makefile 2007-11-17 17:57:32 UTC (rev 31177)
+++ trunk/doc-new-test/Makefile 2007-11-17 18:20:26 UTC (rev 31178)
@@ -45,14 +45,15 @@
man:
mkdir -p $(MAN-RESULT)
- xsltproc --output $(MAN-RESULT) $(MAN-XSL) \
+ mkdir -p $(MAN)/tmp
+ cp $(GUIDE)/xml/portfile-*.xml $(MAN)/tmp/
+ sed -i "" 's|<section>|<refsection\>|g' $(MAN)/tmp/*
+ sed -i "" 's|</section>|</refsection>|g' $(MAN)/tmp/*
+ xsltproc --xinclude --output $(MAN-RESULT) $(MAN-XSL) \
$(MAN)/xml/portfile.7.xml \
- $(MAN)/xml/portfile-global.7.xml \
- $(MAN)/xml/portfile-phase.7.xml \
- $(MAN)/xml/portfile-startupitem.7.xml \
- $(MAN)/xml/portfile-tcl.7.xml \
$(MAN)/xml/portgroup.7.xml \
$(MAN)/xml/porthier.7.xml
+ rm -r $(MAN)/tmp
clean:
rm -rf $(GUIDE-RESULT)
Copied: trunk/doc-new-test/guide/xml/portfile-global-keywords.7.xml (from rev 31177, trunk/doc-new-test/guide/xml/portfile-global.7.xml)
===================================================================
--- trunk/doc-new-test/guide/xml/portfile-global-keywords.7.xml (rev 0)
+++ trunk/doc-new-test/guide/xml/portfile-global-keywords.7.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -0,0 +1,630 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!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>
+
+ <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>
+
+ <section>
+ <title>General</title>
+
+ <para>The list of global keywords.</para>
+
+ <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>
+
+ <programlisting>PortSystem 1.0
+
+</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>name</term>
+
+ <listitem>
+ <para>The name of the Port; it should be lowercase.</para>
+
+ <programlisting>name foo</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>version</term>
+
+ <listitem>
+ <para>The version of the ported software.</para>
+
+ <programlisting>version 1.23.45</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <programlisting>revision 1</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <programlisting>epoch 20070924</programlisting>
+
+ <programlisting>epoch 1</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <programlisting>categories net security</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <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>
+
+ <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 \
+ example.org:julesverne</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>description</term>
+
+ <listitem>
+ <para>A one-sentence description of the ported software.</para>
+
+ <programlisting>description A classic shooter arcade game.</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>long_description</term>
+
+ <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 \
+ the game alien-munchers. Not suitable for \
+ children under two years old. </programlisting>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>homepage</term>
+
+ <listitem>
+ <para>Port application's homepage.</para>
+
+ <programlisting>homepage http://www.somesite.org/apps</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>platforms</term>
+
+ <listitem>
+ <para>The platforms on which the port has been tested.</para>
+
+ <programlisting>platforms darwin freebsd</programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <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>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>
+
+ <term>depends_lib-append</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>
+
+ <varlistentry>
+ <term>depends_build</term>
+
+ <term>depends_build-append</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>
+
+ <varlistentry>
+ <term>depends_run</term>
+
+ <term>depends_run-append</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>
+
+ <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, the preferred type, are specified as shown in
+ these examples:</para>
+
+ <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>
+
+ <programlisting>depends_lib lib:libX11.6:xorg
+
+depends_build bin:rrdtool</programlisting>
+ </section>
+ </section>
+
+ <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>
+
+ <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>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: no</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>variant gnome requires glib {
+ configure.args-append --with-gnome
+ depends_lib-append port:gnome-session
+}</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>default_variants +ssl +tcpd
+
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <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>
+
+ <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>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: yes</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>universal_variant no</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <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>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>
+
+ <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>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>
+
+ <listitem>
+ <para>Values: freshmeat sourceforge googlecode moddate regex
+ regexm md5 none</para>
+ </listitem>
+
+ <listitem>
+ <para>Examples:</para>
+
+ <programlisting>livecheck.check regex
+livecheck.url http://dev.mysql.com/
+livecheck.regex "Generally Available (${major_version}\\.\[0-9.\]+)"
+</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>livecheck.name</term>
+
+ <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>
+
+ <listitem>
+ <para>Values:
+ <replaceable>any_project_name</replaceable></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>livecheck.name hibernate</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <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>Example:</para>
+
+ <programlisting>livecheck.distname faad2.src</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>livecheck.version</term>
+
+ <listitem>
+ <para>Version of the project for a check; used for regex-based
+ checks.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${version}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Values: <replaceable>any_version</replaceable></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>livecheck.version ${name}-${version}</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>livecheck.url</term>
+
+ <listitem>
+ <para>URL to query for a check.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default:</para>
+
+ <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://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>Values: <replaceable>any_url</replaceable></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>livecheck.url http://ftp.gnu.org/gnu/bison/</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
+
+ <listitem>
+ <para>Values: <replaceable>any_regex</replaceable></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>livecheck.regex 4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>livecheck.md5</term>
+
+ <listitem>
+ <para>md5 checksum to use for an md5 comparison.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: none</para>
+ </listitem>
+
+ <listitem>
+ <para>Values:
+ <replaceable>any_md5_checksum</replaceable></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <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>
+
+ <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>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: moddate</para>
+ </listitem>
+
+ <listitem>
+ <para>Values: moddate none</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>distcheck.check none</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+ </section>
Copied: trunk/doc-new-test/guide/xml/portfile-global-variables.7.xml (from rev 31177, trunk/doc-new-test/guide/xml/portfile-global.7.xml)
===================================================================
--- trunk/doc-new-test/guide/xml/portfile-global-variables.7.xml (rev 0)
+++ trunk/doc-new-test/guide/xml/portfile-global-variables.7.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!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>
+
+ <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>
+
+ <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>
+
+ <varlistentry>
+ <term>binpath</term>
+
+ <listitem>
+ <para>Default PATH to use in finding executables.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>libpath</term>
+
+ <listitem>
+ <para>Path to the MacPorts TCL libraries.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>portpath</term>
+
+ <listitem>
+ <para>Full path to the Portfile location.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>filesdir</term>
+
+ <listitem>
+ <para>Path to port files relative to
+ <varname>${portpath}</varname>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>workpath</term>
+
+ <listitem>
+ <para>Full path to work directory.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>worksrcpath</term>
+
+ <listitem>
+ <para>Full path to extracted source code. Equivalent to
+ <varname>${workpath}/${worksrcdir}</varname>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>destroot</term>
+
+ <listitem>
+ <para>Full path into which software will be destrooted. Equivalent
+ to <filename>${workpath}/destroot</filename>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>distpath</term>
+
+ <listitem>
+ <para>Location to store downloaded distfiles.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>install.user</term>
+
+ <listitem>
+ <para>The Unix user at the time of port installation.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>install.group</term>
+
+ <listitem>
+ <para>The Unix group at the time of port installation.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>os.platform</term>
+
+ <listitem>
+ <para>Identifies platform type (ie, "darwin", "freebsd",
+ etc).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>os.arch</term>
+
+ <listitem>
+ <para>Identifies hardware type (ie, "powerpc", "intel").</para>
+ </listitem>
+ </varlistentry>
+
+ <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>
+
+ <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>
Deleted: trunk/doc-new-test/guide/xml/portfile-global.7.xml
===================================================================
--- trunk/doc-new-test/guide/xml/portfile-global.7.xml 2007-11-17 17:57:32 UTC (rev 31177)
+++ trunk/doc-new-test/guide/xml/portfile-global.7.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -1,836 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<refentry>
- <refmeta>
- <refentrytitle>PORTFILE-GLOBAL</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>portfile-global</refname>
-
- <refpurpose>MacPorts Portfile reference</refpurpose>
- </refnamediv>
-
- <refsection>
- <title>Description</title>
-
- <para>A reference of all available Portfile global variables and keywords.
- Portfiles consist of valid TCL and are encoded in UTF-8. They usually
- contain only simple keyword/value combinations and Tcl extensions as
- described below, though they may also contain arbitrary TCL code. Every
- port has a corresponding Portfile, but Portfiles do not completely define
- a port's installation behavior since the MacPorts base has default port
- installation characteristics coded within it. Therefore Portfiles need
- only specify required options and, if necessary, non-default
- characteristics for a port.</para>
- </refsection>
-
- <refsection>
- <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>
-
- <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>
-
- <para>Default: /opt/local</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>binpath</term>
-
- <listitem>
- <para>Default PATH to use in finding executables.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>libpath</term>
-
- <listitem>
- <para>Path to the MacPorts TCL libraries.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>portpath</term>
-
- <listitem>
- <para>Full path to the Portfile location.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>filesdir</term>
-
- <listitem>
- <para>Path to port files relative to
- <varname>${portpath}</varname>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>workpath</term>
-
- <listitem>
- <para>Full path to work directory.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>worksrcpath</term>
-
- <listitem>
- <para>Full path to extracted source code. Equivalent to
- <varname>${workpath}/${worksrcdir}</varname>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>destroot</term>
-
- <listitem>
- <para>Full path into which software will be destrooted. Equivalent
- to <filename>${workpath}/destroot</filename>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>distpath</term>
-
- <listitem>
- <para>Location to store downloaded distfiles.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>install.user</term>
-
- <listitem>
- <para>The Unix user at the time of port installation.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>install.group</term>
-
- <listitem>
- <para>The Unix group at the time of port installation.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>os.platform</term>
-
- <listitem>
- <para>Identifies platform type (ie, "darwin", "freebsd",
- etc).</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>os.arch</term>
-
- <listitem>
- <para>Identifies hardware type (ie, "powerpc", "intel").</para>
- </listitem>
- </varlistentry>
-
- <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>
-
- <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>
- </refsection>
-
- <refsection>
- <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>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>
-
- <refsection>
- <title>General</title>
-
- <para>The list of global keywords.</para>
-
- <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>
-
- <programlisting>PortSystem 1.0
-
-</programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>name</term>
-
- <listitem>
- <para>The name of the Port; it should be lowercase.</para>
-
- <programlisting>name foo</programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>version</term>
-
- <listitem>
- <para>The version of the ported software.</para>
-
- <programlisting>version 1.23.45</programlisting>
- </listitem>
- </varlistentry>
-
- <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>
-
- <programlisting>revision 1</programlisting>
- </listitem>
- </varlistentry>
-
- <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>
-
- <programlisting>epoch 20070924</programlisting>
-
- <programlisting>epoch 1</programlisting>
- </listitem>
- </varlistentry>
-
- <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>
-
- <programlisting>categories net security</programlisting>
- </listitem>
- </varlistentry>
-
- <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>
-
- <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>
-
- <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 \
- example.org:julesverne</programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>description</term>
-
- <listitem>
- <para>A one-sentence description of the ported software.</para>
-
- <programlisting>description A classic shooter arcade game.</programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>long_description</term>
-
- <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 \
- the game alien-munchers. Not suitable for \
- children under two years old. </programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>homepage</term>
-
- <listitem>
- <para>Port application's homepage.</para>
-
- <programlisting>homepage http://www.somesite.org/apps</programlisting>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>platforms</term>
-
- <listitem>
- <para>The platforms on which the port has been tested.</para>
-
- <programlisting>platforms darwin freebsd</programlisting>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
-
- <refsection>
- <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>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>
-
- <term>depends_lib-append</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>
-
- <varlistentry>
- <term>depends_build</term>
-
- <term>depends_build-append</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>
-
- <varlistentry>
- <term>depends_run</term>
-
- <term>depends_run-append</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>
-
- <refsection>
- <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, the preferred type, are specified as shown in
- these examples:</para>
-
- <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>
-
- <programlisting>depends_lib lib:libX11.6:xorg
-
-depends_build bin:rrdtool</programlisting>
- </refsection>
- </refsection>
-
- <refsection>
- <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>
-
- <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>
-
- <itemizedlist>
- <listitem>
- <para>Default: no</para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>variant gnome requires glib {
- configure.args-append --with-gnome
- depends_lib-append port:gnome-session
-}</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <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>
-
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>default_variants +ssl +tcpd
-
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <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>
-
- <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>
-
- <itemizedlist>
- <listitem>
- <para>Default: yes</para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>universal_variant no</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
-
- <refsection>
- <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>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>
-
- <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>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>
-
- <listitem>
- <para>Values: freshmeat sourceforge googlecode moddate regex
- regexm md5 none</para>
- </listitem>
-
- <listitem>
- <para>Examples:</para>
-
- <programlisting>livecheck.check regex
-livecheck.url http://dev.mysql.com/
-livecheck.regex "Generally Available (${major_version}\\.\[0-9.\]+)"
-</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>livecheck.name</term>
-
- <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>
-
- <listitem>
- <para>Values:
- <replaceable>any_project_name</replaceable></para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>livecheck.name hibernate</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <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>
-
- <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>Example:</para>
-
- <programlisting>livecheck.distname faad2.src</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>livecheck.version</term>
-
- <listitem>
- <para>Version of the project for a check; used for regex-based
- checks.</para>
-
- <itemizedlist>
- <listitem>
- <para>Default: <varname>${version}</varname></para>
- </listitem>
-
- <listitem>
- <para>Values: <replaceable>any_version</replaceable></para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>livecheck.version ${name}-${version}</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>livecheck.url</term>
-
- <listitem>
- <para>URL to query for a check.</para>
-
- <itemizedlist>
- <listitem>
- <para>Default:</para>
-
- <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://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>Values: <replaceable>any_url</replaceable></para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>livecheck.url http://ftp.gnu.org/gnu/bison/</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <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>
-
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
-
- <listitem>
- <para>Values: <replaceable>any_regex</replaceable></para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>livecheck.regex 4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>livecheck.md5</term>
-
- <listitem>
- <para>md5 checksum to use for an md5 comparison.</para>
-
- <itemizedlist>
- <listitem>
- <para>Default: none</para>
- </listitem>
-
- <listitem>
- <para>Values:
- <replaceable>any_md5_checksum</replaceable></para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <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>
-
- <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>
-
- <itemizedlist>
- <listitem>
- <para>Default: moddate</para>
- </listitem>
-
- <listitem>
- <para>Values: moddate none</para>
- </listitem>
-
- <listitem>
- <para>Example:</para>
-
- <programlisting>distcheck.check none</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
- </refsection>
-
- <refsection>
- <title>SEE ALSO</title>
-
- <para><citerefentry>
- <refentrytitle>portfile-phase</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-startupitem</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-tcl</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry></para>
- </refsection>
-
- <refsection>
- <title>AUTHORS</title>
-
- <para>Landon Fuller <email>landonf at macports.org</email></para>
-
- <para>Juan Manuel Palacios <email>jmpp at macports.org</email></para>
-
- <para>Mark Duling <email>markd at macports.org</email></para>
-
- <para>Kevin Van Vechten <email>kevin at opendarwin.org</email></para>
-
- <para>Jordan K. Hubbard <email>jkh at macports.org</email></para>
-
- <para>Chris Ridd <email>cjr at opendarwin.org</email></para>
-
- <para>Kevin Ballard <email>eridius at macports.org</email></para>
-
- <para>Markus W. Weissmann <email>mww at macports.org</email></para>
- </refsection>
-</refentry>
\ No newline at end of file
Modified: trunk/doc-new-test/guide/xml/portfile-phase.7.xml
===================================================================
--- trunk/doc-new-test/guide/xml/portfile-phase.7.xml 2007-11-17 17:57:32 UTC (rev 31177)
+++ trunk/doc-new-test/guide/xml/portfile-phase.7.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -1,34 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<refentry>
- <refmeta>
- <refentrytitle>PORTFILE-PHASE</refentrytitle>
- <manvolnum>7</manvolnum>
- </refmeta>
+ <section>
+ <title>Port Phases</title>
- <refnamediv>
- <refname>portfile-phase</refname>
-
- <refpurpose>MacPorts Portfile reference</refpurpose>
- </refnamediv>
-
- <refsection>
- <title>Description</title>
-
- <para>A reference of all available Portfile keywords that relate to port
- phases. Portfiles consist of valid TCL and are encoded in UTF-8. They
- usually contain only simple keyword/value combinations and Tcl extensions
- as described below, though they may also contain arbitrary TCL code. Every
- port has a corresponding Portfile, but Portfiles do not completely define
- a port's installation behavior since the MacPorts base has default port
- installation characteristics coded within it. Therefore Portfiles need
- only specify required options and, if necessary, non-default
- characteristics for a port.</para>
- </refsection>
-
- <refsection>
+ <section>
<title>Installation Phase Keywords</title>
<para>MacPorts keywords are used to specify required or optional items
@@ -42,7 +19,7 @@
phases and set options for those phases, and they take affect whether or
not phase declarations have been explicitly defined in a Portfile.</para>
- <refsection>
+ <section>
<title>A Word about Keyword List Modifiers (-append / -delete)</title>
<para>It is often necessary to add to a list of keyword values
@@ -55,7 +32,7 @@
preserve configure defaults, to preserve PortGroup dependencies, and to
add or delete items for variants.</para>
- <refsection>
+ <section>
<title>Common Uses for Keyword List Modifiers</title>
<para>The three most common uses for keyword list modifiers are to
@@ -127,10 +104,10 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
- </refsection>
+ </section>
+ </section>
- <refsection>
+ <section>
<title>A Word about Keyword Argument Modifiers (.pre_args /
.post_args)</title>
@@ -141,9 +118,11 @@
keyword <literal>configure.pre_args</literal> also supports
<literal>configure.pre_args-append</literal> and
<literal>configure.pre_args-delete</literal>.</para>
- </refsection>
+ </section>
- <refsection>
+ </section>
+
+ <section>
<title>Fetch Phase Keywords</title>
<para>The list of keywords related to the fetch phase.</para>
@@ -380,7 +359,7 @@
</varlistentry>
</variablelist>
- <refsection>
+ <section>
<title>Fetch from CVS</title>
<para><ulink url="http://www.nongnu.org/cvs/">CVS</ulink> may be used
@@ -471,9 +450,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Fetch from Subversion</title>
<para><ulink url="http://subversion.tigris.org/">Subversion</ulink>
@@ -530,10 +509,10 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
- </refsection>
+ </section>
+ </section>
- <refsection>
+ <section>
<title>Checksum Phase Keywords</title>
<para>The list of keywords related to the checksum phase.</para>
@@ -570,9 +549,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Extract Phase Keywords</title>
<para>The list of keywords related to the extract phase.</para>
@@ -682,9 +661,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Patch Phase Keywords</title>
<para>The list of keywords related to the patch phase.</para>
@@ -815,9 +794,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Configure Phase Keywords</title>
<para>The list of keywords related to the configure phase.</para>
@@ -1488,7 +1467,7 @@
</varlistentry>
</variablelist>
- <refsection>
+ <section>
<title>Configure Universal</title>
<para>Universal keywords are used to make a port compile on the OS X
@@ -1609,9 +1588,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Automake and Autoconf</title>
<para>The list of configure keywords available for ports that need
@@ -1704,10 +1683,10 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
- </refsection>
+ </section>
+ </section>
- <refsection>
+ <section>
<title>Build Phase Keywords</title>
<para>The list of keywords related to the build phase.</para>
@@ -1847,9 +1826,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Destroot Phase Keywords</title>
<para>The list of keywords related to the destroot phase.</para>
@@ -2010,44 +1989,5 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
- </refsection>
-
- <refsection>
- <title>SEE ALSO</title>
-
- <para><citerefentry>
- <refentrytitle>portfile-global</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-startupitem</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-tcl</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry></para>
- </refsection>
-
- <refsection>
- <title>AUTHORS</title>
-
- <para>Landon Fuller <email>landonf at macports.org</email></para>
-
- <para>Juan Manuel Palacios <email>jmpp at macports.org</email></para>
-
- <para>Mark Duling <email>markd at macports.org</email></para>
-
- <para>Kevin Van Vechten <email>kevin at opendarwin.org</email></para>
-
- <para>Jordan K. Hubbard <email>jkh at macports.org</email></para>
-
- <para>Chris Ridd <email>cjr at opendarwin.org</email></para>
-
- <para>Kevin Ballard <email>eridius at macports.org</email></para>
-
- <para>Markus W. Weissmann <email>mww at macports.org</email></para>
- </refsection>
-</refentry>
+ </section>
+ </section>
Modified: trunk/doc-new-test/guide/xml/portfile-startupitem.7.xml
===================================================================
--- trunk/doc-new-test/guide/xml/portfile-startupitem.7.xml 2007-11-17 17:57:32 UTC (rev 31177)
+++ trunk/doc-new-test/guide/xml/portfile-startupitem.7.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -1,35 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<refentry>
- <refmeta>
- <refentrytitle>PORTFILE-STARTUPITEM</refentrytitle>
- <manvolnum>7</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>portfile-startupitem</refname>
-
- <refpurpose>MacPorts Portfile reference</refpurpose>
- </refnamediv>
-
- <refsection>
- <title>Description</title>
-
- <para>A complete reference of all available Portfile StartupItem keywords.
- Portfiles consist of valid TCL and are encoded in UTF-8. They usually
- contain only simple keyword/value combinations and Tcl extensions as
- described below, though they may also contain arbitrary TCL code. Every
- port has a corresponding Portfile, but Portfiles do not completely define
- a port's installation behavior since the MacPorts base has default port
- installation characteristics coded within it. Therefore Portfiles need
- only specify required options and, if necessary, non-default
- characteristics for a port.</para>
- </refsection>
-
- <refsection>
- <refsection>
+ <section>
<title>StartupItems</title>
<para>A StartupItem is a MacPort facility to run "daemons," a Unix term
@@ -59,7 +32,7 @@
created.</para>
</note>
- <refsection>
+ <section>
<title>StartupItem Attributes</title>
<para>The keywords in this section may be used with either
@@ -213,9 +186,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Executable StartupItems</title>
<para>Daemons run continuously, so monitoring the health of daemon
@@ -292,9 +265,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Script StartupItems</title>
<para>StartupItems of type <quote>script</quote> use
@@ -475,9 +448,9 @@
</listitem>
</varlistentry>
</variablelist>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>Loading / Unloading StartupItems into launchd</title>
<para>A port with a StartupItem places a link to a .plist file for the
@@ -495,9 +468,9 @@
<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>
- </refsection>
+ </section>
- <refsection>
+ <section>
<title>StartupItem Internals</title>
<para>During port installation a MacPorts StartupItem creates a .plist
@@ -538,45 +511,5 @@
}
[... trimmed ...]</programlisting>
- </refsection>
- </refsection>
- </refsection>
-
- <refsection>
- <title>SEE ALSO</title>
-
- <para><citerefentry>
- <refentrytitle>portfile-global</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-phase</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-tcl</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry></para>
- </refsection>
-
- <refsection>
- <title>AUTHORS</title>
-
- <para>Landon Fuller <email>landonf at macports.org</email></para>
-
- <para>Juan Manuel Palacios <email>jmpp at macports.org</email></para>
-
- <para>Mark Duling <email>markd at macports.org</email></para>
-
- <para>Kevin Van Vechten <email>kevin at opendarwin.org</email></para>
-
- <para>Jordan K. Hubbard <email>jkh at macports.org</email></para>
-
- <para>Chris Ridd <email>cjr at opendarwin.org</email></para>
-
- <para>Kevin Ballard <email>eridius at macports.org</email></para>
-
- <para>Markus W. Weissmann <email>mww at macports.org</email></para>
- </refsection>
-</refentry>
\ No newline at end of file
+ </section>
+ </section>
Modified: trunk/doc-new-test/guide/xml/portfile-tcl.7.xml
===================================================================
--- trunk/doc-new-test/guide/xml/portfile-tcl.7.xml 2007-11-17 17:57:32 UTC (rev 31177)
+++ trunk/doc-new-test/guide/xml/portfile-tcl.7.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -1,74 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<refentry>
- <refmeta>
- <refentrytitle>PORTFILE-TCL</refentrytitle>
- <manvolnum>7</manvolnum>
- </refmeta>
+ <section>
+ <title>Tcl Extensions</title>
- <refnamediv>
- <refname>portfile-tcl</refname>
-
- <refpurpose>MacPorts Portfile reference</refpurpose>
- </refnamediv>
-
- <refsection>
- <title>Description</title>
-
- <para>A complete reference of all available Portfile Tcl extensions.
- Portfiles consist of valid TCL and are encoded in UTF-8. They usually
- contain only simple keyword/value combinations and Tcl extensions as
- described below, though they may also contain arbitrary TCL code. Every
- port has a corresponding Portfile, but Portfiles do not completely define
- a port's installation behavior since the MacPorts base has default port
- installation characteristics coded within it. Therefore Portfiles need
- only specify required options and, if necessary, non-default
- characteristics for a port.</para>
- </refsection>
-
- <refsection>
- <title>TCL EXTENSIONS</title>
-
- <para></para>
- </refsection>
-
- <refsection>
- <title>SEE ALSO</title>
-
- <para><citerefentry>
- <refentrytitle>portfile-global</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-phase</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-startupitem</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry></para>
- </refsection>
-
- <refsection>
- <title>AUTHORS</title>
-
- <para>Landon Fuller <email>landonf at macports.org</email></para>
-
- <para>Juan Manuel Palacios <email>jmpp at macports.org</email></para>
-
- <para>Mark Duling <email>markd at macports.org</email></para>
-
- <para>Kevin Van Vechten <email>kevin at opendarwin.org</email></para>
-
- <para>Jordan K. Hubbard <email>jkh at macports.org</email></para>
-
- <para>Chris Ridd <email>cjr at opendarwin.org</email></para>
-
- <para>Kevin Ballard <email>eridius at macports.org</email></para>
-
- <para>Markus W. Weissmann <email>mww at macports.org</email></para>
- </refsection>
-</refentry>
\ No newline at end of file
+ <para>TODO: Describe Tcl Extensions here ..</para>
+ </section>
Modified: trunk/doc-new-test/guide/xml/portfileref.xml
===================================================================
--- trunk/doc-new-test/guide/xml/portfileref.xml 2007-11-17 17:57:32 UTC (rev 31177)
+++ trunk/doc-new-test/guide/xml/portfileref.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -8,41 +8,22 @@
Portfile: port phases, dependencies, StartupItems, variables, keywords, and
Tcl extensions.</para>
- <section id="reference.portfile">
- <title>Portfile</title>
+ <xi:include href="portfile-global-variables.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="../../man/xml/portfile.7.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </section>
+ <xi:include href="portfile-global-keywords.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <section id="reference.portfile.global">
- <title>Portfile Global</title>
+ <xi:include href="portfile-phase.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="../../man/xml/portfile-global.7.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </section>
+ <xi:include href="portfile-startupitem.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <section id="reference.phase">
- <title>Portfile Phase</title>
+ <xi:include href="portfile-tcl.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="../../man/xml/portfile-phase.7.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </section>
- <section id="reference.startupitem">
- <title>Portfile Startupitem</title>
-
- <xi:include href="../../man/xml/portfile-startupitem.7.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </section>
-
- <section id="reference.tcl">
- <title>Portfile Tcl</title>
-
- <xi:include href="../../man/xml/portfile-tcl.7.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </section>
-
<section id="reference.portgroup">
<title>PortGroup</title>
Modified: trunk/doc-new-test/man/xml/portfile.7.xml
===================================================================
--- trunk/doc-new-test/man/xml/portfile.7.xml 2007-11-17 17:57:32 UTC (rev 31177)
+++ trunk/doc-new-test/man/xml/portfile.7.xml 2007-11-17 18:20:26 UTC (rev 31178)
@@ -27,32 +27,21 @@
characteristics for a port.</para>
</refsection>
- <refsection>
- <title>Portfile man pages</title>
+ <xi:include href="../tmp/portfile-global-variables.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <para>The Portfile man pages serve as a reference for all available
- Portfile keywords, variables, StartupItems, and Tcl extensions. This
- content is contained in four Portfile man pages:</para>
+ <xi:include href="../tmp/portfile-global-keywords.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <para><citerefentry>
- <refentrytitle>portfile-global</refentrytitle>
+ <xi:include href="../tmp/portfile-phase.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-phase</refentrytitle>
+ <xi:include href="../tmp/portfile-startupitem.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-startupitem</refentrytitle>
+ <xi:include href="../tmp/portfile-tcl.7.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <manvolnum>7</manvolnum>
- </citerefentry>, <citerefentry>
- <refentrytitle>portfile-tcl</refentrytitle>
-
- <manvolnum>7</manvolnum>
- </citerefentry></para>
- </refsection>
-
<refsection>
<title>SEE ALSO</title>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20071117/03c76d23/attachment-0001.html
More information about the macports-changes
mailing list