[30831] trunk/doc-new/man/xml/portgroup.7.xml

source_changes at macosforge.org source_changes at macosforge.org
Wed Nov 7 23:49:36 PST 2007


Revision: 30831
          http://trac.macosforge.org/projects/macports/changeset/30831
Author:   markd at macports.org
Date:     2007-11-07 23:49:35 -0800 (Wed, 07 Nov 2007)

Log Message:
-----------
Merge information from the reference section into new portgroup.7.xml man page.

Modified Paths:
--------------
    trunk/doc-new/man/xml/portgroup.7.xml

Modified: trunk/doc-new/man/xml/portgroup.7.xml
===================================================================
--- trunk/doc-new/man/xml/portgroup.7.xml	2007-11-08 07:20:19 UTC (rev 30830)
+++ trunk/doc-new/man/xml/portgroup.7.xml	2007-11-08 07:49:35 UTC (rev 30831)
@@ -46,19 +46,106 @@
   <refsection>
     <title>PortGroup gnustep</title>
 
-    <para>PortGroup gnustep allows for efficient porting of GNUstep-based
-    opensource software using the GNU objective-C runtime that defines options
-    for the configuration, build, and destroot phases, and also defines some
+    <para>PortGroup gnustep allows for efficient porting of GNUstep-based open
+    source software using the GNU objective-C runtime that defines options for
+    the configuration, build, and destroot phases, and also defines some
     values for GNUstep-based software. A minimum Portfile using the gnustep
     PortGroup class need only define the fetch and the checksum phases.</para>
 
     <refsection>
-      <title>gnustep Filesystem Layout</title>
+      <title>gnustep PortGroup Specific Keywords</title>
 
+      <para>Portfiles using the gnustep PortGroup allow for port authors to
+      set the following keywords in addition to the general Portfile
+      keywords.</para>
+
+      <variablelist>
+        <varlistentry>
+          <term>gnustep.post_flags</term>
+
+          <listitem>
+            <para>An associative array which specifies the sub-directories
+            relative to ${worksrcpath} and the SHARED_LD_POSTFLAGS variables
+            to be added to GNUmakefile.preamble in those sub-directories. This
+            helps making the patching process easier on Darwin.</para>
+
+            <itemizedlist>
+              <listitem>
+                <para>Type: optional</para>
+              </listitem>
+
+              <listitem>
+                <para>Default: none</para>
+              </listitem>
+
+              <listitem>
+                <para>Example:</para>
+
+                <programlisting>platform darwin {
+                    array set gnustep.post_flags {
+                         BundleSubDir "-lfoo -lbar"
+                    }
+               }</programlisting>
+              </listitem>
+            </itemizedlist>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>gnustep.cc</term>
+
+          <listitem>
+            <para>Define the gcc compiler to use when compiling a port.</para>
+
+            <itemizedlist>
+              <listitem>
+                <para>Type: optional</para>
+              </listitem>
+
+              <listitem>
+                <para>Default: gcc-mp-4.2</para>
+              </listitem>
+
+              <listitem>
+                <para>Example:</para>
+
+                <programlisting>gnustep.cc gcc-mp-4.3</programlisting>
+              </listitem>
+            </itemizedlist>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>variant with_docs</term>
+
+          <listitem>
+            <para>Many GNUstep packages include a Documentation sub-directory
+            that is not built by default. Enabling this variant builds and
+            installs the included documentation.</para>
+
+            <itemizedlist>
+              <listitem>
+                <para>Type: optional</para>
+              </listitem>
+
+              <listitem>
+                <para>Example:</para>
+
+                <programlisting><prompt>%%</prompt> <userinput>port install gnustep-gui +with_docs</userinput></programlisting>
+              </listitem>
+            </itemizedlist>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsection>
+
+    <refsection>
+      <title>gnustep FilesystemLayout Keywords</title>
+
       <para>PortGroup gnustep supports both the traditional gnustep file
       layout and the new fhs file layout. However, a given ported application
       does not necessarily support both. The Portfiles have access to many
