source: trunk/doc/guide/xml/details.xml @ 2742

Last change on this file since 2742 was 2742, checked in by michaelm, 17 years ago

Merged quickstart and howto
improved compliance with style guide

  • Property svn:eol-style set to native
File size: 24.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8" ?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5<chapter id='details'>
6    <title>Portfile details</title>
7    <para> This Chapter describes in detail how each part of a portfile is
8    works and is used. </para>
9   
10    <sect1>
11        <title>General syntax</title>
12       
13        <para>A Portfile is a TCL script, so the syntax used must be valid
14        TCL or the Portfile will not work. The basic syntax of the Portfile
15        has been designed so most tasks are performed using key value(s)
16        combinations. Many people don't realise it is TCL until they want to do
17        something more advanced and realise all that power is there.</para>
18       
19                <para>All key value pairs in a Portfile are single lines so line breaks
20                must be escaped with a back solidus '\'. </para>
21                <para>Variables syntax is ${foo} for the foo variant.</para>
22        <sect2>
23                        <title>Special characters</title>
24                        <para>As the Portfile is a TCL script certain charachters are
25                        "special". These have a special meaning in TCL and if you dont
26                        want that special meaning, they must be escaped. In general a
27                        charachter is escaped using the back solidus '\'. The main
28                        characters you need to be careful with are
29                        <simplelist type="inline">
30                                        <member>$</member>
31                                        <member>}</member>
32                                        <member>}</member>
33                                        <member>[</member>
34                                        <member>]</member>
35                                        </simplelist></para>
36                                       
37                </sect2>
38               
39                <sect2>
40                        <title>Required keys</title>
41                       
42                        <para>There is a small set of required key/value pairs without
43                        which a Portfile cannot be correct.</para>
44                       
45                        <para>The required keys are
46                                <simplelist type="vert">
47                                        <member>PortSystem</member>
48                                        <member>name</member>
49                                        <member>version</member>
50                                        <member>platforms</member>
51                                        <member>maintainers</member>
52                                        <member>categories</member>
53                                        <member>description</member>
54                                        <member>master_sites</member>
55                                        <member>checksums</member>
56                                        <member>homepage</member>
57                                        <member>long_description</member>
58                                       
59                                </simplelist>
60                        Each of these keys is described in the following pages of
61                        the guide. </para>
62
63                               
64                </sect2>
65        </sect1>
66        <sect1>
67                <title>Useful preset variables</title>
68                <para></para>
69                <variablelist>
70                        <varlistentry id='prefix'>
71                                <term>prefix</term>
72                                <listitem>
73                                        <para>Installation prefix, set in the systemwide
74                                        configuration file /etc/ports/ports.conf. Can be
75                                        overridden on a per port basis. For example XFree86
76                                        needs to install in the /usr tree, or aqua applications
77                                        are installed in /Applications/Ports</para>
78                                       
79                                </listitem>
80                        </varlistentry>
81                       
82                        <varlistentry id='libpath'>
83                                <term>libpath</term>
84                                <listitem>
85                                        <para>Path to the DarwinPorts TCL libraries. Read
86                                        only.</para>
87                                       
88                                </listitem>
89                        </varlistentry>
90                       
91                        <varlistentry id='portpath'>
92                                <term>portpath</term>
93                                <listitem>
94                                        <para>Path to the directory containing the downloaded
95                                        Portfiles. Read Only.</para>
96                                       
97                                </listitem>
98                        </varlistentry>
99                       
100                        <varlistentry id='filedir'>
101                                <term>filedir</term>
102                                <listitem>
103                                        <para>Path to port files relative to ${portpath}.
104                                        Read Only.</para>
105                                       
106                                </listitem>
107                        </varlistentry>
108                       
109                        <varlistentry id='workdir'>
110                                <term>workdir</term>
111                                <listitem>
112                                        <para>Path to work directory relative to ${portpath}.
113                                        Read Only</para>
114                                       
115                                </listitem>
116                        </varlistentry>
117                       
118                        <varlistentry id='workpath'>
119                                <term>workpath</term>
120                                <listitem>
121                                        <para>Full path to work directory. Read only.</para>
122                                       
123                                </listitem>
124                        </varlistentry>
125                                               
126                        <varlistentry id='distpath'>
127                                <term>distpath</term>
128                                <listitem>
129                                        <para>Location to store downloaded distfiles. Read
130                                        Only</para>
131                                       
132                                </listitem>
133                        </varlistentry>
134                       
135                        <varlistentry id='os_arch'>
136                                <term>os_arch</term>
137                                <listitem>
138                                        <para>Identifies hardware type (ie, "Power Macintosh").
139                                        Read Only</para>
140                                       
141                                </listitem>
142                        </varlistentry>
143                       
144                        <varlistentry id='os_version'>
145                                <term>os_version</term>
146                                <listitem>
147                                        <para>Version number of operating system (ie "6.0").
148                                        Read Only.</para>
149                                       
150                                </listitem>
151                        </varlistentry>
152                       
153                </variablelist>
154        </sect1>
155
156        <sect1>
157                <title>Initialization phase</title>
158                <para>The first part of a Portfile deals with initialisation. Most
159                of the keys (or options) in the initialisation phase  are required
160                for all Portfiles. </para>
161
162                <variablelist>
163                        <varlistentry id='PortSystem'>
164                                <term>PortSystem</term>
165                                <listitem>
166                                        <para>Determines which version of the portsystem the
167                                        Portfile is compatible with. DarwinPorts supports
168                                        versioning of the PortSystem so if new, backwards
169                                        incompatible changes are introduced older Portfiles
170                                        can continue to use the older version of the system.
171                                        The PortSystem line wraps the loading of TCL libraries
172                                        appropriate for that version of DarwinPorts. If you
173                                        don't load the libraries, nothing else in the Portfile
174                                        will work. Thus, the PortSystem should be the top line
175                                        in the Portfile.</para>
176                                       
177                                        <para>Currently DarwinPorts only has version 1.0 so you
178                                        should put: <userinput>PortSystem 1.0</userinput> in your
179                                        Portfile.</para>
180
181                                </listitem>
182                        </varlistentry>
183                        <varlistentry id='name'>
184                                <term>name</term>
185                                <listitem>
186                                        <para>The name of the Port. By default this is used to
187                                        build the url from which the Port is fetched. The name
188                                        should be lowercase.</para>
189                                       
190                                        <para><userinput>name foo</userinput></para>
191                                       
192                                </listitem>
193                        </varlistentry>
194                        <varlistentry id='version'>
195                                <term>version</term>
196                                <listitem>
197                                        <para>The version of the Port. By default this is used to
198                                        build the url from which the Port is fetched. </para>
199                                       
200                                        <para><userinput>version 1.23.45</userinput></para>
201                                       
202                                </listitem>
203                        </varlistentry>
204                        <varlistentry id='platforms'>
205                                <term>platforms</term>
206                                <listitem>
207                                        <para>The platforms on which the port has been
208                                        tested. </para>
209                                        <para><userinput>platforms darwin freebsd</userinput></para>
210                                </listitem>
211                        </varlistentry>
212                        <varlistentry id='categories'>
213                                <term>categories</term>
214                                <listitem>
215                                        <para>The type of Port. The first category should be the
216                                        same as the directory in which the Portfile is stored
217                                        and therefore should be chosen with care. A Port may have
218                                        more that one category but is not required to.</para>
219                                       
220                                        <para><userinput>categories foo bar</userinput></para>
221                                       
222                                </listitem>
223                        </varlistentry>
224                        <varlistentry id='description'>
225                                <term>description</term>
226                                <listitem>
227                                        <para>One sentence describing what the port is, use
228                                        long_description for more detail. If you use
229                                        long_description you must still use description. </para>
230                                       
231                                        <para><userinput>description foo performs the
232                                        transformation of bar into xml</userinput> </para>
233                                       
234                                </listitem>
235                               
236                        </varlistentry>
237                        <varlistentry id='long_description'>
238                                <term>long_description</term>
239                                <listitem>
240                                        <para>Description of what the port is/does. Long lines
241                                        can be broken with escaped newlines. </para>
242                                        <para><programlisting><userinput>long_description foo
243                                        performs the transformation of bar into xml \
244This allows users to rapidly transform documentation into multiple \
245formats. </userinput></programlisting></para>
246                                </listitem>
247                        </varlistentry>
248                       
249                        <varlistentry id='maintainers'>
250                                <term>maintainers</term>
251                                <listitem>
252                                        <para>List the email address or addresses of the
253                                        Portfile maintainer(s)</para>
254                                        <para><userinput>maintainers
255                                        joeblogs@somerandom.domain.com</userinput></para>
256                                </listitem>
257                        </varlistentry>
258                        <varlistentry id='revision'>
259                                <term>revision</term>
260                                <listitem>
261                               
262                                        <para>Local revision number of portfile.  Increment
263                                        for port revisions. The default for this is 0. It
264                                        should be incremented for revisions that change the
265                                        installed port.</para>
266                                        <para><userinput>revision 1.1</userinput></para>
267                                       
268                                </listitem>
269                        </varlistentry>
270                        <varlistentry id='extract.sufx'>
271                                <term>extract.sufx</term>
272                                <listitem>
273                                        <para>By default the value of ${extract.sufx} is .tar.gz.
274                                        Specifying extract.sufx is optional, only use it if the
275                                        suffix is not 'tar.gz.'. </para>
276                                       
277                                        <para><userinput>extract.sufx .tgz</userinput></para>
278                                       
279                                </listitem>
280                        </varlistentry>
281                        <varlistentry id='distname'>
282                                <term>distname</term>
283                                <listitem>
284                                        <para>By default distname is ${name}-${version}.
285                                        Specifying distname is optional, only use it if the
286                                        file that contains the port is not ${name}-${version}
287                                        (without the extract.sufx).</para>
288                                       
289                                        <para><userinput>distname ${name}_${version}</userinput></para>
290                                       
291                                </listitem>
292                        </varlistentry>
293                       
294                        <varlistentry id='distfiles'>
295                                <term>distfiles</term>
296                                <listitem>
297                                        <para>Defaults to ${distname}.${extract.sufx}. Specifying
298                                        distfiles is optional, only use it if the file that
299                                        contains the port is not ${distname}.${extract.sufx}
300                                        or more than one file needs to be retirieved. </para>
301                                       
302                                        <para><userinput>distfiles stable.${extract.sufx}
303                                        installer.sh</userinput></para>
304                                       
305                                        <para>Some ports require multiple items to be fetched
306                                        from different sites, this can be achieved using tags.
307                                        The tags are then used to identify which of the
308                                        master_sites to fetch the file from.see master_sites
309                                        below for more information. As with long_description,
310                                        long lines should be broken up with escaped
311                                        newlines. </para>
312                                        <para><userinput>distfiles
313                                        stable.${extract.sufx}:source
314                                        installer.sh:install</userinput></para>
315                                </listitem>
316                        </varlistentry>
317                       
318                        <varlistentry id='use_zip'>
319                                <term>use_zip</term>
320                                <listitem>
321                                        <para>Specifying use_zip is optional, only use it if
322                                        the file downloades is zipped rather than tarred and
323                                        gziped. use_zip set ${extract.sufx} to .zip and
324                                        extract.cmd to unzip, extract.pre_args to -q and
325                                        extract.post_args to "-d $portpath/$workdir".</para>
326                                       
327                                        <para><userinput>use_zip yes</userinput></para>
328                                       
329                                </listitem>
330                        </varlistentry>
331                        <varlistentry id='use_bzip2'>
332                                <term>use_bzip2</term>
333                                <listitem>
334                                        <para>Specifying use_bzip2 is optional, only use it
335                                        if the file downloades is bzipped rather than tarred
336                                        and gziped. use_bzip2 set ${extract.sufx} to .bzip2
337                                        and extract.cmd to bzip2.</para>
338                                       
339                                        <para><userinput>use_bzip2 yes</userinput></para>
340                                       
341                                </listitem>
342                        </varlistentry>
343                       
344                </variablelist>
345        </sect1>
346        <sect1>
347                <title>Fetch phase</title>
348                <para></para>
349                <variablelist> 
350                        <varlistentry id="master_sites">
351                                <term>master_sites</term>
352                                <listitem>
353                                        <para> A whitespace delimited list of urls from which the
354                                        source of the port can be retrieved. The URL should not
355                                        include the name of the file being retrieved.</para>
356                                       
357                                        <para><userinput></userinput></para>
358                                       
359                                        <para>If you have multiple sites you should break up
360                                        long lines with escapend newlines. </para>
361                                        <para><programlisting><userinput>master_sites
362                                        http://www.somesite.org/files/ \
363                    http://www.somemirror.org/somesite_org/files/</userinput>
364                    </programlisting></para>
365
366                                        <tip><para>Always put the trailing forward solidus at the
367                                        end of a url, and remember to not include the filename
368                                        itself.</para></tip>
369                                       
370                                        <para>If you need to retrieve files from different
371                                        sites you can label the urls with tags.</para>
372                                        <para><programlisting><userinput>
373                                        master_sites http://www.somesite.org/files/:source \
374                                        http://www.someothersite.org/somesite_extras/:extras/
375                                        </userinput></programlisting></para>
376
377                                </listitem>
378                        </varlistentry>
379                       
380                                <varlistentry id='patchsites'>
381                                        <term>patch_sites</term>
382                                        <listitem>
383                                                <para>List sites from which to download patchfiles
384                                                from, syntax is the same as master_sites. See the
385                                                Patch phase below for more information. </para>
386                                                <para><userinput>
387                                                patch_sites    ftp://ftp.patchcityrepo.com/pub/magic/patches
388                                                </userinput></para>
389
390                                        </listitem>
391                                </varlistentry>
392                               
393                </variablelist>
394        </sect1>
395        <sect1>
396                <title>Integrity checking phase</title>
397                <para>Each file downloaded is integrity checked using a checksum.
398                This is used to help prevent trojaned sources being downloaded.
399                If you do not include the checksums line, the file will be
400                downloaded and the checksum reported as a conenience to the Portfile
401                author.</para>
402               
403                <variablelist>
404                        <varlistentry id='checksums'>
405                                        <term>checksums</term>
406                                        <listitem>
407                                                <para>Currently only the md5 checksum is supported.
408                                                Specify the filename, the checksum type and the
409                                                checksum.</para>
410                                               
411                                                <para><programlisting><userinput>
412                                                ${distname}-${extract.sufx} md5 65b89365a65dcad71d4402b48 \
413                                                foo.tar.gz md5 65b89365a65dcad71d4402b44</userinput>
414                                                        </programlisting></para>
415
416                                                <tip><para>If you only have one file being fetched the
417                                                filename can be omitted. </para>
418                                               
419                                                <para><userinput>md5 65b89365a65dcad71d4402b48</userinput>
420                                                </para></tip>
421                                        </listitem>
422                                </varlistentry>
423                        </variablelist>
424        </sect1>
425        <sect1>
426                <title>Extract phase</title>
427                <para></para>
428                <variablelist>
429                        <varlistentry id='extract.only'>
430                                        <term>extract.only</term>
431                                        <listitem>
432                                                <para>List of files to extract into ${workpath},
433                                                defaults to ${distfiles}. Useful when some files
434                                                are not compressed. Only use extract.only if the
435                                                default does not do the right thing.</para>
436                                               
437                                                <para>
438                                                <userinput>extract.only foo.tar.gz bar.tar.gz</userinput>
439                                                </para>
440
441                                        </listitem>
442                                </varlistentry>
443                               
444                                <varlistentry id='extract.cmd'>
445                                        <term>extract.cmd</term>
446                                        <listitem>
447                                                <para>Command to perform extraction. Defaults to gzip. </para>
448                                                <para><userinput>extract.cmd gunzip</userinput></para>
449
450                                        </listitem>
451                                </varlistentry>
452                               
453                                <varlistentry id='extract.pre_args'>
454                                        <term>extract.pre_args</term>
455                                        <listitem>
456                                                <para>Arguments added to extract command before a
457                                                file name. Defaults to -dc. </para>
458                                                <para><userinput>extract.pre_args    -cd</userinput>
459                                                </para>
460
461                                        </listitem>
462                                </varlistentry>
463                               
464                                <varlistentry id='extract.args'>
465                                        <term>extract.args</term>
466                                        <listitem>
467                                                <para>Arguments to extract.cmd, Read Only. The value
468                                                is ${distpath}/${distfile}</para>
469
470                                        </listitem>
471                                </varlistentry>
472                               
473                                <varlistentry id='extract.post_args'>
474                                        <term>extract.post_args></term>
475                                        <listitem>
476                                                <para>Arguments added to extract command after a file
477                                                name. Defaults to "| tar -xf". </para>
478                                                <para><userinput>extract.post_args   | tar -xf
479                                                </userinput></para>
480
481                                        </listitem>
482                                </varlistentry>
483                               
484                        </variablelist>
485        </sect1>
486        <sect1>
487                <title>Patch phase</title>
488                <para></para>
489                        <variablelist>
490                                <varlistentry id='patchfiles'>
491                                        <term>patchfiles</term>
492                                        <listitem>
493                                                <para>List of patch files to apply to source. Patch
494                                                files can be supplied in a port in a directory named
495                                                files (based on the value of ${filepath}) within the
496                                                port directory or fetched from ${patchsites}. Each
497                                                patchfile supplied by the Portfile author should
498                                                patch a single file. The standard convention is to
499                                                name the patch file 'patch-&lt;filename&gt;.diff,
500                                                with one diff file per file altered in the source.
501                                                If the filename is ambiguous because there are
502                                                multiple files with that name in the distribution,
503                                                supply the path components to uniquely identify the
504                                                file being patched. Diffs should be created with
505                                                <userinput>diff -u file1
506                                                file2 >../../files/patch-file.diff</userinput>.
507                                                Patches downloaded from patchsites must have
508                                                checksumes.</para>
509                                                <para><userinput>patchfiles patch-Makefile.in
510                                                patch-source.c</userinput></para>
511
512                                        </listitem>
513                                </varlistentry>
514                               
515                        </variablelist>
516        </sect1>
517        <sect1 id='configure'>
518                <title>Configuration phase</title>
519                <para></para>
520                       
521                        <sect2>
522                                <title> Automake and autoconf</title>                                           
523                                        <variablelist>
524                                                <varlistentry id='use_automake'>
525                                                        <term>use_automake</term>
526                                                        <listitem>
527                                                                <para>If set to yes, use automake</para>
528                                                                <para><userinput>use_automake yes
529                                                                </userinput></para>
530
531                                                        </listitem>
532                                                </varlistentry>
533                                               
534                                                <varlistentry id='automake.env'>
535                                                        <term>automake.env</term>
536                                                        <listitem>
537                                                                <para>Environmental variables to pass
538                                                                to automake</para>
539                                                                <para><userinput>CFLAGS="-I'${prefix}/include'"
540                                                                </userinput></para>
541
542                                                        </listitem>
543                                                </varlistentry>
544                                               
545                                                <varlistentry id='automake.args'>
546                                                        <term>automake.args</term>
547                                                        <listitem>
548                                                                <para>Arguments to pass to automake. </para>
549                                                                <para><userinput>automake.args  --foreign
550                                                                </userinput></para>
551
552                                                        </listitem>
553                                                </varlistentry>
554                                               
555                                                <varlistentry id='automake.dir'>
556                                                        <term>automake.dir</term>
557                                                        <listitem>
558                                                                <para>Directory in which to run ${automake.cmd}.
559                                                                Defaults to ${worksrcpath}</para>
560                                                                <para><userinput>automake.dir</userinput></para>
561
562                                                        </listitem>
563                                                </varlistentry>
564                                               
565                                                <varlistentry id='use_autoconf'>
566                                                        <term>use_autoconf</term>
567                                                        <listitem>
568                                                                <para>If set to yes, run autoconf. </para>
569                                                                <para><userinput>use_autoconf   yes
570                                                                </userinput></para>
571
572                                                        </listitem>
573                                                </varlistentry>
574                                               
575                                                <varlistentry id='autoconf.env'>
576                                                        <term>autoconf.env</term>
577                                                        <listitem>
578                                                                <para>Environmental variables to pass to
579                                                                autoconf</para>
580                                                                <para><userinput>autoconf.env   
581                                                                CFLAGS=-I'${prefix}/include/gtk12'</userinput>
582                                                                </para>
583
584                                                        </listitem>
585                                                </varlistentry>
586                                               
587                                                <varlistentry id='autoconf.args'>
588                                                        <term>autoconf.args</term>
589                                                        <listitem>
590                                                                <para>Arguments to pass to autoconf. </para>
591                                                                <para><userinput>autoconf.args  -l
592                                                                src/aclocaldir</userinput></para>
593
594                                                        </listitem>
595                                                </varlistentry>
596                                               
597                                                <varlistentry id='autoconf.dir'>
598                                                        <term>autoconf.dir</term>
599                                                        <listitem>
600                                                                <para>Directory in which to run
601                                                                ${autoconf.cmd}. </para>
602                                                                <para><userinput>autoconf.dir   
603                                                                src</userinput></para>
604
605                                                        </listitem>
606                                                </varlistentry>
607                                               
608                                        </variablelist>
609                                </sect2>
610                                <sect2>
611                                        <title>configure</title>
612                                        <variablelist>
613                                                <varlistentry id='configure.env'>
614                                                        <term>configure.env</term>
615                                                        <listitem>
616                                                                <para>Set environment variables for
617                                                                configure.</para>
618                                                                <para><userinput>configure.env
619                                                                CFLAGS="-I'${prefix}/include'"</userinput>
620                                                                </para>
621
622                                                        </listitem>
623                                                </varlistentry>
624                                               
625                                                <varlistentry id='configure.pre_args'>
626                                                        <term>configure.pre_args</term>
627                                                        <listitem>
628                                                                <para>Arguments added to configure command
629                                                                before ${configure.args}. Defaults to
630                                                                --prefix=${prefix}. </para>
631                                                                <para><userinput>configure.pre_args       
632                                                                --prefix="${prefix}/apache2"</userinput></para>
633
634                                                        </listitem>
635                                                </varlistentry>
636                                               
637                                                <varlistentry id='configure.args'>
638                                                        <term>configure.args</term>
639                                                        <listitem>
640                                                                <para>Arguments to pass to configure.</para>
641                                                                <para><userinput>configure.args     
642                                                                --etcdir="${prefix}/etc"</userinput></para>
643
644                                                        </listitem>
645                                                </varlistentry>
646                                        </variablelist>
647                                </sect2>
648                               
649        </sect1>
650        <sect1>
651                <title>Build phase</title>
652                <para></para>
653               
654                <variablelist>
655                       
656                        <varlistentry id='build.cmd'>
657                                <term>build.cmd</term>
658                                <listitem>
659                                        <para>Make command to run relative to ${worksrcdir}.
660                                        Defaults to make.</para>
661                                        <para><userinput>build.cmd pbxbuild</userinput></para>
662
663                                </listitem>
664                        </varlistentry>
665                       
666                        <varlistentry id='build.type'>
667                                <term>build.type</term>
668                                <listitem>
669                                        <para>Defines which 'make' is required, either 'gnu'
670                                        or 'bsd' Sets build.cmd to either
671                                                'gnumake' or 'bsdmake' accordingly</para>
672                                               
673                                        <para><userinput>build.type     gnu</userinput></para>
674
675                                </listitem>
676                        </varlistentry>
677                       
678                        <varlistentry id='build.pre_args'>
679                                <term>build.pre_args</term>
680                                <listitem>
681                                        <para>Arguments to pass to ${build.cmd} before
682                                        ${build.args}. Read only. Set to
683                                        ${build.target.current}</para>
684
685                                </listitem>
686                        </varlistentry>
687                       
688                        <varlistentry id='build.args'>
689                                <term>build.args</term>
690                                <listitem>
691                                        <para>Arguments to pass to ${build.cmd}</para>
692                                        <para><userinput>build.args     
693                                        -DNOWARN</userinput></para>
694
695                                </listitem>
696                        </varlistentry>
697                       
698                        <varlistentry id='build.target'>
699                                <term>build.target</term>
700                                <listitem>
701                                        <para>Target to pass to make for building everything.
702                                        Defaults to all.</para>
703                                        <para><userinput>build.target.all all-src</userinput>
704                                        </para>
705
706                                </listitem>
707                        </varlistentry>
708
709                </variablelist>
710        </sect1>
711        <sect1>
712                <title>Install phase</title>
713               
714                <variablelist>
715
716                        <varlistentry id='install.cmd'>
717                                <term>install.cmd</term>
718                                <listitem>
719                                        <para>Install command to run relative to ${worksrcdir}.
720                                        Defaults to ${build.cmd}.</para>
721                                        <para><userinput>install.cmd pbxbuild</userinput></para>
722
723                                </listitem>
724                        </varlistentry>
725                       
726                        <varlistentry id='install.type'>
727                                <term>install.type</term>
728                                <listitem>
729                                        <para>Defines which 'make' is required, either 'gnu' or
730                                        'bsd' Sets install.cmd to either
731                                                'gnumake' or 'bsdmake' accordingly</para>
732                                               
733                                        <para><userinput>install.type     gnu</userinput></para>
734
735                                </listitem>
736                        </varlistentry>
737                       
738                        <varlistentry id='install.pre_args'>
739                                <term>install.pre_args</term>
740                                <listitem>
741                                        <para>Arguments to pass to ${install.cmd} before
742                                        ${install.args}. Read only. Set to  ${install.target}</para>
743
744                                </listitem>
745                        </varlistentry>
746                       
747                        <varlistentry id='install.args'>
748                                <term>install.args</term>
749                                <listitem>
750                                        <para>Arguments to pass to ${install.cmd}</para>
751                                        <para><userinput>install.args     -DNOWARN</userinput></para>
752
753                                </listitem>
754                        </varlistentry>
755                       
756                        <varlistentry id='install.target'>
757                                <term>install.target</term>
758                                <listitem>
759                                        <para>Install target to pass to ${install.cmd}.</para>
760                                        <para><userinput>install.target all-src</userinput></para>
761
762                                </listitem>
763                        </varlistentry>
764                        <varlistentry id='install.destroot'>
765                                <term>install.destroot</term>
766                                <listitem>
767                                        <para>Arguments passed to ${install.cmd} in order to
768                                        install correctly into the destroot.</para>
769                                        <para>All ports must install via the 'destroot' so
770                                        that the DarwinPorts infrastructure can register each
771                                        file and directory a port installs. Most autoconf based
772                                        build systems will behave correctly and respect DESTDIR,
773                                        however some will not. Most of those that do not respect
774                                        DESTDIR will install correctly if you use 'prefix', as
775                                        in the example below. If your port doesn't respect either
776                                        of these, you'll have to figure out what to do yourself.
777                                        Some ports use another term, others require you to patch
778                                        the Makefile (or other build related script). </para>
779
780                                        <para><userinput>install.destroot prefix=${destroot}${prefix}
781                                        </userinput></para>
782
783                                       
784                                </listitem>
785                        </varlistentry>
786                </variablelist>
787        </sect1>
788       
789
790        <sect1>
791        <title>Dependencies</title>
792        <para></para>                   
793        <sect2>
794                        <title>Principles</title>
795                        <para></para>
796                </sect2>
797                <sect2>
798                        <title>Dependency tests</title>
799                        <para></para>
800                        <variablelist>
801                                <varlistentry>
802                                                <term> depends_fetch </term>
803                                                <listitem>
804                                                <para></para>
805                                                </listitem>
806                                </varlistentry>
807                                <varlistentry>
808                                                <term> depends_extract </term>
809                                                <listitem>
810                                                <para></para>
811                                                </listitem>
812                                </varlistentry>
813                                <varlistentry>
814                                                <term> depends_lib </term>
815                                                <listitem>
816                                                <para></para>
817                                                </listitem>
818                                </varlistentry>
819                                <varlistentry>
820                                                <term> depends_build </term>
821                                                <listitem>
822                                                <para></para>
823                                                </listitem>
824                                </varlistentry>
825                                <varlistentry>
826                                                <term> depends_run </term>
827                                                <listitem>
828                                                        <para></para>
829                                                </listitem>
830                                </varlistentry> 
831            </variablelist>
832        </sect2>
833    </sect1>
834        <sect1>
835                <title>TCL primitives</title>
836                        <para></para>
837                <sect2>
838                        <title>reinplace</title>
839                        <para></para>
840                </sect2>
841                <sect2>
842                        <title>system</title>
843                        <para></para>
844                </sect2>               
845                <sect2>
846                        <title>file</title>
847                        <para></para>
848                </sect2>
849        </sect1>
850        <sect1>
851                <title>Other</title>
852                <para></para>
853                <sect2>
854                        <title>Pre and post phase steps</title>
855                        <variablelist>
856                                <varlistentry>
857                                        <term>Pre-*</term>
858                                        <listitem>
859                                                <para></para>
860                                        </listitem>
861                                </varlistentry>
862                               
863                                <varlistentry>
864                                        <term>Post-*</term>
865                                        <listitem>
866                                                <para></para>
867
868                                        </listitem>
869                                </varlistentry>
870                        </variablelist>
871                </sect2>
872                <sect2>
873                        <title>Overriding a phase</title>
874                        <para></para>
875
876                </sect2>
877                       
878    </sect1>
879 </chapter>
880       
881
882               
883               
Note: See TracBrowser for help on using the repository browser.