cvs: peardoc /en/guide/developers packagedef.xml
| From: | Arnaud Limbourg | Date: | Fri, 15 Aug 2003 21:23:21 +0000 |
| Subject: | cvs: peardoc /en/guide/developers packagedef.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-1342@lists.php.net to get a copy of this message | ||
arnaud Fri Aug 15 17:23:21 2003 EDT
Modified files:
/peardoc/en/guide/developers packagedef.xml
Log:
* ws
Index: peardoc/en/guide/developers/packagedef.xml diff -u peardoc/en/guide/developers/packagedef.xml:1.5 peardoc/en/guide/developers/packagedef.xml:1.6 --- peardoc/en/guide/developers/packagedef.xml:1.5 Sat Jul 12 12:08:09 2003 +++ peardoc/en/guide/developers/packagedef.xml Fri Aug 15 17:23:21 2003 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. --> <chapter id="developers.packagedef"> - <title>The package definition file <filename>package.xml</filename></title> + <title>The package definition file <filename>package.xml</filename></title> <titleabbrev><filename>package.xml</filename></titleabbrev> <sect1 id="developers.packagedef.intro"> @@ -59,7 +59,7 @@ <listitem> <para> <literal><maintainers></literal>: Information about the - maintainers of the package. + maintainers of the package. <itemizedlist> <listitem> <para> @@ -91,9 +91,9 @@ </para> </listitem> </itemizedlist> - </para> + </para> </listitem> - <listitem> + <listitem> <para> <literal><release></literal>: Information about the current release. @@ -125,10 +125,10 @@ <para> <literal><filelist></literal> <itemizedlist> - <listitem> + <listitem> <simpara><literal><file role="xxx"></literal>: Filename</simpara> </listitem> - <listitem> + <listitem> <simpara> <literal><dir name="xxx" [role="xxx"]></literal>: Name of a subdirectory. This subdirectory can again contain @@ -198,14 +198,14 @@ </listitem> </itemizedlist> - </sect2> + </sect2> <sect2> <title>Creating a package definition file</title> <titleabbrev>Creating the file</titleabbrev> <para> <example> - <title>Basic <filename>package.xml</filename></title> + <title>Basic <filename>package.xml</filename></title> <programlisting role="xml"> <![CDATA[ <?xml version="1.0" encoding="ISO-8859-1" ?> @@ -250,7 +250,7 @@ </para> <para> <example> - <title>Example for nested directories</title> + <title>Example for nested directories</title> <programlisting role="xml"> <![CDATA[ <?xml version="1.0" encoding="ISO-8859-1" ?> @@ -284,11 +284,11 @@ ]]> </programlisting> </example> - </para> + </para> <para> In this example you get to know a very handy feature: When you have a directory in your package that only contains files of - the same type, you can add to role attribute even to the + the same type, you can add to role attribute even to the <literal><dir></literal> tag instead of adding it to every singe <literal><file></literal> tag. </para> @@ -307,75 +307,75 @@ defines what type the file has and in which location it should be installed. <table> - <title>Possible values</title> - <tgroup cols="3"> + <title>Possible values</title> + <tgroup cols="3"> <thead> <row> <entry>Value</entry> - <entry></entry> - <entry>Destination dir</entry> + <entry></entry> + <entry>Destination dir</entry> </row> </thead> <tbody> - + <row> <entry>php</entry> <entry>PHP source file</entry> <entry>the directory is determined by the package name</entry> - </row> + </row> <row> <entry>ext</entry> <entry>Extension, dynamically loadable library</entry> - <entry>the PHP extension directory or + <entry>the PHP extension directory or <constant>PHP_PEAR_EXTENSION_DIR</constant> if defined</entry> - </row> + </row> <row> <entry>doc</entry> <entry>Documentation file</entry> <entry>{PEAR_documentation_dir}/Package_Name/</entry> - </row> + </row> <row> <entry>data</entry> <entry>Package related data files (grapics etc)</entry> <entry>{PEAR_data_dir}/Package_Name/</entry> - </row> + </row> <row> <entry>test</entry> <entry>Package related data files (grapics etc)</entry> <entry>{PEAR_test_dir}/Package_Name/</entry> - </row> + </row> <row> <entry>script</entry> <entry>Package related shell scripts</entry> - <entry>the PHP binary directory or + <entry>the PHP binary directory or <constant>PHP_PEAR_BIN_DIR</constant> if defined</entry> - </row> + </row> <row> <entry>src and extsrc</entry> <entry>C or C++ source code</entry> <entry>not copied directly - used to build a extension</entry> - </row> - + </row> + </tbody> </tgroup> </table> </para> - + </sect2> <sect2 id="guide.developers.packagedef.deps"> <title>Defining Dependencies</title> <para> - The PEAR Package Manager supports checking for + The PEAR Package Manager supports checking for different system capabilities. You define those dependencies with the <literal><dep></literal> tag: <example> @@ -405,37 +405,37 @@ The following <literal>type</literal>s are supported: <table> <title>type values</title> - <tgroup cols="4"> + <tgroup cols="4"> <thead> <row> <entry>Value</entry> - <entry></entry> - <entry>Meaning</entry> + <entry></entry> + <entry>Meaning</entry> <entry>Example</entry> </row> </thead> <tbody> - + <row> <entry>pkg</entry> <entry>Package</entry> <entry>depends on a certain Package</entry> <entry><quote>HTML_Flexy</quote></entry> - </row> - + </row> + <row> <entry>ext</entry> <entry>Extension</entry> <entry>depends on a certain PHP extension</entry> - <entry><quote>curl</quote></entry> - </row> - + <entry><quote>curl</quote></entry> + </row> + <row> <entry>php</entry> <entry>PHP</entry> <entry>depends on a certain PHP version</entry> <entry><quote>4.2</quote></entry> - </row> + </row> <row> <entry>prog</entry> @@ -444,33 +444,33 @@ depends on a certain Program avaible in the system path </entry> - <entry><quote>latex</quote></entry> - </row> + <entry><quote>latex</quote></entry> + </row> <row> <entry>os</entry> <entry>Operating System</entry> <entry>depends on a certain OS version</entry> - <entry><quote>Linux</quote></entry> - </row> + <entry><quote>Linux</quote></entry> + </row> <row> <entry>sapi</entry> <entry>Server API</entry> <entry>depends on a certain Server API</entry> - <entry><quote>Apache</quote></entry> + <entry><quote>Apache</quote></entry> </row> <row> <entry>zend</entry> <entry>Zend</entry> <entry>depends on a certain version of the Zend API</entry> - <entry><quote>2</quote></entry> - </row> + <entry><quote>2</quote></entry> + </row> </tbody> </tgroup> </table> - + </para> <warning> <simpara> @@ -487,38 +487,38 @@ capability and the required. </para> <table> - <title>rel values</title> - <tgroup cols="4"> + <title>rel values</title> + <tgroup cols="4"> <thead> <row> <entry>Value</entry> - <entry></entry> - <entry>Meaning</entry> + <entry></entry> + <entry>Meaning</entry> <entry>Can be used with</entry> </row> </thead> <tbody> - + <row> <entry>has</entry> <entry>has</entry> <entry> - the existing capability must have the + the existing capability must have the requirement - version-attribute is not required </entry> <entry>pkg, ext, php, prog, os, sapi, zend</entry> - </row> + </row> <row> <entry>eq</entry> <entry>equal</entry> <entry> - the the existing capability must exactly match the + the the existing capability must exactly match the version value </entry> <entry>pkg, ext, php, prog, os, sapi, zend</entry> - </row> + </row> <row> <entry>lt</entry> @@ -527,7 +527,7 @@ the existing capability must be less than the version value </entry> <entry>pkg, ext, php, zend</entry> - </row> + </row> <row> <entry>le</entry> @@ -537,7 +537,7 @@ version value </entry> <entry>pkg, ext, php, zend</entry> - </row> + </row> <row> <entry>gt</entry> @@ -547,7 +547,7 @@ value </entry> <entry>pkg, ext, php, zend</entry> - </row> + </row> <row> <entry>ge</entry> @@ -557,8 +557,8 @@ version value </entry> <entry>pkg, ext, php, zend</entry> - </row> - + </row> + </tbody> </tgroup> </table> @@ -569,14 +569,14 @@ </sect3> <sect3> <title>The <literal>version</literal>-attribute</title> - + <para> The attribute <literal>version</literal> defines the version that is used to compare. </para> </sect3> </sect2> - </sect1> + </sect1> </chapter> <!-- Keep this comment at the end of the file
Index: peardoc/en/guide/developers/packagedef.xml diff -u peardoc/en/guide/developers/packagedef.xml:1.5 peardoc/en/guide/developers/packagedef.xml:1.6 --- peardoc/en/guide/developers/packagedef.xml:1.5 Sat Jul 12 12:08:09 2003 +++ peardoc/en/guide/developers/packagedef.xml Fri Aug 15 17:23:21 2003 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. --> <chapter id="developers.packagedef"> - <title>The package definition file <filename>package.xml</filename></title> + <title>The package definition file <filename>package.xml</filename></title> <titleabbrev><filename>package.xml</filename></titleabbrev> <sect1 id="developers.packagedef.intro"> @@ -59,7 +59,7 @@ <listitem> <para> <literal><maintainers></literal>: Information about the - maintainers of the package. + maintainers of the package. <itemizedlist> <listitem> <para> @@ -91,9 +91,9 @@ </para> </listitem> </itemizedlist> - </para> + </para> </listitem> - <listitem> + <listitem> <para> <literal><release></literal>: Information about the current release. @@ -125,10 +125,10 @@ <para> <literal><filelist></literal> <itemizedlist> - <listitem> + <listitem> <simpara><literal><file role="xxx"></literal>: Filename</simpara> </listitem> - <listitem> + <listitem> <simpara> <literal><dir name="xxx" [role="xxx"]></literal>: Name of a subdirectory. This subdirectory can again contain @@ -198,14 +198,14 @@ </listitem> </itemizedlist> - </sect2> + </sect2> <sect2> <title>Creating a package definition file</title> <titleabbrev>Creating the file</titleabbrev> <para> <example> - <title>Basic <filename>package.xml</filename></title> + <title>Basic <filename>package.xml</filename></title> <programlisting role="xml"> <![CDATA[ <?xml version="1.0" encoding="ISO-8859-1" ?> @@ -250,7 +250,7 @@ </para> <para> <example> - <title>Example for nested directories</title> + <title>Example for nested directories</title> <programlisting role="xml"> <![CDATA[ <?xml version="1.0" encoding="ISO-8859-1" ?> @@ -284,11 +284,11 @@ ]]> </programlisting> </example> - </para> + </para> <para> In this example you get to know a very handy feature: When you have a directory in your package that only contains files of - the same type, you can add to role attribute even to the + the same type, you can add to role attribute even to the <literal><dir></literal> tag instead of adding it to every singe <literal><file></literal> tag. </para> @@ -307,75 +307,75 @@ defines what type the file has and in which location it should be installed. <table> - <title>Possible values</title> - <tgroup cols="3"> + <title>Possible values</title> + <tgroup cols="3"> <thead> <row> <entry>Value</entry> - <entry></entry> - <entry>Destination dir</entry> + <entry></entry> + <entry>Destination dir</entry> </row> </thead> <tbody> - + <row> <entry>php</entry> <entry>PHP source file</entry> <entry>the directory is determined by the package name</entry> - </row> + </row> <row> <entry>ext</entry> <entry>Extension, dynamically loadable library</entry> - <entry>the PHP extension directory or + <entry>the PHP extension directory or <constant>PHP_PEAR_EXTENSION_DIR</constant> if defined</entry> - </row> + </row> <row> <entry>doc</entry> <entry>Documentation file</entry> <entry>{PEAR_documentation_dir}/Package_Name/</entry> - </row> + </row> <row> <entry>data</entry> <entry>Package related data files (grapics etc)</entry> <entry>{PEAR_data_dir}/Package_Name/</entry> - </row> + </row> <row> <entry>test</entry> <entry>Package related data files (grapics etc)</entry> <entry>{PEAR_test_dir}/Package_Name/</entry> - </row> + </row> <row> <entry>script</entry> <entry>Package related shell scripts</entry> - <entry>the PHP binary directory or + <entry>the PHP binary directory or <constant>PHP_PEAR_BIN_DIR</constant> if defined</entry> - </row> + </row> <row> <entry>src and extsrc</entry> <entry>C or C++ source code</entry> <entry>not copied directly - used to build a extension</entry> - </row> - + </row> + </tbody> </tgroup> </table> </para> - + </sect2> <sect2 id="guide.developers.packagedef.deps"> <title>Defining Dependencies</title> <para> - The PEAR Package Manager supports checking for + The PEAR Package Manager supports checking for different system capabilities. You define those dependencies with the <literal><dep></literal> tag: <example> @@ -405,37 +405,37 @@ The following <literal>type</literal>s are supported: <table> <title>type values</title> - <tgroup cols="4"> + <tgroup cols="4"> <thead> <row> <entry>Value</entry> - <entry></entry> - <entry>Meaning</entry> + <entry></entry> + <entry>Meaning</entry> <entry>Example</entry> </row> </thead> <tbody> - + <row> <entry>pkg</entry> <entry>Package</entry> <entry>depends on a certain Package</entry> <entry><quote>HTML_Flexy</quote></entry> - </row> - + </row> + <row> <entry>ext</entry> <entry>Extension</entry> <entry>depends on a certain PHP extension</entry> - <entry><quote>curl</quote></entry> - </row> - + <entry><quote>curl</quote></entry> + </row> + <row> <entry>php</entry> <entry>PHP</entry> <entry>depends on a certain PHP version</entry> <entry><quote>4.2</quote></entry> - </row> + </row> <row> <entry>prog</entry> @@ -444,33 +444,33 @@ depends on a certain Program avaible in the system path </entry> - <entry><quote>latex</quote></entry> - </row> + <entry><quote>latex</quote></entry> + </row> <row> <entry>os</entry> <entry>Operating System</entry> <entry>depends on a certain OS version</entry> - <entry><quote>Linux</quote></entry> - </row> + <entry><quote>Linux</quote></entry> + </row> <row> <entry>sapi</entry> <entry>Server API</entry> <entry>depends on a certain Server API</entry> - <entry><quote>Apache</quote></entry> + <entry><quote>Apache</quote></entry> </row> <row> <entry>zend</entry> <entry>Zend</entry> <entry>depends on a certain version of the Zend API</entry> - <entry><quote>2</quote></entry> - </row> + <entry><quote>2</quote></entry> + </row> </tbody> </tgroup> </table> - + </para> <warning> <simpara> @@ -487,38 +487,38 @@ capability and the required. </para> <table> - <title>rel values</title> - <tgroup cols="4"> + <title>rel values</title> + <tgroup cols="4"> <thead> <row> <entry>Value</entry> - <entry></entry> - <entry>Meaning</entry> + <entry></entry> + <entry>Meaning</entry> <entry>Can be used with</entry> </row> </thead> <tbody> - + <row> <entry>has</entry> <entry>has</entry> <entry> - the existing capability must have the + the existing capability must have the requirement - version-attribute is not required </entry> <entry>pkg, ext, php, prog, os, sapi, zend</entry> - </row> + </row> <row> <entry>eq</entry> <entry>equal</entry> <entry> - the the existing capability must exactly match the + the the existing capability must exactly match the version value </entry> <entry>pkg, ext, php, prog, os, sapi, zend</entry> - </row> + </row> <row> <entry>lt</entry> @@ -527,7 +527,7 @@ the existing capability must be less than the version value </entry> <entry>pkg, ext, php, zend</entry> - </row> + </row> <row> <entry>le</entry> @@ -537,7 +537,7 @@ version value </entry> <entry>pkg, ext, php, zend</entry> - </row> + </row> <row> <entry>gt</entry> @@ -547,7 +547,7 @@ value </entry> <entry>pkg, ext, php, zend</entry> - </row> + </row> <row> <entry>ge</entry> @@ -557,8 +557,8 @@ version value </entry> <entry>pkg, ext, php, zend</entry> - </row> - + </row> + </tbody> </tgroup> </table> @@ -569,14 +569,14 @@ </sect3> <sect3> <title>The <literal>version</literal>-attribute</title> - + <para> The attribute <literal>version</literal> defines the version that is used to compare. </para> </sect3> </sect2> - </sect1> + </sect1> </chapter> <!-- Keep this comment at the end of the file