-      procedures in dealing with these two layouts:</para>
+      procedures to handle these two layouts:</para>
 
       <variablelist>
         <varlistentry>
@@ -126,7 +213,7 @@
           <term>homepage</term>
 
           <listitem>
-            <para>Default: http://www.gnustep.org/ </para>
+            <para>Default: http://www.gnustep.org/</para>
           </listitem>
         </varlistentry>
 
@@ -134,7 +221,7 @@
           <term>master_sites</term>
 
           <listitem>
-            <para>Default: gnustep:core </para>
+            <para>Default: gnustep:core</para>
           </listitem>
         </varlistentry>
 
@@ -211,175 +298,257 @@
         </varlistentry>
       </variablelist>
     </refsection>
+  </refsection>
 
+  <refsection>
+    <title>PortGroup perl5</title>
+
+    <para>PortGroup perl5 allows for efficient porting of perl modules and
+    other perl open source software.</para>
+
     <refsection>
-      <title>gnustep PortGroup Specific Variables</title>
+      <title>perl5 PortGroup Specific Keywords</title>
 
-      <para>When the gnustep PortGroup is declared within a Portfile, the
-      following variables are provided during port install.</para>
+      <para>Portfiles using the perl5 PortGroup allow for port authors to set
+      the following keywords in addition to the general Portfile
+      keywords.</para>
 
       <variablelist>
         <varlistentry>
-          <term>gnustep.post_flags</term>
+          <term>perl5.setup</term>
 
           <listitem>
-            <para>An associative array which specifies the sub-directories
-            relative to ${worksrcpath} and the SHARED_LD_POSTFLAGS variables
-            to be added to GNUmakefile.preamble in those sub-directories. This
-            helps making the patching process easier on Darwin.</para>
+            <para>This keyword sets the ${distfile} and ${version}.</para>
 
             <itemizedlist>
               <listitem>
-                <para>Type: optional</para>
+                <para>Type: required</para>
               </listitem>
 
               <listitem>
-                <para>Default: none</para>
-              </listitem>
-
-              <listitem>
                 <para>Example:</para>
 
-                <programlisting>platform darwin {
-                    array set gnustep.post_flags {
-                         BundleSubDir "-lfoo -lbar"
-                    }
-               }</programlisting>
+                <programlisting>perl5.setup          Net-Telnet 3.03</programlisting>
               </listitem>
             </itemizedlist>
           </listitem>
         </varlistentry>
+      </variablelist>
+    </refsection>
 
+    <refsection>
+      <title>perl5 PortGroup Sugar</title>
+
+      <para>Portfiles using PortGroup perl5 do not need to define the
+      following variables:</para>
+
+      <variablelist>
         <varlistentry>
-          <term>gnustep.cc</term>
+          <term>categories</term>
 
           <listitem>
-            <para>Define the gcc compiler to use when compiling a port.</para>
+            <para>Default: perl</para>
+          </listitem>
+        </varlistentry>
 
-            <itemizedlist>
-              <listitem>
-                <para>Type: optional</para>
-              </listitem>
+        <varlistentry>
+          <term>master_sites</term>
 
-              <listitem>
-                <para>Default: gcc-mp-4.2</para>
-              </listitem>
+          <listitem>
+            <para>Default: http://search.cpan.org/dist/${distname}</para>
+          </listitem>
+        </varlistentry>
 
-              <listitem>
-                <para>Example:</para>
+        <varlistentry>
+          <term>depends_lib</term>
 
-                <programlisting>gnustep.cc gcc-mp-4.3</programlisting>
-              </listitem>
-            </itemizedlist>
+          <listitem>
+            <para>Default: perl5.8</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term>variant with_docs</term>
+          <term>use_configure</term>
 
           <listitem>
-            <para>Many GNUstep packages include a Documentation sub-directory
-            that is not built by default. Enabling this variant builds and
-            installs the included documentation.</para>
+            <para>Default: no</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsection>
 
-            <itemizedlist>
-              <listitem>
-                <para>Type: optional</para>
-              </listitem>
+    <refsection>
+      <title>perl5 PortGroup Specific Variables</title>
 
