Changeset 30831 for trunk/doc-new


Ignore:
Timestamp:
Nov 8, 2007, 7:49:35 AM (12 years ago)
Author:
markd@…
Message:

Merge information from the reference section into new portgroup.7.xml man page.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc-new/man/xml/portgroup.7.xml

    r30753 r30831  
    4747    <title>PortGroup gnustep</title>
    4848
    49     <para>PortGroup gnustep allows for efficient porting of GNUstep-based
    50     opensource software using the GNU objective-C runtime that defines options
    51     for the configuration, build, and destroot phases, and also defines some
     49    <para>PortGroup gnustep allows for efficient porting of GNUstep-based open
     50    source software using the GNU objective-C runtime that defines options for
     51    the configuration, build, and destroot phases, and also defines some
    5252    values for GNUstep-based software. A minimum Portfile using the gnustep
    5353    PortGroup class need only define the fetch and the checksum phases.</para>
    5454
    5555    <refsection>
    56       <title>gnustep Filesystem Layout</title>
    57 
    58       <para>PortGroup gnustep supports both the traditional gnustep file
    59       layout and the new fhs file layout. However, a given ported application
    60       does not necessarily support both. The Portfiles have access to many
    61       procedures in dealing with these two layouts:</para>
    62 
    63       <variablelist>
    64         <varlistentry>
    65           <term>set_gnustep_make</term>
    66 
    67           <listitem>
    68             <para>Sets GNUSTEP_MAKEFILES according to the
    69             FilesystemLayout</para>
    70           </listitem>
    71         </varlistentry>
    72 
    73         <varlistentry>
    74           <term>set_gnustep_env</term>
    75 
    76           <listitem>
    77             <para>Sets DYLD_LIBRARY_PATH and PATH for the gnustep
    78             FilesystemLayout</para>
    79           </listitem>
    80         </varlistentry>
    81 
    82         <varlistentry>
    83           <term>gnustep_layout</term>
    84 
    85           <listitem>
    86             <para>Returns true (1) if current file layout is gnustep</para>
    87           </listitem>
    88         </varlistentry>
    89 
    90         <varlistentry>
    91           <term>set_system_library</term>
    92 
    93           <listitem>
    94             <para>Sets GNUSTEP_SYSTEM_LIBRARY according to the
    95             FilesystemLayout</para>
    96           </listitem>
    97         </varlistentry>
    98 
    99         <varlistentry>
    100           <term>set_local_library</term>
    101 
    102           <listitem>
    103             <para>Sets GNUSTEP_LOCAL_LIBRARY according to the
    104             FilesystemLayout</para>
    105           </listitem>
    106         </varlistentry>
    107       </variablelist>
    108     </refsection>
    109 
    110     <refsection>
    111       <title>gnustep PortGroup Sugar</title>
    112 
    113       <para>Portfiles using PortGroup gnustep do not need to define the
    114       following variables:</para>
    115 
    116       <variablelist>
    117         <varlistentry>
    118           <term>categories</term>
    119 
    120           <listitem>
    121             <para>Default: gnustep</para>
    122           </listitem>
    123         </varlistentry>
    124 
    125         <varlistentry>
    126           <term>homepage</term>
    127 
    128           <listitem>
    129             <para>Default: http://www.gnustep.org/ </para>
    130           </listitem>
    131         </varlistentry>
    132 
    133         <varlistentry>
    134           <term>master_sites</term>
    135 
    136           <listitem>
    137             <para>Default: gnustep:core </para>
    138           </listitem>
    139         </varlistentry>
    140 
    141         <varlistentry>
    142           <term>depends_lib</term>
    143 
    144           <listitem>
    145             <para>Default: gnustep-core</para>
    146           </listitem>
    147         </varlistentry>
    148 
    149         <varlistentry>
    150           <term>use_configure</term>
    151 
    152           <listitem>
    153             <para>Default: no</para>
    154           </listitem>
    155         </varlistentry>
    156 
    157         <varlistentry>
    158           <term>configure.env</term>
    159 
    160           <listitem>
    161             <para>Default: DYLD_LIBRARY_PATH PATH</para>
    162           </listitem>
    163         </varlistentry>
    164 
    165         <varlistentry>
    166           <term>configure.pre_args-append</term>
    167 
    168           <listitem>
    169             <para>Default: CC=gcc-mp-4.2 GNUSTEP_MAKEFILES</para>
    170           </listitem>
    171         </varlistentry>
    172 
    173         <varlistentry>
    174           <term>build.type</term>
    175 
    176           <listitem>
    177             <para>Default: gnu</para>
    178           </listitem>
    179         </varlistentry>
    180 
    181         <varlistentry>
    182           <term>build.env</term>
    183 
    184           <listitem>
    185             <para>Default: DYLD_LIBRARY_PATH PATH</para>
    186           </listitem>
    187         </varlistentry>
    188 
    189         <varlistentry>
    190           <term>build.pre_args-append</term>
    191 
    192           <listitem>
    193             <para>Default: messages=yes</para>
    194           </listitem>
    195         </varlistentry>
    196 
    197         <varlistentry>
    198           <term>destroot.env</term>
    199 
    200           <listitem>
    201             <para>Default: DYLD_LIBRARY_PATH PATH</para>
    202           </listitem>
    203         </varlistentry>
    204 
    205         <varlistentry>
    206           <term>destroot.pre_args-append</term>
    207 
    208           <listitem>
    209             <para>Default: messages=yes</para>
    210           </listitem>
    211         </varlistentry>
    212       </variablelist>
    213     </refsection>
    214 
    215     <refsection>
    216       <title>gnustep PortGroup Specific Variables</title>
    217 
    218       <para>When the gnustep PortGroup is declared within a Portfile, the
    219       following variables are provided during port install.</para>
     56      <title>gnustep PortGroup Specific Keywords</title>
     57
     58      <para>Portfiles using the gnustep PortGroup allow for port authors to
     59      set the following keywords in addition to the general Portfile
     60      keywords.</para>
    22061
    22162      <variablelist>
     
    298139      </variablelist>
    299140    </refsection>
     141
     142    <refsection>
     143      <title>gnustep FilesystemLayout Keywords</title>
     144
     145      <para>PortGroup gnustep supports both the traditional gnustep file
     146      layout and the new fhs file layout. However, a given ported application
     147      does not necessarily support both. The Portfiles have access to many
     148      procedures to handle these two layouts:</para>
     149
     150      <variablelist>
     151        <varlistentry>
     152          <term>set_gnustep_make</term>
     153
     154          <listitem>
     155            <para>Sets GNUSTEP_MAKEFILES according to the
     156            FilesystemLayout</para>
     157          </listitem>
     158        </varlistentry>
     159
     160        <varlistentry>
     161          <term>set_gnustep_env</term>
     162
     163          <listitem>
     164            <para>Sets DYLD_LIBRARY_PATH and PATH for the gnustep
     165            FilesystemLayout</para>
     166          </listitem>
     167        </varlistentry>
     168
     169        <varlistentry>
     170          <term>gnustep_layout</term>
     171
     172          <listitem>
     173            <para>Returns true (1) if current file layout is gnustep</para>
     174          </listitem>
     175        </varlistentry>
     176
     177        <varlistentry>
     178          <term>set_system_library</term>
     179
     180          <listitem>
     181            <para>Sets GNUSTEP_SYSTEM_LIBRARY according to the
     182            FilesystemLayout</para>
     183          </listitem>
     184        </varlistentry>
     185
     186        <varlistentry>
     187          <term>set_local_library</term>
     188
     189          <listitem>
     190            <para>Sets GNUSTEP_LOCAL_LIBRARY according to the
     191            FilesystemLayout</para>
     192          </listitem>
     193        </varlistentry>
     194      </variablelist>
     195    </refsection>
     196
     197    <refsection>
     198      <title>gnustep PortGroup Sugar</title>
     199
     200      <para>Portfiles using PortGroup gnustep do not need to define the
     201      following variables:</para>
     202
     203      <variablelist>
     204        <varlistentry>
     205          <term>categories</term>
     206
     207          <listitem>
     208            <para>Default: gnustep</para>
     209          </listitem>
     210        </varlistentry>
     211
     212        <varlistentry>
     213          <term>homepage</term>
     214
     215          <listitem>
     216            <para>Default: http://www.gnustep.org/</para>
     217          </listitem>
     218        </varlistentry>
     219
     220        <varlistentry>
     221          <term>master_sites</term>
     222
     223          <listitem>
     224            <para>Default: gnustep:core</para>
     225          </listitem>
     226        </varlistentry>
     227
     228        <varlistentry>
     229          <term>depends_lib</term>
     230
     231          <listitem>
     232            <para>Default: gnustep-core</para>
     233          </listitem>
     234        </varlistentry>
     235
     236        <varlistentry>
     237          <term>use_configure</term>
     238
     239          <listitem>
     240            <para>Default: no</para>
     241          </listitem>
     242        </varlistentry>
     243
     244        <varlistentry>
     245          <term>configure.env</term>
     246
     247          <listitem>
     248            <para>Default: DYLD_LIBRARY_PATH PATH</para>
     249          </listitem>
     250        </varlistentry>
     251
     252        <varlistentry>
     253          <term>configure.pre_args-append</term>
     254
     255          <listitem>
     256            <para>Default: CC=gcc-mp-4.2 GNUSTEP_MAKEFILES</para>
     257          </listitem>
     258        </varlistentry>
     259
     260        <varlistentry>
     261          <term>build.type</term>
     262
     263          <listitem>
     264            <para>Default: gnu</para>
     265          </listitem>
     266        </varlistentry>
     267
     268        <varlistentry>
     269          <term>build.env</term>
     270
     271          <listitem>
     272            <para>Default: DYLD_LIBRARY_PATH PATH</para>
     273          </listitem>
     274        </varlistentry>
     275
     276        <varlistentry>
     277          <term>build.pre_args-append</term>
     278
     279          <listitem>
     280            <para>Default: messages=yes</para>
     281          </listitem>
     282        </varlistentry>
     283
     284        <varlistentry>
     285          <term>destroot.env</term>
     286
     287          <listitem>
     288            <para>Default: DYLD_LIBRARY_PATH PATH</para>
     289          </listitem>
     290        </varlistentry>
     291
     292        <varlistentry>
     293          <term>destroot.pre_args-append</term>
     294
     295          <listitem>
     296            <para>Default: messages=yes</para>
     297          </listitem>
     298        </varlistentry>
     299      </variablelist>
     300    </refsection>
    300301  </refsection>
    301302
     
    303304    <title>PortGroup perl5</title>
    304305
    305     <para></para>
     306    <para>PortGroup perl5 allows for efficient porting of perl modules and
     307    other perl open source software.</para>
     308
     309    <refsection>
     310      <title>perl5 PortGroup Specific Keywords</title>
     311
     312      <para>Portfiles using the perl5 PortGroup allow for port authors to set
     313      the following keywords in addition to the general Portfile
     314      keywords.</para>
     315
     316      <variablelist>
     317        <varlistentry>
     318          <term>perl5.setup</term>
     319
     320          <listitem>
     321            <para>This keyword sets the ${distfile} and ${version}.</para>
     322
     323            <itemizedlist>
     324              <listitem>
     325                <para>Type: required</para>
     326              </listitem>
     327
     328              <listitem>
     329                <para>Example:</para>
     330
     331                <programlisting>perl5.setup          Net-Telnet 3.03</programlisting>
     332              </listitem>
     333            </itemizedlist>
     334          </listitem>
     335        </varlistentry>
     336      </variablelist>
     337    </refsection>
     338
     339    <refsection>
     340      <title>perl5 PortGroup Sugar</title>
     341
     342      <para>Portfiles using PortGroup perl5 do not need to define the
     343      following variables:</para>
     344
     345      <variablelist>
     346        <varlistentry>
     347          <term>categories</term>
     348
     349          <listitem>
     350            <para>Default: perl</para>
     351          </listitem>
     352        </varlistentry>
     353
     354        <varlistentry>
     355          <term>master_sites</term>
     356
     357          <listitem>
     358            <para>Default: http://search.cpan.org/dist/${distname}</para>
     359          </listitem>
     360        </varlistentry>
     361
     362        <varlistentry>
     363          <term>depends_lib</term>
     364
     365          <listitem>
     366            <para>Default: perl5.8</para>
     367          </listitem>
     368        </varlistentry>
     369
     370        <varlistentry>
     371          <term>use_configure</term>
     372
     373          <listitem>
     374            <para>Default: no</para>
     375          </listitem>
     376        </varlistentry>
     377      </variablelist>
     378    </refsection>
     379
     380    <refsection>
     381      <title>perl5 PortGroup Specific Variables</title>
     382
     383      <para>When the perl5 PortGroup is declared within a Portfile, the
     384      following variables are provided during port install.</para>
     385
     386      <variablelist>
     387        <varlistentry>
     388          <term>perl5.version</term>
     389
     390          <listitem>
     391            <para>The MacPorts Perl version.</para>
     392          </listitem>
     393        </varlistentry>
     394
     395        <varlistentry>
     396          <term>perl5.bin</term>
     397
     398          <listitem>
     399            <para>The Perl binary path (ie,
     400            <filename>${prefix}/bin/perl</filename>).</para>
     401          </listitem>
     402        </varlistentry>
     403
     404        <varlistentry>
     405          <term>perl5.lib</term>
     406
     407          <listitem>
     408            <para>Path to the Perl vendor directory.</para>
     409          </listitem>
     410        </varlistentry>
     411
     412        <varlistentry>
     413          <term>perl5.archlib</term>
     414
     415          <listitem>
     416            <para>Path to the Perl architecture-dependent modules
     417            directory.</para>
     418          </listitem>
     419        </varlistentry>
     420      </variablelist>
     421    </refsection>
    306422  </refsection>
    307423
    308424  <refsection>
    309     <title>PortGroup python</title>
    310 
    311     <para></para>
    312   </refsection>
    313 
    314   <refsection>
    315     <title>PortGroup python24</title>
    316 
    317     <para></para>
    318   </refsection>
    319 
    320   <refsection>
    321     <title>PortGroup python25</title>
    322 
    323     <para></para>
     425    <title>PortGroup python &amp; python2x</title>
     426
     427    <para>PortGroup python allows for efficient porting of python-based open
     428    source software.</para>
     429
     430    <refsection>
     431      <title>python PortGroup Specific Variables</title>
     432
     433      <para>When the python PortGroup is declared within a Portfile, the
     434      following variables are provided during port install.</para>
     435
     436      <variablelist>
     437        <varlistentry>
     438          <term>python.bin</term>
     439
     440          <listitem>
     441            <para>The MacPorts Python binary location.</para>
     442          </listitem>
     443        </varlistentry>
     444
     445        <varlistentry>
     446          <term>python.lib</term>
     447
     448          <listitem>
     449            <para>The Python dynamic library and path (ie,
     450            <filename>${prefix}/lib/libpython2.x.dylib</filename>).</para>
     451          </listitem>
     452        </varlistentry>
     453
     454        <varlistentry>
     455          <term>python.include</term>
     456
     457          <listitem>
     458            <para>Path to the Python include directory.</para>
     459          </listitem>
     460        </varlistentry>
     461
     462        <varlistentry>
     463          <term>python.pkgd</term>
     464
     465          <listitem>
     466            <para>Path to the Python site-packages directory. (ie,
     467            <filename>${prefix}/lib/python2.4/site-packages</filename>).</para>
     468          </listitem>
     469        </varlistentry>
     470      </variablelist>
     471    </refsection>
    324472  </refsection>
    325473
     
    327475    <title>PortGroup ruby</title>
    328476
    329     <para></para>
     477    <para>PortGroup ruby allows for efficient porting of ruby-based open
     478    source software.</para>
     479
     480    <refsection>
     481      <title>ruby PortGroup Specific Variables</title>
     482
     483      <para>When the ruby PortGroup is declared within a Portfile, the
     484      following variables are provided during port install.</para>
     485
     486      <variablelist>
     487        <varlistentry>
     488          <term>ruby.version</term>
     489
     490          <listitem>
     491            <para>The MacPorts Ruby version.</para>
     492          </listitem>
     493        </varlistentry>
     494
     495        <varlistentry>
     496          <term>ruby.bin</term>
     497
     498          <listitem>
     499            <para>The Ruby binary location.</para>
     500          </listitem>
     501        </varlistentry>
     502
     503        <varlistentry>
     504          <term>ruby.lib</term>
     505
     506          <listitem>
     507            <para>Path to the Ruby vendorlibdir directory (ie,
     508            <filename>${prefix}/lib/ruby/vendor_ruby/${ruby.version}</filename>)</para>
     509          </listitem>
     510        </varlistentry>
     511
     512        <varlistentry>
     513          <term>ruby.arch</term>
     514
     515          <listitem>
     516            <para>The name for the Ruby architecture-dependent directory name
     517            (ie, <literal>i686-darwin8.10.1</literal>).</para>
     518          </listitem>
     519        </varlistentry>
     520
     521        <varlistentry>
     522          <term>ruby.archlib</term>
     523
     524          <listitem>
     525            <para>Path to the Ruby vendor archdir (ie,
     526            <filename>${ruby.lib}/${ruby.arch}</filename>).</para>
     527          </listitem>
     528        </varlistentry>
     529      </variablelist>
     530    </refsection>
    330531  </refsection>
    331532
     
    344545
    345546    <refsection>
    346       <title>xcode PortGroup Sugar</title>
    347 
    348       <para>Portfiles using xcode PortGroup do not need to define the
    349       following variables:</para>
    350 
    351       <variablelist>
    352         <varlistentry>
    353           <term>categories</term>
    354 
    355           <listitem>
    356             <para>Default: aqua</para>
    357           </listitem>
    358         </varlistentry>
    359 
    360         <varlistentry>
    361           <term>platforms</term>
    362 
    363           <listitem>
    364             <para>Default: macosx</para>
    365           </listitem>
    366         </varlistentry>
    367 
    368         <varlistentry>
    369           <term>use_configure</term>
    370 
    371           <listitem>
    372             <para>Default: no</para>
    373           </listitem>
    374         </varlistentry>
    375       </variablelist>
    376     </refsection>
    377 
    378     <refsection>
    379       <title>xcode PortGroup Specific Variables</title>
    380 
    381       <para>When the xcode PortGroup is declared within a Portfile, the
    382       following variables are provided during port install:</para>
     547      <title>xcode PortGroup Specific Keywords</title>
     548
     549      <para>Portfiles using the xcode PortGroup allow for port authors to set
     550      the following keywords in addition to the general Portfile
     551      keywords.</para>
    383552
    384553      <variablelist>
     
    541710
    542711    <refsection>
    543       <title>Portfile-Phase Variables Affecting the xcode PortGroup</title>
    544 
    545       <para>The following Portfile phase variables affect the xcode PortGroup
    546       in aunique way. In most cases, you will not need to set any of these
    547       variables in the Portfile. See <citerefentry>
     712      <title>xcode PortGroup Sugar</title>
     713
     714      <para>Portfiles using the xcode PortGroup do not need to define the
     715      following variables:</para>
     716
     717      <variablelist>
     718        <varlistentry>
     719          <term>categories</term>
     720
     721          <listitem>
     722            <para>Default: aqua</para>
     723          </listitem>
     724        </varlistentry>
     725
     726        <varlistentry>
     727          <term>platforms</term>
     728
     729          <listitem>
     730            <para>Default: macosx</para>
     731          </listitem>
     732        </varlistentry>
     733
     734        <varlistentry>
     735          <term>use_configure</term>
     736
     737          <listitem>
     738            <para>Default: no</para>
     739          </listitem>
     740        </varlistentry>
     741      </variablelist>
     742    </refsection>
     743
     744    <refsection>
     745      <title>Portfile-Phase Keywords Affecting the xcode PortGroup</title>
     746
     747      <para>The following Portfile phase keywords affect the xcode PortGroup
     748      in a unique way. In most cases, you will not need to set any of these
     749      keywords in the Portfile. See <citerefentry>
    548750          <refentrytitle>portfile-phase</refentrytitle>
    549751
     
    606808
    607809        <manvolnum>1</manvolnum>
    608       </citerefentry>,<citerefentry>
     810      </citerefentry>, <citerefentry>
    609811        <refentrytitle>macports.conf</refentrytitle>
    610812
    611813        <manvolnum>5</manvolnum>
    612       </citerefentry>,<citerefentry>
     814      </citerefentry>, <citerefentry>
    613815        <refentrytitle>portfile</refentrytitle>
    614816
    615817        <manvolnum>7</manvolnum>
    616       </citerefentry>,<citerefentry>
     818      </citerefentry>, <citerefentry>
    617819        <refentrytitle>porthier</refentrytitle>
    618820
Note: See TracChangeset for help on using the changeset viewer.