Changeset 27927 for trunk/doc


Ignore:
Timestamp:
Aug 16, 2007, 9:12:21 AM (12 years ago)
Author:
markd@…
Message:

Additions to the keywords and Tcl extensions sections.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/portfileref.xml

    r27834 r27927  
    344344            </listitem>
    345345          </varlistentry>
    346         </variablelist><variablelist>
     346
    347347          <varlistentry>
    348348            <term>binpath</term>
     
    353353            </listitem>
    354354          </varlistentry>
    355         </variablelist><variablelist>
     355
    356356          <varlistentry>
    357357            <term>libpath</term>
     
    361361            </listitem>
    362362          </varlistentry>
    363         </variablelist><variablelist>
     363
    364364          <varlistentry>
    365365            <term>portpath</term>
     
    370370            </listitem>
    371371          </varlistentry>
    372         </variablelist><variablelist>
     372
    373373          <varlistentry>
    374374            <term>filesdir</term>
     
    379379            </listitem>
    380380          </varlistentry>
    381         </variablelist><variablelist>
     381
    382382          <varlistentry>
    383383            <term>workpath</term>
     
    387387            </listitem>
    388388          </varlistentry>
    389         </variablelist><variablelist>
     389
    390390          <varlistentry>
    391391            <term>worksrcpath</term>
     
    396396            </listitem>
    397397          </varlistentry>
    398         </variablelist><variablelist>
     398
    399399          <varlistentry>
    400400            <term>destroot</term>
     
    406406            </listitem>
    407407          </varlistentry>
    408         </variablelist><variablelist>
     408
    409409          <varlistentry>
    410410            <term>distpath</term>
     
    414414            </listitem>
    415415          </varlistentry>
    416         </variablelist><variablelist>
     416
    417417          <varlistentry>
    418418            <term>os.platform</term>
     
    423423            </listitem>
    424424          </varlistentry>
    425         </variablelist><variablelist>
     425
    426426          <varlistentry>
    427427            <term>os.arch</term>
     
    432432            </listitem>
    433433          </varlistentry>
    434         </variablelist><variablelist>
     434
    435435          <varlistentry>
    436436            <term>os.version</term>
     
    441441            </listitem>
    442442          </varlistentry>
    443         </variablelist><variablelist>
     443
    444444          <varlistentry>
    445445            <term>os.major</term>
     
    448448              <para>The major version number of the host operating system (ie
    449449              "8" for Darwin 8.0). Read only.</para>
     450            </listitem>
     451          </varlistentry>
     452
     453          <varlistentry>
     454            <term></term>
     455
     456            <listitem>
     457              <para></para>
     458            </listitem>
     459          </varlistentry>
     460
     461          <varlistentry>
     462            <term></term>
     463
     464            <listitem>
     465              <para></para>
     466            </listitem>
     467          </varlistentry>
     468
     469          <varlistentry>
     470            <term></term>
     471
     472            <listitem>
     473              <para></para>
    450474            </listitem>
    451475          </varlistentry>
     
    766790      <variablelist>
    767791        <varlistentry>
     792          <term>PortSystem</term>
     793
     794          <listitem>
     795            <para>The top line of every Portfile. The PortSystem line wraps
     796            the loading of TCL libraries appropriate for a given version of
     797            MacPorts.</para>
     798
     799            <para><userinput>PortSystem 1.0</userinput></para>
     800          </listitem>
     801        </varlistentry>
     802
     803        <varlistentry>
    768804          <term>name</term>
    769805
    770806          <listitem>
    771             <para>Port name.</para>
     807            <para>The name of the Port; it should be lowercase.</para>
     808
     809            <para><userinput>name foo</userinput></para>
     810          </listitem>
     811        </varlistentry>
     812
     813        <varlistentry>
     814          <term>version</term>
     815
     816          <listitem>
     817            <para>The version of the ported software.</para>
     818
     819            <para><userinput>version 1.23.45</userinput></para>
     820          </listitem>
     821        </varlistentry>
     822
     823        <varlistentry>
     824          <term>revision</term>
     825
     826          <listitem>
     827            <para>Optional keyword (default is 0) that is used to track port
     828            revisions. It should not be incremented for port revisions unless
     829            it would benefit users to upgrade an installed port, and cleared
     830            when the port is updated to a newer version.</para>
     831
     832            <para><userinput>revision 1</userinput></para>
     833          </listitem>
     834        </varlistentry>
     835
     836        <varlistentry>
     837          <term>categories</term>
     838
     839          <listitem>
     840            <para>The category under which the ported software falls. The
     841            first category should be the same as the directory within which
     842            the Portfile is stored; secondary and tertiary categories may be
     843            selected.</para>
     844
     845            <para><userinput>categories net security</userinput></para>
     846          </listitem>
     847        </varlistentry>
     848
     849        <varlistentry>
     850          <term>maintainers</term>
     851
     852          <listitem>
     853            <para>The email address(es) of the Portfile maintainer(s).</para>
     854
     855            <para><userinput>maintainers openmaintainer@macports.org
     856            jdoe@macports.org</userinput></para>
     857          </listitem>
     858        </varlistentry>
     859
     860        <varlistentry>
     861          <term>description</term>
     862
     863          <listitem>
     864            <para>A one-sentence description of the ported software.</para>
     865
     866            <para><userinput>description A classic shooter arcade
     867            game.</userinput></para>
     868          </listitem>
     869        </varlistentry>
     870
     871        <varlistentry>
     872          <term>long_description</term>
     873
     874          <listitem>
     875            <para>A long description of the ported software. Break long lines
     876            with escaped newlines.</para>
     877
     878            <programlisting>description     A classic shooter arcade game derived from \
     879                the game alien-munchers.  Not suitable for \
     880                children under two years old.      </programlisting>
     881          </listitem>
     882        </varlistentry>
     883
     884        <varlistentry>
     885          <term>homepage</term>
     886
     887          <listitem>
     888            <para>Port application's homepage.</para>
     889
     890            <para><userinput>homepage
     891            http://www.somesite.org/apps</userinput></para>
     892          </listitem>
     893        </varlistentry>
     894
     895        <varlistentry>
     896          <term>platforms</term>
     897
     898          <listitem>
     899            <para>The platforms on which the port has been tested.</para>
     900
     901            <para><userinput>platforms darwin freebsd</userinput></para>
     902          </listitem>
     903        </varlistentry>
     904
     905        <varlistentry>
     906          <term>depends_lib</term>
     907
     908          <listitem>
     909            <para></para>
     910
     911            <variablelist>
     912              <varlistentry>
     913                <term>depends_lib-append</term>
     914
     915                <listitem>
     916                  <para></para>
     917                </listitem>
     918              </varlistentry>
     919            </variablelist>
     920
     921            <variablelist>
     922              <varlistentry>
     923                <term>depends_lib-delete</term>
     924
     925                <listitem>
     926                  <para></para>
     927                </listitem>
     928              </varlistentry>
     929            </variablelist>
     930          </listitem>
     931        </varlistentry>
     932
     933        <varlistentry>
     934          <term>depends_build</term>
     935
     936          <listitem>
     937            <para></para>
     938
     939            <variablelist>
     940              <varlistentry>
     941                <term>depends_build-append</term>
     942
     943                <listitem>
     944                  <para></para>
     945                </listitem>
     946              </varlistentry>
     947            </variablelist>
     948
     949            <variablelist>
     950              <varlistentry>
     951                <term>depends_build-delete</term>
     952
     953                <listitem>
     954                  <para></para>
     955                </listitem>
     956              </varlistentry>
     957            </variablelist>
     958          </listitem>
     959        </varlistentry>
     960
     961        <varlistentry>
     962          <term>depends_run</term>
     963
     964          <listitem>
     965            <para></para>
     966
     967            <variablelist>
     968              <varlistentry>
     969                <term>depends_run-append</term>
     970
     971                <listitem>
     972                  <para></para>
     973                </listitem>
     974              </varlistentry>
     975            </variablelist>
     976
     977            <variablelist>
     978              <varlistentry>
     979                <term>depends_run-delete</term>
     980
     981                <listitem>
     982                  <para></para>
     983                </listitem>
     984              </varlistentry>
     985            </variablelist>
     986          </listitem>
     987        </varlistentry>
     988
     989        <varlistentry>
     990          <term></term>
     991
     992          <listitem>
     993            <para></para>
    772994          </listitem>
    773995        </varlistentry>
    774996      </variablelist>
     997    </section>
     998
     999    <section>
     1000      <title>Fetch</title>
     1001
     1002      <para></para>
    7751003
    7761004      <variablelist>
    7771005        <varlistentry>
    778           <term>version</term>
    779 
    780           <listitem>
    781             <para>Port version.</para>
     1006          <term>master_sites</term>
     1007
     1008          <listitem>
     1009            <para>A list of urls from which a port's download file(s) may be
     1010            retrieved.</para>
     1011
     1012            <para>For ports that require only one download file, the list is
     1013            searched in order until a file matching
     1014            ${distname}${extract.suffix} is found.</para>
     1015
     1016            <programlisting><userinput>master_sites   http://www.somesite.org/files/ \
     1017               http://www.somemirror.org/somesite_org/files/</userinput></programlisting>
     1018
     1019            <para>You may also use mirror sites predefined by MacPorts. Here
     1020            the sourceforge and gnu mirrors are used.</para>
     1021
     1022            <programlisting><userinput>master_sites   sourceforge gnu</userinput></programlisting>
     1023
     1024            <para>When using mirror master_sites, the subdirectory ${name} is
     1025            checked on every mirror. If the mirror subdirectory does not match
     1026            ${name}, then you may specify it using after the mirror separated
     1027            by a colon. </para>
     1028
     1029            <programlisting><userinput>master_sites   sourceforge:widget \
     1030               gnu:widget</userinput></programlisting>
     1031
     1032            <para>For ports that must fetch multiple download files from
     1033            different locations, you may label the files with tags and match
     1034            the tags in a distfiles statement. The format is
     1035            <literal>mirror:subdirectory:tag</literal>.</para>
     1036
     1037            <para>In the example below, file_one.tar.gz is fetched from
     1038            sourceforge mirrors in subdirectory ${name}; file tagtwo.tar.gz is
     1039            fetched from the gnu mirrors in subdirectory sources.</para>
     1040
     1041            <programlisting><userinput>distfiles       file_one.tar.gz:tagone \
     1042                file_two.tar.gz:tagtwo \
     1043                file_three.tar.gz
     1044
     1045master_sites    sourceforge::tagone \
     1046                gnu:sources:tagtwo</userinput></programlisting>
     1047          </listitem>
     1048        </varlistentry>
     1049
     1050        <varlistentry>
     1051          <term>patch_sites</term>
     1052
     1053          <listitem>
     1054            <para>A list of sites from which a port's patchfiles may be
     1055            downloaded, where applicable.</para>
     1056
     1057            <programlisting><userinput>patch_sites    ftp://ftp.patchcityrepo.com/pub/magic/patches</userinput></programlisting>
     1058          </listitem>
     1059        </varlistentry>
     1060
     1061        <varlistentry>
     1062          <term>distname</term>
     1063
     1064          <listitem>
     1065            <para>The default distname is ${name}-${version}. This keyword is
     1066            used to specify download files that do not meet this standard
     1067            (excluding the extract.suffix).</para>
     1068
     1069            <para><userinput>distname ${name}</userinput></para>
     1070          </listitem>
     1071        </varlistentry>
     1072
     1073        <varlistentry>
     1074          <term>distfiles</term>
     1075
     1076          <listitem>
     1077            <para>The default distfile name is ${distname}${extract.suffix}.
     1078            This keyword is used when a download file for a port is not
     1079            ${distname}.${extract.suffix} or to used to specify multiple
     1080            download files.</para>
     1081
     1082            <para><userinput>distfiles ${name}-dev_src.tgz</userinput></para>
     1083          </listitem>
     1084        </varlistentry>
     1085
     1086        <varlistentry>
     1087          <term>extract.suffix</term>
     1088
     1089          <listitem>
     1090            <para>The default value is .tar.gz, so is normally used to specify
     1091            file suffixes other than .tar.gz.</para>
     1092
     1093            <para><userinput>extract.suffix .tar.gz</userinput></para>
     1094          </listitem>
     1095        </varlistentry>
     1096
     1097        <varlistentry>
     1098          <term>use_bzip2</term>
     1099
     1100          <listitem>
     1101            <para>This keyword is for downloads that are tarred and bzipped.
     1102            It automatically sets these variables:</para>
     1103
     1104            <simplelist>
     1105              <member>extract_suffix = .tar.bz2</member>
     1106
     1107              <member>extract.cmd = bzip</member>
     1108            </simplelist>
     1109
     1110            <para><userinput>use_bzip2 yes</userinput></para>
     1111          </listitem>
     1112        </varlistentry>
     1113
     1114        <varlistentry>
     1115          <term>use_zip</term>
     1116
     1117          <listitem>
     1118            <para>This keyword is for downloads are zipped. It automatically
     1119            sets these variables:</para>
     1120
     1121            <simplelist>
     1122              <member>extract.suffix = .zip</member>
     1123
     1124              <member>extract.cmd = unzip</member>
     1125
     1126              <member>extract.pre_args = -q</member>
     1127
     1128              <member>extract.post_args = "-d $portpath/$workdir"</member>
     1129            </simplelist>
     1130
     1131            <para><userinput>use_zip yes</userinput></para>
     1132          </listitem>
     1133        </varlistentry>
     1134
     1135        <varlistentry>
     1136          <term></term>
     1137
     1138          <listitem>
     1139            <para></para>
     1140          </listitem>
     1141        </varlistentry>
     1142
     1143        <varlistentry>
     1144          <term></term>
     1145
     1146          <listitem>
     1147            <para></para>
     1148          </listitem>
     1149        </varlistentry>
     1150
     1151        <varlistentry>
     1152          <term></term>
     1153
     1154          <listitem>
     1155            <para></para>
    7821156          </listitem>
    7831157        </varlistentry>
    7841158      </variablelist>
     1159    </section>
     1160
     1161    <section>
     1162      <title>Checksum</title>
     1163
     1164      <para></para>
    7851165
    7861166      <variablelist>
    7871167        <varlistentry>
    788           <term>categories</term>
    789 
    790           <listitem>
    791             <para>Port category(s).</para>
     1168          <term>checksums</term>
     1169
     1170          <listitem>
     1171            <para>Checksum(s) of the distribution files.</para>
     1172
     1173            <para><userinput>checksums md5
     1174            65b89365a65dcad71d4402b48</userinput></para>
     1175
     1176            <para>To download multiple files for a port, you must associate
     1177            the files with their checksums by including the filename.</para>
     1178
     1179            <programlisting>checksums     ${distname}${extract.suffix} md5 65b89365a65dcad71d4402b44 \
     1180              hobbit.tar.gz md5 65b89365a65dcad71d4402b48</programlisting>
    7921181          </listitem>
    7931182        </varlistentry>
     
    7961185      <variablelist>
    7971186        <varlistentry>
    798           <term>maintainers</term>
    799 
    800           <listitem>
    801             <para>Port maintainer(s).</para>
     1187          <term></term>
     1188
     1189          <listitem>
     1190            <para></para>
    8021191          </listitem>
    8031192        </varlistentry>
    8041193      </variablelist>
    805 
    806       <variablelist>
    807         <varlistentry>
    808           <term>description</term>
    809 
    810           <listitem>
    811             <para>Short description.</para>
    812           </listitem>
    813         </varlistentry>
    814       </variablelist>
    815 
    816       <variablelist>
    817         <varlistentry>
    818           <term>long_description</term>
    819 
    820           <listitem>
    821             <para>Long description.</para>
    822           </listitem>
    823         </varlistentry>
    824       </variablelist>
    825 
    826       <variablelist>
    827         <varlistentry>
    828           <term>homepage</term>
    829 
    830           <listitem>
    831             <para>Port application's homepage.</para>
    832           </listitem>
    833         </varlistentry>
    834       </variablelist>
    835 
    836       <variablelist>
    837         <varlistentry>
    838           <term>platforms</term>
    839 
    840           <listitem>
    841             <para>Platform(s) supported.</para>
    842           </listitem>
    843         </varlistentry>
    844       </variablelist>
    845 
    846       <variablelist>
    847         <varlistentry>
    848           <term>master_sites</term>
    849 
    850           <listitem>
    851             <para>Download site(s) for the distribution files.</para>
    852           </listitem>
    853         </varlistentry>
    854       </variablelist>
    855 
    856       <variablelist>
    857         <varlistentry>
    858           <term>checksums</term>
    859 
    860           <listitem>
    861             <para>Checksum(s) of the distribution files.</para>
    862           </listitem>
    863         </varlistentry>
    864       </variablelist>
    865 
    866       <variablelist>
    867         <varlistentry>
    868           <term>depends_lib</term>
    869 
    870           <listitem>
    871             <para></para>
    872 
    873             <variablelist>
    874               <varlistentry>
    875                 <term>depends_lib-append</term>
    876 
    877                 <listitem>
    878                   <para></para>
    879                 </listitem>
    880               </varlistentry>
    881             </variablelist>
    882 
    883             <variablelist>
    884               <varlistentry>
    885                 <term>depends_lib-delete</term>
    886 
    887                 <listitem>
    888                   <para></para>
    889                 </listitem>
    890               </varlistentry>
    891             </variablelist>
    892           </listitem>
    893         </varlistentry>
    894       </variablelist>
    895 
    896       <variablelist>
    897         <varlistentry>
    898           <term>depends_build</term>
    899 
    900           <listitem>
    901             <para></para>
    902 
    903             <variablelist>
    904               <varlistentry>
    905                 <term>depends_build-append</term>
    906 
    907                 <listitem>
    908                   <para></para>
    909                 </listitem>
    910               </varlistentry>
    911             </variablelist>
    912 
    913             <variablelist>
    914               <varlistentry>
    915                 <term>depends_build-delete</term>
    916 
    917                 <listitem>
    918                   <para></para>
    919                 </listitem>
    920               </varlistentry>
    921             </variablelist>
    922           </listitem>
    923         </varlistentry>
    924       </variablelist>
    925 
    926       <variablelist>
    927         <varlistentry>
    928           <term>depends_run</term>
    929 
    930           <listitem>
    931             <para></para>
    932 
    933             <variablelist>
    934               <varlistentry>
    935                 <term>depends_run-append</term>
    936 
    937                 <listitem>
    938                   <para></para>
    939                 </listitem>
    940               </varlistentry>
    941             </variablelist>
    942 
    943             <variablelist>
    944               <varlistentry>
    945                 <term>depends_run-delete</term>
    946 
    947                 <listitem>
    948                   <para></para>
    949                 </listitem>
    950               </varlistentry>
    951             </variablelist>
    952           </listitem>
    953         </varlistentry>
    954       </variablelist>
    955     </section>
    956 
    957     <section>
    958       <title>Port Phase Keywords</title>
    959 
    960       <para>MacPorts has ten distinct port installation phases. As previosly
    961       stated, port phase keywords are not located within port phase
    962       declarations; they <emphasis>refer</emphasis> to port phases and set
    963       options for them.</para>
    964 
    965       <para>The fetch phase ...</para>
    966 
    967       <variablelist>
    968         <varlistentry>
    969           <term></term>
    970 
    971           <listitem>
    972             <para></para>
    973           </listitem>
    974         </varlistentry>
    975       </variablelist>
    976 
    977       <variablelist>
    978         <varlistentry>
    979           <term></term>
    980 
    981           <listitem>
    982             <para></para>
    983           </listitem>
    984         </varlistentry>
    985       </variablelist>
    986 
    987       <variablelist>
    988         <varlistentry>
    989           <term></term>
    990 
    991           <listitem>
    992             <para></para>
    993           </listitem>
    994         </varlistentry>
    995       </variablelist>
    996 
    997       <variablelist>
    998         <varlistentry>
    999           <term></term>
    1000 
    1001           <listitem>
    1002             <para></para>
    1003           </listitem>
    1004         </varlistentry>
    1005       </variablelist>
    1006 
    1007       <variablelist>
    1008         <varlistentry>
    1009           <term></term>
    1010 
    1011           <listitem>
    1012             <para></para>
    1013           </listitem>
    1014         </varlistentry>
    1015       </variablelist>
    1016 
    1017       <variablelist>
    1018         <varlistentry>
    1019           <term></term>
    1020 
    1021           <listitem>
    1022             <para></para>
    1023           </listitem>
    1024         </varlistentry>
    1025       </variablelist>
    1026 
    1027       <variablelist>
    1028         <varlistentry>
    1029           <term></term>
    1030 
    1031           <listitem>
    1032             <para></para>
    1033           </listitem>
    1034         </varlistentry>
    1035       </variablelist>
    1036 
    1037       <para>The checksum phase ...</para>
    1038 
    1039       <variablelist>
    1040         <varlistentry>
    1041           <term></term>
    1042 
    1043           <listitem>
    1044             <para></para>
    1045           </listitem>
    1046         </varlistentry>
    1047       </variablelist>
    1048 
    1049       <variablelist>
    1050         <varlistentry>
    1051           <term></term>
    1052 
    1053           <listitem>
    1054             <para></para>
    1055           </listitem>
    1056         </varlistentry>
    1057       </variablelist>
    1058 
    1059       <variablelist>
    1060         <varlistentry>
    1061           <term></term>
    1062 
    1063           <listitem>
    1064             <para></para>
    1065           </listitem>
    1066         </varlistentry>
    1067       </variablelist>
    1068 
    1069       <variablelist>
    1070         <varlistentry>
    1071           <term></term>
    1072 
    1073           <listitem>
    1074             <para></para>
    1075           </listitem>
    1076         </varlistentry>
    1077       </variablelist>
    1078 
    1079       <variablelist>
    1080         <varlistentry>
    1081           <term></term>
    1082 
    1083           <listitem>
    1084             <para></para>
    1085           </listitem>
    1086         </varlistentry>
    1087       </variablelist>
    1088 
    1089       <para>The extract phase ...</para>
    1090 
    1091       <variablelist>
    1092         <varlistentry>
    1093           <term></term>
    1094 
    1095           <listitem>
    1096             <para></para>
    1097           </listitem>
    1098         </varlistentry>
    1099       </variablelist>
    1100 
    1101       <variablelist>
    1102         <varlistentry>
    1103           <term></term>
    1104 
    1105           <listitem>
    1106             <para></para>
    1107           </listitem>
    1108         </varlistentry>
    1109       </variablelist>
    1110 
    1111       <variablelist>
    1112         <varlistentry>
    1113           <term></term>
    1114 
    1115           <listitem>
    1116             <para></para>
    1117           </listitem>
    1118         </varlistentry>
    1119       </variablelist>
    1120 
    1121       <variablelist>
    1122         <varlistentry>
    1123           <term></term>
    1124 
    1125           <listitem>
    1126             <para></para>
    1127           </listitem>
    1128         </varlistentry>
    1129       </variablelist>
    1130 
    1131       <variablelist>
    1132         <varlistentry>
    1133           <term></term>
    1134 
    1135           <listitem>
    1136             <para></para>
    1137           </listitem>
    1138         </varlistentry>
    1139       </variablelist>
    1140 
    1141       <variablelist>
    1142         <varlistentry>
    1143           <term></term>
    1144 
    1145           <listitem>
    1146             <para></para>
    1147           </listitem>
    1148         </varlistentry>
    1149       </variablelist>
    1150 
    1151       <para>The patch phase ...</para>
    1152 
    1153       <variablelist>
    1154         <varlistentry>
    1155           <term></term>
    1156 
    1157           <listitem>
    1158             <para></para>
    1159           </listitem>
    1160         </varlistentry>
    1161       </variablelist>
    1162 
    1163       <variablelist>
    1164         <varlistentry>
    1165           <term></term>
    1166 
    1167           <listitem>
    1168             <para></para>
    1169           </listitem>
    1170         </varlistentry>
    1171       </variablelist>
    1172 
    1173       <variablelist>
    1174         <varlistentry>
    1175           <term></term>
    1176 
    1177           <listitem>
    1178             <para></para>
    1179           </listitem>
    1180         </varlistentry>
    1181       </variablelist>
    1182 
    1183       <variablelist>
    1184         <varlistentry>
    1185           <term></term>
    1186 
    1187           <listitem>
    1188             <para></para>
    1189           </listitem>
    1190         </varlistentry>
    1191       </variablelist>
    1192 
    1193       <variablelist>
    1194         <varlistentry>
    1195           <term></term>
    1196 
    1197           <listitem>
    1198             <para></para>
    1199           </listitem>
    1200         </varlistentry>
    1201       </variablelist>
    1202 
    1203       <variablelist>
    1204         <varlistentry>
    1205           <term></term>
    1206 
    1207           <listitem>
    1208             <para></para>
    1209           </listitem>
    1210         </varlistentry>
    1211       </variablelist>
    1212 
    1213       <para>The configuration phase ...</para>
     1194    </section>
     1195
     1196    <section>
     1197      <title>Extract</title>
     1198
     1199      <para></para>
     1200    </section>
     1201
     1202    <section>
     1203      <title>Configure</title>
    12141204
    12151205      <para>MacPorts base sets some important default configure options, so
     
    12491239          </listitem>
    12501240        </varlistentry>
     1241
     1242        <varlistentry>
     1243          <term>configure.cflags</term>
     1244
     1245          <listitem>
     1246            <para></para>
     1247
     1248            <variablelist>
     1249              <varlistentry>
     1250                <term>configure.cflags-append</term>
     1251
     1252                <listitem>
     1253                  <para></para>
     1254                </listitem>
     1255              </varlistentry>
     1256            </variablelist>
     1257
     1258            <variablelist>
     1259              <varlistentry>
     1260                <term>configure.cflags-delete</term>
     1261
     1262                <listitem>
     1263                  <para></para>
     1264                </listitem>
     1265              </varlistentry>
     1266            </variablelist>
     1267          </listitem>
     1268        </varlistentry>
     1269
     1270        <varlistentry>
     1271          <term>configure.ldflags</term>
     1272
     1273          <listitem>
     1274            <para></para>
     1275
     1276            <variablelist>
     1277              <varlistentry>
     1278                <term>configure.ldflags-append</term>
     1279
     1280                <listitem>
     1281                  <para></para>
     1282                </listitem>
     1283              </varlistentry>
     1284            </variablelist>
     1285
     1286            <variablelist>
     1287              <varlistentry>
     1288                <term>configure.ldflags-delete</term>
     1289
     1290                <listitem>
     1291                  <para></para>
     1292                </listitem>
     1293              </varlistentry>
     1294            </variablelist>
     1295          </listitem>
     1296        </varlistentry>
     1297
     1298        <varlistentry>
     1299          <term></term>
     1300
     1301          <listitem>
     1302            <para></para>
     1303          </listitem>
     1304        </varlistentry>
    12511305      </variablelist>
    12521306
    1253       <variablelist>
    1254         <varlistentry>
    1255           <term>configure.cflags</term>
    1256 
    1257           <listitem>
    1258             <para></para>
    1259 
    1260             <variablelist>
    1261               <varlistentry>
    1262                 <term>configure.cflags-append</term>
    1263 
    1264                 <listitem>
    1265                   <para></para>
    1266                 </listitem>
    1267               </varlistentry>
    1268             </variablelist>
    1269 
    1270             <variablelist>
    1271               <varlistentry>
    1272                 <term>configure.cflags-delete</term>
    1273 
    1274                 <listitem>
    1275                   <para></para>
    1276                 </listitem>
    1277               </varlistentry>
    1278             </variablelist>
    1279           </listitem>
    1280         </varlistentry>
    1281       </variablelist>
    1282 
    1283       <variablelist>
    1284         <varlistentry>
    1285           <term>configure.ldflags</term>
    1286 
    1287           <listitem>
    1288             <para></para>
    1289 
    1290             <variablelist>
    1291               <varlistentry>
    1292                 <term>configure.ldflags-append</term>
    1293 
    1294                 <listitem>
    1295                   <para></para>
    1296                 </listitem>
    1297               </varlistentry>
    1298             </variablelist>
    1299 
    1300             <variablelist>
    1301               <varlistentry>
    1302                 <term>configure.ldflags-delete</term>
    1303 
    1304                 <listitem>
    1305                   <para></para>
    1306                 </listitem>
    1307               </varlistentry>
    1308             </variablelist>
    1309           </listitem>
    1310         </varlistentry>
    1311       </variablelist>
    1312 
    1313       <variablelist>
    1314         <varlistentry>
    1315           <term></term>
    1316 
    1317           <listitem>
    1318             <para></para>
    1319           </listitem>
    1320         </varlistentry>
    1321       </variablelist>
    1322 
    1323       <variablelist>
    1324         <varlistentry>
    1325           <term></term>
    1326 
    1327           <listitem>
    1328             <para></para>
    1329           </listitem>
    1330         </varlistentry>
    1331       </variablelist>
    1332 
    1333       <para>The build phase ...</para>
    1334 
    1335       <variablelist>
    1336         <varlistentry>
    1337           <term></term>
    1338 
    1339           <listitem>
    1340             <para></para>
    1341           </listitem>
    1342         </varlistentry>
    1343       </variablelist>
    1344 
    1345       <variablelist>
    1346         <varlistentry>
    1347           <term></term>
    1348 
    1349           <listitem>
    1350             <para></para>
    1351           </listitem>
    1352         </varlistentry>
    1353       </variablelist>
    1354 
    1355       <variablelist>
    1356         <varlistentry>
    1357           <term></term>
    1358 
    1359           <listitem>
    1360             <para></para>
    1361           </listitem>
    1362         </varlistentry>
    1363       </variablelist>
    1364 
    1365       <variablelist>
    1366         <varlistentry>
    1367           <term></term>
    1368 
    1369           <listitem>
    1370             <para></para>
    1371           </listitem>
    1372         </varlistentry>
    1373       </variablelist>
    1374 
    1375       <variablelist>
    1376         <varlistentry>
    1377           <term></term>
    1378 
    1379           <listitem>
    1380             <para></para>
    1381           </listitem>
    1382         </varlistentry>
    1383       </variablelist>
    1384 
    1385       <para>The destroot phase ...</para>
    1386 
    1387       <variablelist>
    1388         <varlistentry>
    1389           <term></term>
    1390 
    1391           <listitem>
    1392             <para></para>
    1393           </listitem>
    1394         </varlistentry>
    1395       </variablelist>
    1396 
    1397       <variablelist>
    1398         <varlistentry>
    1399           <term></term>
    1400 
    1401           <listitem>
    1402             <para></para>
    1403           </listitem>
    1404         </varlistentry>
    1405       </variablelist>
    1406 
    1407       <variablelist>
    1408         <varlistentry>
    1409           <term></term>
    1410 
    1411           <listitem>
    1412             <para></para>
    1413           </listitem>
    1414         </varlistentry>
    1415       </variablelist>
    1416 
    1417       <variablelist>
    1418         <varlistentry>
    1419           <term></term>
    1420 
    1421           <listitem>
    1422             <para></para>
    1423           </listitem>
    1424         </varlistentry>
    1425       </variablelist>
    1426 
    1427       <variablelist>
    1428         <varlistentry>
    1429           <term></term>
    1430 
    1431           <listitem>
    1432             <para></para>
    1433           </listitem>
    1434         </varlistentry>
    1435       </variablelist>
    1436 
    1437       <para>The install phase ...</para>
    1438 
    1439       <para>The activate phase ...</para>
    1440 
    14411307      <para></para>
     1308    </section>
     1309
     1310    <section>
     1311      <title>Build</title>
    14421312
    14431313      <para></para>
    14441314    </section>
     1315
     1316    <section>
     1317      <title>Destroot</title>
     1318
     1319      <para></para>
     1320    </section>
     1321
     1322    <section>
     1323      <title>Install</title>
     1324
     1325      <para></para>
     1326    </section>
     1327
     1328    <section>
     1329      <title>Activate</title>
     1330
     1331      <para></para>
     1332    </section>
    14451333  </section>
    14461334
    14471335  <section>
    1448     <title>Tcl Code and Extensions</title>
     1336    <title>Tcl Extensions</title>
    14491337
    14501338    <para>A MacPorts <filename>Portfile</filename> is a Tcl script, so it may
     
    14531341    However, few authors will use arbitrary Tcl code; the vast majority will
    14541342    use Tcl extensions that are coded within MacPorts for performing the most
    1455     common tasks needed for Portfiles. The list below is an exhaustive list of
    1456     Tcl extensions provided by MacPorts base.</para>
    1457 
    1458     <variablelist>
    1459       <varlistentry>
    1460         <term>reinplace</term>
    1461 
     1343    common tasks needed for Portfiles. The list below is a list of Tcl
     1344    extensions provided by MacPorts base.</para>
     1345
     1346    <section>
     1347      <title>file</title>
     1348
     1349      <para></para>
     1350
     1351      <para><variablelist>
     1352          <varlistentry>
     1353            <term>file</term>
     1354
     1355            <listitem>
     1356              <para>Description.</para>
     1357
     1358              <variablelist>
     1359                <varlistentry>
     1360                  <term>file copy</term>
     1361
     1362                  <listitem>
     1363                    <para></para>
     1364                  </listitem>
     1365                </varlistentry>
     1366              </variablelist>
     1367
     1368              <variablelist>
     1369                <varlistentry>
     1370                  <term>file move</term>
     1371
     1372                  <listitem>
     1373                    <para></para>
     1374                  </listitem>
     1375                </varlistentry>
     1376              </variablelist>
     1377
     1378              <variablelist>
     1379                <varlistentry>
     1380                  <term>file rename</term>
     1381
     1382                  <listitem>
     1383                    <para></para>
     1384                  </listitem>
     1385                </varlistentry>
     1386              </variablelist>
     1387
     1388              <variablelist>
     1389                <varlistentry>
     1390                  <term>file delete [-force]</term>
     1391
     1392                  <listitem>
     1393                    <para></para>
     1394                  </listitem>
     1395                </varlistentry>
     1396              </variablelist>
     1397
     1398              <variablelist>
     1399                <varlistentry>
     1400                  <term>file mkdir</term>
     1401
     1402                  <listitem>
     1403                    <para></para>
     1404                  </listitem>
     1405                </varlistentry>
     1406              </variablelist>
     1407            </listitem>
     1408          </varlistentry>
     1409
     1410          <varlistentry>
     1411            <term>macros</term>
     1412
     1413            <listitem>
     1414              <para>Description.</para>
     1415
     1416              <variablelist>
     1417                <varlistentry>
     1418                  <term>copy</term>
     1419
     1420                  <listitem>
     1421                    <para>Shorthand alternative to "file copy".</para>
     1422                  </listitem>
     1423                </varlistentry>
     1424              </variablelist>
     1425
     1426              <variablelist>
     1427                <varlistentry>
     1428                  <term>move</term>
     1429
     1430                  <listitem>
     1431                    <para>Shorthand alternative to "file rename".</para>
     1432                  </listitem>
     1433                </varlistentry>
     1434
     1435                <varlistentry>
     1436                  <term>delete file ...</term>
     1437
     1438                  <listitem>
     1439                    <para>Deletes each of the given files/directories. Behaves
     1440                    similarly to file delete -force except that file delete
     1441                    -force will fail to delete directories properly on 10.3
     1442                    systems.</para>
     1443                  </listitem>
     1444                </varlistentry>
     1445
     1446                <varlistentry>
     1447                  <term>touch</term>
     1448
     1449                  <listitem>
     1450                    <para>Mimicks the BSD touch command.</para>
     1451                  </listitem>
     1452                </varlistentry>
     1453
     1454                <varlistentry>
     1455                  <term>ln</term>
     1456
     1457                  <listitem>
     1458                    <para>Mimickes the BSD ln command.</para>
     1459                  </listitem>
     1460                </varlistentry>
     1461              </variablelist>
     1462            </listitem>
     1463          </varlistentry>
     1464
     1465          <varlistentry>
     1466            <term>xinstall</term>
     1467
     1468            <listitem>
     1469              <para>xinstall copies files and creates directories; it is
     1470              intended to be compatible with install(1).</para>
     1471
     1472              <variablelist>
     1473                <varlistentry>
     1474                  <term>xinstall [-o owner] [-g group] [-m mode] [file1 file2
     1475                  ...] directory</term>
     1476
     1477                  <listitem>
     1478                    <para>Install the specified file(s) to a destination
     1479                    directory.</para>
     1480                  </listitem>
     1481                </varlistentry>
     1482              </variablelist>
     1483
     1484              <variablelist>
     1485                <varlistentry>
     1486                  <term>xinstall [-o owner] [-g group] [-m mode] [-W dir]
     1487                  [file1 file2 ...] directory</term>
     1488
     1489                  <listitem>
     1490                    <para>Change to <option>dir</option> and install file(s)
     1491                    to a destination directory.</para>
     1492                  </listitem>
     1493                </varlistentry>
     1494              </variablelist>
     1495
     1496              <variablelist>
     1497                <varlistentry>
     1498                  <term>eval xinstall [-o owner] [-g group] [-m mode] [glob
     1499                  regexp] directory</term>
     1500
     1501                  <listitem>
     1502                    <para>Install the file(s) matching the glob expression to
     1503                    a destination directory.</para>
     1504                  </listitem>
     1505                </varlistentry>
     1506              </variablelist>
     1507
     1508              <variablelist>
     1509                <varlistentry>
     1510                  <term>xinstall -d [-o owner] [-g group] [-m mode]
     1511                  directory</term>
     1512
     1513                  <listitem>
     1514                    <para>Create a directory.</para>
     1515                  </listitem>
     1516                </varlistentry>
     1517              </variablelist>
     1518
     1519              <para>Defaults:</para>
     1520
     1521              <itemizedlist>
     1522                <listitem>
     1523                  <para>owner -</para>
     1524                </listitem>
     1525
     1526                <listitem>
     1527                  <para>group -</para>
     1528                </listitem>
     1529
     1530                <listitem>
     1531                  <para>mode -</para>
     1532                </listitem>
     1533              </itemizedlist>
     1534
     1535              <para>Examples:</para>
     1536
     1537              <programlisting>xinstall -m 640 ${worksrcpath}/doc README \
     1538       ${destroot}${prefix}/share/doc/${name}</programlisting>
     1539
     1540              <programlisting>xinstall -m 640 -W ${worksrcpath}/doc README INSTALL COPY \
     1541       ${destroot}${prefix}/share/doc/${name}</programlisting>
     1542
     1543              <programlisting>eval xinstall -m 640 [glob ${worksrcpath}/doc/* \
     1544       ${destroot}${prefix}/share/doc/${name}</programlisting>
     1545
     1546              <programlisting>xinstall -d ${destroot}${prefix}/share/doc/${name}</programlisting>
     1547            </listitem>
     1548          </varlistentry>
     1549
     1550          <varlistentry>
     1551            <term>reinplace</term>
     1552
     1553            <listitem>
     1554              <para>Description.</para>
     1555
     1556              <para>Examples:</para>
     1557
     1558              <programlisting></programlisting>
     1559
     1560              <programlisting></programlisting>
     1561
     1562              <programlisting></programlisting>
     1563            </listitem>
     1564          </varlistentry>
     1565
     1566          <varlistentry>
     1567            <term>user/group</term>
     1568
     1569            <listitem>
     1570              <para></para>
     1571
     1572              <variablelist>
     1573                <varlistentry>
     1574                  <term>adduser username [uid=uid] [gid=gid] [passwd=passwd]
     1575                  [realname=realname] [home=home] [shell=shell]</term>
     1576
     1577                  <listitem>
     1578                    <para>Add a new local user to the system with the
     1579                    specified uid, gid, password, real name, home directory
     1580                    and login shell.</para>
     1581                  </listitem>
     1582                </varlistentry>
     1583              </variablelist>
     1584
     1585              <variablelist>
     1586                <varlistentry>
     1587                  <term>existsuser username</term>
     1588
     1589                  <listitem>
     1590                    <para>Check if a local user exists.</para>
     1591                  </listitem>
     1592                </varlistentry>
     1593              </variablelist>
     1594
     1595              <variablelist>
     1596                <varlistentry>
     1597                  <term>nextuid</term>
     1598
     1599                  <listitem>
     1600                    <para>Returns the highest used uid plus one.</para>
     1601                  </listitem>
     1602                </varlistentry>
     1603              </variablelist>
     1604
     1605              <variablelist>
     1606                <varlistentry>
     1607                  <term>addgroup group [gid=gid] [passwd=passwd]
     1608                  [realname=realname] [users=users]</term>
     1609
     1610                  <listitem>
     1611                    <para>Add a new local group to the system, with the
     1612                    specified gid, password, real name, and with a list users
     1613                    as members.</para>
     1614                  </listitem>
     1615                </varlistentry>
     1616              </variablelist>
     1617
     1618              <variablelist>
     1619                <varlistentry>
     1620                  <term>existsgroup group</term>
     1621
     1622                  <listitem>
     1623                    <para>Check if a local group exists and return the
     1624                    corresponding gid. This can be used with adduser:</para>
     1625
     1626                    <programlisting>addgroup foo
     1627adduser foo gid=[existsgroup foo]</programlisting>
     1628                  </listitem>
     1629                </varlistentry>
     1630              </variablelist>
     1631
     1632              <variablelist>
     1633                <varlistentry>
     1634                  <term>nextgid</term>
     1635
     1636                  <listitem>
     1637                    <para>Returns the highest used gid plus one.</para>
     1638                  </listitem>
     1639                </varlistentry>
     1640              </variablelist>
     1641            </listitem>
     1642          </varlistentry>
     1643
     1644          <varlistentry>
     1645            <term>External program execution</term>
     1646
     1647            <listitem>
     1648              <para></para>
     1649            </listitem>
     1650          </varlistentry>
     1651        </variablelist></para>
     1652
     1653      <para></para>
     1654
     1655      <para></para>
     1656    </section>
     1657
     1658    <section>
     1659      <title>xinstall</title>
     1660
     1661      <para>xinstall copies files and creates directories; it is intended to
     1662      be compatible with install(1).</para>
     1663
     1664      <para><variablelist>
     1665          <varlistentry>
     1666            <term>xinstall [-o owner] [-g group] [-m mode] [file1 file2 ...]
     1667            directory</term>
     1668
     1669            <listitem>
     1670              <para>Install the specified file(s) to a destination
     1671              directory.</para>
     1672            </listitem>
     1673          </varlistentry>
     1674        </variablelist><variablelist>
     1675          <varlistentry>
     1676            <term>xinstall [-o owner] [-g group] [-m mode] [-W dir] [file1
     1677            file2 ...] directory</term>
     1678
     1679            <listitem>
     1680              <para>Change to <option>dir</option> and install file(s) to a
     1681              destination directory.</para>
     1682            </listitem>
     1683          </varlistentry>
     1684        </variablelist><variablelist>
     1685          <varlistentry>
     1686            <term>eval xinstall [-o owner] [-g group] [-m mode] [glob regexp]
     1687            directory</term>
     1688
     1689            <listitem>
     1690              <para>Install the file(s) matching the glob expression to a
     1691              destination directory.</para>
     1692            </listitem>
     1693          </varlistentry>
     1694        </variablelist><variablelist>
     1695          <varlistentry>
     1696            <term>xinstall -d [-o owner] [-g group] [-m mode] directory</term>
     1697
     1698            <listitem>
     1699              <para>Create a directory.</para>
     1700            </listitem>
     1701          </varlistentry>
     1702        </variablelist></para>
     1703
     1704      <para>Defaults:</para>
     1705
     1706      <itemizedlist>
    14621707        <listitem>
    1463           <para>Description reinplace.</para>
     1708          <para>owner -</para>
    14641709        </listitem>
    1465       </varlistentry>
    1466     </variablelist>
    1467 
    1468     <variablelist>
    1469       <varlistentry>
    1470         <term>xinstall</term>
    14711710
    14721711        <listitem>
    1473           <para>Description xinstall.</para>
     1712          <para>group -</para>
    14741713        </listitem>
    1475       </varlistentry>
    1476     </variablelist>
    1477 
    1478     <variablelist>
    1479       <varlistentry>
    1480         <term>file copy</term>
    14811714
    14821715        <listitem>
    1483           <para>Description file copy.</para>
     1716          <para>mode - 755</para>
    14841717        </listitem>
    1485       </varlistentry>
    1486     </variablelist>
    1487 
    1488     <variablelist>
    1489       <varlistentry>
    1490         <term>file delete</term>
    1491 
    1492         <listitem>
    1493           <para>Description file delete.</para>
    1494         </listitem>
    1495       </varlistentry>
    1496     </variablelist>
    1497 
    1498     <variablelist>
    1499       <varlistentry>
    1500         <term></term>
    1501 
    1502         <listitem>
    1503           <para></para>
    1504         </listitem>
    1505       </varlistentry>
    1506     </variablelist>
    1507 
    1508     <variablelist>
    1509       <varlistentry>
    1510         <term></term>
    1511 
    1512         <listitem>
    1513           <para></para>
    1514         </listitem>
    1515       </varlistentry>
    1516     </variablelist>
    1517 
    1518     <variablelist>
    1519       <varlistentry>
    1520         <term></term>
    1521 
    1522         <listitem>
    1523           <para></para>
    1524         </listitem>
    1525       </varlistentry>
    1526     </variablelist>
    1527 
    1528     <variablelist>
    1529       <varlistentry>
    1530         <term></term>
    1531 
    1532         <listitem>
    1533           <para></para>
    1534         </listitem>
    1535       </varlistentry>
    1536     </variablelist>
    1537 
    1538     <variablelist>
    1539       <varlistentry>
    1540         <term></term>
    1541 
    1542         <listitem>
    1543           <para></para>
    1544         </listitem>
    1545       </varlistentry>
    1546     </variablelist>
    1547 
    1548     <variablelist>
    1549       <varlistentry>
    1550         <term></term>
    1551 
    1552         <listitem>
    1553           <para></para>
    1554         </listitem>
    1555       </varlistentry>
    1556     </variablelist>
    1557 
    1558     <variablelist>
    1559       <varlistentry>
    1560         <term></term>
    1561 
    1562         <listitem>
    1563           <para></para>
    1564         </listitem>
    1565       </varlistentry>
    1566     </variablelist>
     1718      </itemizedlist>
     1719
     1720      <para>Examples:</para>
     1721
     1722      <programlisting>xinstall -m 640 ${worksrcpath}/doc README \
     1723       ${destroot}${prefix}/share/doc/${name}</programlisting>
     1724
     1725      <programlisting>xinstall -m 640 -W ${worksrcpath}/doc README INSTALL COPY \
     1726       ${destroot}${prefix}/share/doc/${name}</programlisting>
     1727
     1728      <programlisting>eval xinstall -m 640 [glob ${worksrcpath}/doc/* \
     1729       ${destroot}${prefix}/share/doc/${name}</programlisting>
     1730
     1731      <programlisting>xinstall -d ${destroot}${prefix}/share/doc/${name}</programlisting>
     1732
     1733      <para></para>
     1734
     1735      <para></para>
     1736    </section>
     1737
     1738    <section>
     1739      <title>reinplace</title>
     1740
     1741      <para></para>
     1742    </section>
     1743
     1744    <section>
     1745      <title>user/group</title>
     1746
     1747      <para></para>
     1748
     1749      <variablelist>
     1750        <varlistentry>
     1751          <term>adduser username [uid=uid] [gid=gid] [passwd=passwd]
     1752          [realname=realname] [home=home] [shell=shell]</term>
     1753
     1754          <listitem>
     1755            <para>Add a new local user to the system with the specified uid,
     1756            gid, password, real name, home directory and login shell.</para>
     1757          </listitem>
     1758        </varlistentry>
     1759
     1760        <varlistentry>
     1761          <term>existsuser username</term>
     1762
     1763          <listitem>
     1764            <para>Check if a local user exists.</para>
     1765          </listitem>
     1766        </varlistentry>
     1767
     1768        <varlistentry>
     1769          <term>nextuid</term>
     1770
     1771          <listitem>
     1772            <para>Returns the highest used uid plus one.</para>
     1773          </listitem>
     1774        </varlistentry>
     1775
     1776        <varlistentry>
     1777          <term>addgroup group [gid=gid] [passwd=passwd] [realname=realname]
     1778          [users=users]</term>
     1779
     1780          <listitem>
     1781            <para>Add a new local group to the system, with the specified gid,
     1782            password, real name, and with a list users as members.</para>
     1783          </listitem>
     1784        </varlistentry>
     1785
     1786        <varlistentry>
     1787          <term>existsgroup group</term>
     1788
     1789          <listitem>
     1790            <para>Check if a local group exists and return the corresponding
     1791            gid. This can be used with adduser:</para>
     1792
     1793            <programlisting>addgroup foo
     1794adduser foo gid=[existsgroup foo]</programlisting>
     1795          </listitem>
     1796        </varlistentry>
     1797      </variablelist>
     1798    </section>
     1799
     1800    <section>
     1801      <title>Execute External Programs</title>
     1802
     1803      <para>Only use when ...</para>
     1804    </section>
    15671805  </section>
    15681806</chapter>
Note: See TracChangeset for help on using the changeset viewer.