-              <listitem>
-                <para>Example:</para>
+      <para>When the perl5 PortGroup is declared within a Portfile, the
+      following variables are provided during port install.</para>
 
-                <programlisting><prompt>%%</prompt> <userinput>port install gnustep-gui +with_docs</userinput></programlisting>
-              </listitem>
-            </itemizedlist>
+      <variablelist>
+        <varlistentry>
+          <term>perl5.version</term>
+
+          <listitem>
+            <para>The MacPorts Perl version.</para>
           </listitem>
         </varlistentry>
+
+        <varlistentry>
+          <term>perl5.bin</term>
+
+          <listitem>
+            <para>The Perl binary path (ie,
+            <filename>${prefix}/bin/perl</filename>).</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>perl5.lib</term>
+
+          <listitem>
+            <para>Path to the Perl vendor directory.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>perl5.archlib</term>
+
+          <listitem>
+            <para>Path to the Perl architecture-dependent modules
+            directory.</para>
+          </listitem>
+        </varlistentry>
       </variablelist>
     </refsection>
   </refsection>
 
   <refsection>
-    <title>PortGroup perl5</title>
+    <title>PortGroup python &amp; python2x</title>
 
-    <para></para>
-  </refsection>
+    <para>PortGroup python allows for efficient porting of python-based open
+    source software.</para>
 
-  <refsection>
-    <title>PortGroup python</title>
+    <refsection>
+      <title>python PortGroup Specific Variables</title>
 
-    <para></para>
-  </refsection>
+      <para>When the python PortGroup is declared within a Portfile, the
+      following variables are provided during port install.</para>
 
-  <refsection>
-    <title>PortGroup python24</title>
+      <variablelist>
+        <varlistentry>
+          <term>python.bin</term>
 
-    <para></para>
-  </refsection>
+          <listitem>
+            <para>The MacPorts Python binary location.</para>
+          </listitem>
+        </varlistentry>
 
-  <refsection>
-    <title>PortGroup python25</title>
+        <varlistentry>
+          <term>python.lib</term>
 
-    <para></para>
-  </refsection>
+          <listitem>
+            <para>The Python dynamic library and path (ie,
+            <filename>${prefix}/lib/libpython2.x.dylib</filename>).</para>
+          </listitem>
+        </varlistentry>
 
-  <refsection>
-    <title>PortGroup ruby</title>
+        <varlistentry>
+          <term>python.include</term>
 
-    <para></para>
+          <listitem>
+            <para>Path to the Python include directory.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>python.pkgd</term>
+
+          <listitem>
+            <para>Path to the Python site-packages directory. (ie,
+            <filename>${prefix}/lib/python2.4/site-packages</filename>).</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsection>
   </refsection>
 
   <refsection>
-    <title>PortGroup xcode</title>
+    <title>PortGroup ruby</title>
 
-    <para>PortGroup xcode allows for efficient porting of Xcode-based
-    opensource software. It handles configuration, build, and destroot phases.
-    It also defines some values for Xcode-based software. A minimum Portfile
-    using the xcode PortGroup class only defines the fetch and the checksum
-    phases.</para>
+    <para>PortGroup ruby allows for efficient porting of ruby-based open
+    source software.</para>
 
-    <para>Using PortGroup xcode is a way to make your port able to tolerate
-    Xcode version updates because the PortGroup is tested against all
-    supported Mac OS X and Xcode versions.</para>
-
     <refsection>
-      <title>xcode PortGroup Sugar</title>
+      <title>ruby PortGroup Specific Variables</title>
 
-      <para>Portfiles using xcode PortGroup do not need to define the
-      following variables:</para>
+      <para>When the ruby PortGroup is declared within a Portfile, the
+      following variables are provided during port install.</para>
 
       <variablelist>
         <varlistentry>
-          <term>categories</term>
+          <term>ruby.version</term>
 
           <listitem>
-            <para>Default: aqua</para>
+            <para>The MacPorts Ruby version.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term>platforms</term>
+          <term>ruby.bin</term>
 
           <listitem>
-            <para>Default: macosx</para>
+            <para>The Ruby binary location.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term>use_configure</term>
+          <term>ruby.lib</term>
 
           <listitem>
-            <para>Default: no</para>
+            <para>Path to the Ruby vendorlibdir directory (ie,
+            <filename>${prefix}/lib/ruby/vendor_ruby/${ruby.version}</filename>)</para>
           </listitem>
         </varlistentry>
+
+        <varlistentry>
+          <term>ruby.arch</term>
+
+          <listitem>
+            <para>The name for the Ruby architecture-dependent directory name
+            (ie, <literal>i686-darwin8.10.1</literal>).</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>ruby.archlib</term>
+
+          <listitem>
+            <para>Path to the Ruby vendor archdir (ie,
+            <filename>${ruby.lib}/${ruby.arch}</filename>).</para>
+          </listitem>
+        </varlistentry>
       </variablelist>
     </refsection>
+  </refsection>
 
+  <refsection>
+    <title>PortGroup xcode</title>
+
+    <para>PortGroup xcode allows for efficient porting of Xcode-based
+    opensource software. It handles configuration, build, and destroot phases.
+    It also defines some values for Xcode-based software. A minimum Portfile
+    using the xcode PortGroup class only defines the fetch and the checksum
+    phases.</para>
+
+    <para>Using PortGroup xcode is a way to make your port able to tolerate
+    Xcode version updates because the PortGroup is tested against all
+    supported Mac OS X and Xcode versions.</para>
+
     <refsection>
-      <title>xcode PortGroup Specific Variables</title>
+      <title>xcode PortGroup Specific Keywords</title>
 
-      <para>When the xcode PortGroup is declared within a Portfile, the
-      following variables are provided during port install:</para>
+      <para>Portfiles using the xcode PortGroup allow for port authors to set
+      the following keywords in addition to the general Portfile
+      keywords.</para>
 
       <variablelist>
         <varlistentry>
@@ -540,11 +709,44 @@
     </refsection>
 
     <refsection>
-      <title>Portfile-Phase Variables Affecting the xcode PortGroup</title>
+      <title>xcode PortGroup Sugar</title>
 
-      <para>The following Portfile phase variables affect the xcode PortGroup
-      in aunique way. In most cases, you will not need to set any of these
-      variables in the Portfile. See <citerefentry>
+      <para>Portfiles using the xcode PortGroup do not need to define the
+      following variables:</para>
+
+      <variablelist>
+        <varlistentry>
+          <term>categories</term>
+
+          <listitem>
+            <para>Default: aqua</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>platforms</term>
+
+          <listitem>
+            <para>Default: macosx</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>use_configure</term>
+
+          <listitem>
+            <para>Default: no</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsection>
+
+    <refsection>
+      <title>Portfile-Phase Keywords Affecting the xcode PortGroup</title>
+
+      <para>The following Portfile phase keywords affect the xcode PortGroup
+      in a unique way. In most cases, you will not need to set any of these
+      keywords in the Portfile. See <citerefentry>
           <refentrytitle>portfile-phase</refentrytitle>
 
           <manvolnum>7</manvolnum>
@@ -605,15 +807,15 @@
         <refentrytitle>port</refentrytitle>
 
         <manvolnum>1</manvolnum>
-      </citerefentry>,<citerefentry>
+      </citerefentry>, <citerefentry>
         <refentrytitle>macports.conf</refentrytitle>
 
         <manvolnum>5</manvolnum>
-      </citerefentry>,<citerefentry>
+      </citerefentry>, <citerefentry>
         <refentrytitle>portfile</refentrytitle>
 
         <manvolnum>7</manvolnum>
-      </citerefentry>,<citerefentry>
+      </citerefentry>, <citerefentry>
         <refentrytitle>porthier</refentrytitle>
 
         <manvolnum>7</manvolnum>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20071107/eae2816e/attachment-0001.html


More information about the macports-changes mailing list