Changeset 31879 for trunk/doc-new


Ignore:
Timestamp:
Dec 10, 2007, 9:24:09 PM (12 years ago)
Author:
simon@…
Message:

doc-new: Moved "Tcl Extensions" to portfile-tcl.7.xml so this section is included in the man pages.

Location:
trunk/doc-new/guide/xml
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc-new/guide/xml/portfile-tcl.7.xml

    r31622 r31879  
    66  <title>Tcl Extensions</title>
    77
    8   <para>TODO: Describe Tcl Extensions here ..</para>
     8  <para>A MacPorts Portfile is a Tcl script, so it may contain any arbitrary
     9  Tcl code you may learn about in a <ulink
     10  url="http://tmml.sourceforge.net/doc/tcl/">Tcl reference manual</ulink>.
     11  However, few authors will use arbitrary Tcl code; the vast majority will use
     12  Tcl extensions that are coded within MacPorts for performing the most common
     13  tasks needed for Portfiles. The list below is a list of Tcl extensions
     14  provided by MacPorts base.</para>
     15
     16  <variablelist>
     17    <varlistentry>
     18      <term>file</term>
     19
     20      <listitem>
     21        <para>Description.</para>
     22
     23        <variablelist>
     24          <varlistentry>
     25            <term>file copy</term>
     26
     27            <listitem>
     28              <para></para>
     29            </listitem>
     30          </varlistentry>
     31        </variablelist>
     32
     33        <variablelist>
     34          <varlistentry>
     35            <term>file move</term>
     36
     37            <listitem>
     38              <para></para>
     39            </listitem>
     40          </varlistentry>
     41        </variablelist>
     42
     43        <variablelist>
     44          <varlistentry>
     45            <term>file rename</term>
     46
     47            <listitem>
     48              <para></para>
     49            </listitem>
     50          </varlistentry>
     51        </variablelist>
     52
     53        <variablelist>
     54          <varlistentry>
     55            <term>file delete [-force]</term>
     56
     57            <listitem>
     58              <para></para>
     59            </listitem>
     60          </varlistentry>
     61        </variablelist>
     62
     63        <variablelist>
     64          <varlistentry>
     65            <term>file mkdir</term>
     66
     67            <listitem>
     68              <para></para>
     69            </listitem>
     70          </varlistentry>
     71        </variablelist>
     72      </listitem>
     73    </varlistentry>
     74
     75    <varlistentry>
     76      <term>macros</term>
     77
     78      <listitem>
     79        <para>Description.</para>
     80
     81        <variablelist>
     82          <varlistentry>
     83            <term>copy</term>
     84
     85            <listitem>
     86              <para>Shorthand alternative to "file copy".</para>
     87            </listitem>
     88          </varlistentry>
     89        </variablelist>
     90
     91        <variablelist>
     92          <varlistentry>
     93            <term>move</term>
     94
     95            <listitem>
     96              <para>Shorthand alternative to "file rename".</para>
     97            </listitem>
     98          </varlistentry>
     99
     100          <varlistentry>
     101            <term>delete file ...</term>
     102
     103            <listitem>
     104              <para>Deletes each of the given files/directories. Behaves
     105              similarly to file delete -force except that file delete
     106              -force will fail to delete directories properly on 10.3
     107              systems.</para>
     108            </listitem>
     109          </varlistentry>
     110
     111          <varlistentry>
     112            <term>touch</term>
     113
     114            <listitem>
     115              <para>Mimicks the BSD touch command.</para>
     116            </listitem>
     117          </varlistentry>
     118
     119          <varlistentry>
     120            <term>ln</term>
     121
     122            <listitem>
     123              <para>Mimickes the BSD ln command.</para>
     124            </listitem>
     125          </varlistentry>
     126        </variablelist>
     127      </listitem>
     128    </varlistentry>
     129
     130    <varlistentry>
     131      <term>xinstall</term>
     132
     133      <listitem>
     134        <para>xinstall copies files and creates directories; it is
     135        intended to be compatible with install(1).</para>
     136
     137        <variablelist>
     138          <varlistentry>
     139            <term>xinstall [-o <replaceable>owner</replaceable>] [-g
     140            <replaceable>group</replaceable>] [-m
     141            <replaceable>mode</replaceable>] [<replaceable>file1 file2
     142            ...</replaceable>] <replaceable>directory</replaceable></term>
     143
     144            <listitem>
     145              <para>Install the specified file(s) to a destination
     146              directory.</para>
     147            </listitem>
     148          </varlistentry>
     149        </variablelist>
     150
     151        <variablelist>
     152          <varlistentry>
     153            <term>xinstall [-o <replaceable>owner</replaceable>] [-g
     154            <replaceable>group</replaceable>] [-m
     155            <replaceable>mode</replaceable>] [-W
     156            <replaceable>dir</replaceable>] [<replaceable>file1 file2
     157            ...</replaceable>] <replaceable>directory</replaceable></term>
     158
     159            <listitem>
     160              <para>Change to <option>dir</option> and install file(s) to
     161              a destination directory.</para>
     162            </listitem>
     163          </varlistentry>
     164        </variablelist>
     165
     166        <variablelist>
     167          <varlistentry>
     168            <term>eval xinstall [-o <replaceable>owner</replaceable>] [-g
     169            <replaceable>group</replaceable>] [-m
     170            <replaceable>mode</replaceable>] [glob
     171            <replaceable>pattern</replaceable>]
     172            <replaceable>directory</replaceable></term>
     173
     174            <listitem>
     175              <para>Install the file(s) matching the glob pattern to a
     176              destination directory.</para>
     177            </listitem>
     178          </varlistentry>
     179        </variablelist>
     180
     181        <variablelist>
     182          <varlistentry>
     183            <term>xinstall -d [-o <replaceable>owner</replaceable>] [-g
     184            <replaceable>group</replaceable>] [-m
     185            <replaceable>mode</replaceable>]
     186            <replaceable>directory</replaceable></term>
     187
     188            <listitem>
     189              <para>Create a directory.</para>
     190            </listitem>
     191          </varlistentry>
     192        </variablelist>
     193
     194        <para>Defaults:</para>
     195
     196        <itemizedlist>
     197          <listitem>
     198            <para>owner -</para>
     199          </listitem>
     200
     201          <listitem>
     202            <para>group -</para>
     203          </listitem>
     204
     205          <listitem>
     206            <para>mode -</para>
     207          </listitem>
     208        </itemizedlist>
     209
     210        <para>Examples:</para>
     211
     212        <programlisting>xinstall -m 640 ${worksrcpath}/doc README \
     213   ${destroot}${prefix}/share/doc/${name}</programlisting>
     214
     215        <programlisting>xinstall -m 640 -W ${worksrcpath}/doc README INSTALL COPY \
     216   ${destroot}${prefix}/share/doc/${name}</programlisting>
     217
     218        <programlisting>eval xinstall -m 640 [glob ${worksrcpath}/doc/*] \
     219   ${destroot}${prefix}/share/doc/${name}</programlisting>
     220
     221        <programlisting>xinstall -d ${destroot}${prefix}/share/doc/${name}</programlisting>
     222      </listitem>
     223    </varlistentry>
     224
     225    <varlistentry>
     226      <term>reinplace</term>
     227
     228      <listitem>
     229        <para>Description.</para>
     230
     231        <para>Examples:</para>
     232
     233        <programlisting>example 1</programlisting>
     234
     235        <programlisting>example 2</programlisting>
     236
     237        <programlisting>example 3</programlisting>
     238      </listitem>
     239    </varlistentry>
     240
     241    <varlistentry>
     242      <term>user/group</term>
     243
     244      <listitem>
     245        <para></para>
     246
     247        <variablelist>
     248          <varlistentry>
     249            <term>adduser username [uid=<replaceable>uid</replaceable>]
     250            [gid=<replaceable>gid</replaceable>]
     251            [passwd=<replaceable>passwd</replaceable>]
     252            [realname=<replaceable>realname</replaceable>]
     253            [home=<replaceable>home</replaceable>]
     254            [shell=<replaceable>shell</replaceable>]</term>
     255
     256            <listitem>
     257              <para>Add a new local user to the system with the specified
     258              uid, gid, password, real name, home directory and login
     259              shell.</para>
     260            </listitem>
     261          </varlistentry>
     262        </variablelist>
     263
     264        <variablelist>
     265          <varlistentry>
     266            <term>existsuser <replaceable>username</replaceable></term>
     267
     268            <listitem>
     269              <para>Check if a local user exists.</para>
     270            </listitem>
     271          </varlistentry>
     272        </variablelist>
     273
     274        <variablelist>
     275          <varlistentry>
     276            <term>nextuid</term>
     277
     278            <listitem>
     279              <para>Returns the highest used uid plus one.</para>
     280            </listitem>
     281          </varlistentry>
     282        </variablelist>
     283
     284        <variablelist>
     285          <varlistentry>
     286            <term>addgroup <replaceable>group</replaceable>
     287            [gid=<replaceable>gid</replaceable>]
     288            [passwd=<replaceable>passwd</replaceable>]
     289            [realname=<replaceable>realname</replaceable>]
     290            [users=<replaceable>users</replaceable>]</term>
     291
     292            <listitem>
     293              <para>Add a new local group to the system, with the
     294              specified gid, password, real name, and with a list users as
     295              members.</para>
     296            </listitem>
     297          </varlistentry>
     298        </variablelist>
     299
     300        <variablelist>
     301          <varlistentry>
     302            <term>existsgroup <replaceable>group</replaceable></term>
     303
     304            <listitem>
     305              <para>Check if a local group exists and return the
     306              corresponding gid. This can be used with adduser:</para>
     307
     308              <programlisting>addgroup foo
     309adduser foo gid=[existsgroup foo]</programlisting>
     310            </listitem>
     311          </varlistentry>
     312        </variablelist>
     313
     314        <variablelist>
     315          <varlistentry>
     316            <term>nextgid</term>
     317
     318            <listitem>
     319              <para>Returns the highest used gid plus one.</para>
     320            </listitem>
     321          </varlistentry>
     322        </variablelist>
     323      </listitem>
     324    </varlistentry>
     325
     326    <varlistentry>
     327      <term>External program execution</term>
     328
     329      <listitem>
     330        <para>Use only when ....</para>
     331      </listitem>
     332    </varlistentry>
     333  </variablelist>
    9334</section>
  • trunk/doc-new/guide/xml/portfileref.xml

    r31862 r31879  
    163163    </section>
    164164  </section>
    165 
    166   <section id="reference.tcl-extensions-old">
    167     <title>Tcl Extensions</title>
    168 
    169     <para>A MacPorts Portfile is a Tcl script, so it may contain any arbitrary
    170     Tcl code you may learn about in a <ulink
    171     url="http://tmml.sourceforge.net/doc/tcl/">Tcl reference manual</ulink>.
    172     However, few authors will use arbitrary Tcl code; the vast majority will
    173     use Tcl extensions that are coded within MacPorts for performing the most
    174     common tasks needed for Portfiles. The list below is a list of Tcl
    175     extensions provided by MacPorts base.</para>
    176 
    177     <para><variablelist>
    178         <varlistentry>
    179           <term>file</term>
    180 
    181           <listitem>
    182             <para>Description.</para>
    183 
    184             <variablelist>
    185               <varlistentry>
    186                 <term>file copy</term>
    187 
    188                 <listitem>
    189                   <para></para>
    190                 </listitem>
    191               </varlistentry>
    192             </variablelist>
    193 
    194             <variablelist>
    195               <varlistentry>
    196                 <term>file move</term>
    197 
    198                 <listitem>
    199                   <para></para>
    200                 </listitem>
    201               </varlistentry>
    202             </variablelist>
    203 
    204             <variablelist>
    205               <varlistentry>
    206                 <term>file rename</term>
    207 
    208                 <listitem>
    209                   <para></para>
    210                 </listitem>
    211               </varlistentry>
    212             </variablelist>
    213 
    214             <variablelist>
    215               <varlistentry>
    216                 <term>file delete [-force]</term>
    217 
    218                 <listitem>
    219                   <para></para>
    220                 </listitem>
    221               </varlistentry>
    222             </variablelist>
    223 
    224             <variablelist>
    225               <varlistentry>
    226                 <term>file mkdir</term>
    227 
    228                 <listitem>
    229                   <para></para>
    230                 </listitem>
    231               </varlistentry>
    232             </variablelist>
    233           </listitem>
    234         </varlistentry>
    235 
    236         <varlistentry>
    237           <term>macros</term>
    238 
    239           <listitem>
    240             <para>Description.</para>
    241 
    242             <variablelist>
    243               <varlistentry>
    244                 <term>copy</term>
    245 
    246                 <listitem>
    247                   <para>Shorthand alternative to "file copy".</para>
    248                 </listitem>
    249               </varlistentry>
    250             </variablelist>
    251 
    252             <variablelist>
    253               <varlistentry>
    254                 <term>move</term>
    255 
    256                 <listitem>
    257                   <para>Shorthand alternative to "file rename".</para>
    258                 </listitem>
    259               </varlistentry>
    260 
    261               <varlistentry>
    262                 <term>delete file ...</term>
    263 
    264                 <listitem>
    265                   <para>Deletes each of the given files/directories. Behaves
    266                   similarly to file delete -force except that file delete
    267                   -force will fail to delete directories properly on 10.3
    268                   systems.</para>
    269                 </listitem>
    270               </varlistentry>
    271 
    272               <varlistentry>
    273                 <term>touch</term>
    274 
    275                 <listitem>
    276                   <para>Mimicks the BSD touch command.</para>
    277                 </listitem>
    278               </varlistentry>
    279 
    280               <varlistentry>
    281                 <term>ln</term>
    282 
    283                 <listitem>
    284                   <para>Mimickes the BSD ln command.</para>
    285                 </listitem>
    286               </varlistentry>
    287             </variablelist>
    288           </listitem>
    289         </varlistentry>
    290 
    291         <varlistentry>
    292           <term>xinstall</term>
    293 
    294           <listitem>
    295             <para>xinstall copies files and creates directories; it is
    296             intended to be compatible with install(1).</para>
    297 
    298             <variablelist>
    299               <varlistentry>
    300                 <term>xinstall [-o <replaceable>owner</replaceable>] [-g
    301                 <replaceable>group</replaceable>] [-m
    302                 <replaceable>mode</replaceable>] [<replaceable>file1 file2
    303                 ...</replaceable>] <replaceable>directory</replaceable></term>
    304 
    305                 <listitem>
    306                   <para>Install the specified file(s) to a destination
    307                   directory.</para>
    308                 </listitem>
    309               </varlistentry>
    310             </variablelist>
    311 
    312             <variablelist>
    313               <varlistentry>
    314                 <term>xinstall [-o <replaceable>owner</replaceable>] [-g
    315                 <replaceable>group</replaceable>] [-m
    316                 <replaceable>mode</replaceable>] [-W
    317                 <replaceable>dir</replaceable>] [<replaceable>file1 file2
    318                 ...</replaceable>] <replaceable>directory</replaceable></term>
    319 
    320                 <listitem>
    321                   <para>Change to <option>dir</option> and install file(s) to
    322                   a destination directory.</para>
    323                 </listitem>
    324               </varlistentry>
    325             </variablelist>
    326 
    327             <variablelist>
    328               <varlistentry>
    329                 <term>eval xinstall [-o <replaceable>owner</replaceable>] [-g
    330                 <replaceable>group</replaceable>] [-m
    331                 <replaceable>mode</replaceable>] [glob
    332                 <replaceable>pattern</replaceable>]
    333                 <replaceable>directory</replaceable></term>
    334 
    335                 <listitem>
    336                   <para>Install the file(s) matching the glob pattern to a
    337                   destination directory.</para>
    338                 </listitem>
    339               </varlistentry>
    340             </variablelist>
    341 
    342             <variablelist>
    343               <varlistentry>
    344                 <term>xinstall -d [-o <replaceable>owner</replaceable>] [-g
    345                 <replaceable>group</replaceable>] [-m
    346                 <replaceable>mode</replaceable>]
    347                 <replaceable>directory</replaceable></term>
    348 
    349                 <listitem>
    350                   <para>Create a directory.</para>
    351                 </listitem>
    352               </varlistentry>
    353             </variablelist>
    354 
    355             <para>Defaults:</para>
    356 
    357             <itemizedlist>
    358               <listitem>
    359                 <para>owner -</para>
    360               </listitem>
    361 
    362               <listitem>
    363                 <para>group -</para>
    364               </listitem>
    365 
    366               <listitem>
    367                 <para>mode -</para>
    368               </listitem>
    369             </itemizedlist>
    370 
    371             <para>Examples:</para>
    372 
    373             <programlisting>xinstall -m 640 ${worksrcpath}/doc README \
    374        ${destroot}${prefix}/share/doc/${name}</programlisting>
    375 
    376             <programlisting>xinstall -m 640 -W ${worksrcpath}/doc README INSTALL COPY \
    377        ${destroot}${prefix}/share/doc/${name}</programlisting>
    378 
    379             <programlisting>eval xinstall -m 640 [glob ${worksrcpath}/doc/*] \
    380        ${destroot}${prefix}/share/doc/${name}</programlisting>
    381 
    382             <programlisting>xinstall -d ${destroot}${prefix}/share/doc/${name}</programlisting>
    383           </listitem>
    384         </varlistentry>
    385 
    386         <varlistentry>
    387           <term>reinplace</term>
    388 
    389           <listitem>
    390             <para>Description.</para>
    391 
    392             <para>Examples:</para>
    393 
    394             <programlisting>example 1</programlisting>
    395 
    396             <programlisting>example 2</programlisting>
    397 
    398             <programlisting>example 3</programlisting>
    399           </listitem>
    400         </varlistentry>
    401 
    402         <varlistentry>
    403           <term>user/group</term>
    404 
    405           <listitem>
    406             <para></para>
    407 
    408             <variablelist>
    409               <varlistentry>
    410                 <term>adduser username [uid=<replaceable>uid</replaceable>]
    411                 [gid=<replaceable>gid</replaceable>]
    412                 [passwd=<replaceable>passwd</replaceable>]
    413                 [realname=<replaceable>realname</replaceable>]
    414                 [home=<replaceable>home</replaceable>]
    415                 [shell=<replaceable>shell</replaceable>]</term>
    416 
    417                 <listitem>
    418                   <para>Add a new local user to the system with the specified
    419                   uid, gid, password, real name, home directory and login
    420                   shell.</para>
    421                 </listitem>
    422               </varlistentry>
    423             </variablelist>
    424 
    425             <variablelist>
    426               <varlistentry>
    427                 <term>existsuser <replaceable>username</replaceable></term>
    428 
    429                 <listitem>
    430                   <para>Check if a local user exists.</para>
    431                 </listitem>
    432               </varlistentry>
    433             </variablelist>
    434 
    435             <variablelist>
    436               <varlistentry>
    437                 <term>nextuid</term>
    438 
    439                 <listitem>
    440                   <para>Returns the highest used uid plus one.</para>
    441                 </listitem>
    442               </varlistentry>
    443             </variablelist>
    444 
    445             <variablelist>
    446               <varlistentry>
    447                 <term>addgroup <replaceable>group</replaceable>
    448                 [gid=<replaceable>gid</replaceable>]
    449                 [passwd=<replaceable>passwd</replaceable>]
    450                 [realname=<replaceable>realname</replaceable>]
    451                 [users=<replaceable>users</replaceable>]</term>
    452 
    453                 <listitem>
    454                   <para>Add a new local group to the system, with the
    455                   specified gid, password, real name, and with a list users as
    456                   members.</para>
    457                 </listitem>
    458               </varlistentry>
    459             </variablelist>
    460 
    461             <variablelist>
    462               <varlistentry>
    463                 <term>existsgroup <replaceable>group</replaceable></term>
    464 
    465                 <listitem>
    466                   <para>Check if a local group exists and return the
    467                   corresponding gid. This can be used with adduser:</para>
    468 
    469                   <programlisting>addgroup foo
    470 adduser foo gid=[existsgroup foo]</programlisting>
    471                 </listitem>
    472               </varlistentry>
    473             </variablelist>
    474 
    475             <variablelist>
    476               <varlistentry>
    477                 <term>nextgid</term>
    478 
    479                 <listitem>
    480                   <para>Returns the highest used gid plus one.</para>
    481                 </listitem>
    482               </varlistentry>
    483             </variablelist>
    484           </listitem>
    485         </varlistentry>
    486 
    487         <varlistentry>
    488           <term>External program execution</term>
    489 
    490           <listitem>
    491             <para>Use only when ....</para>
    492           </listitem>
    493         </varlistentry>
    494       </variablelist></para>
    495 
    496     <para></para>
    497   </section>
    498165</chapter>
Note: See TracChangeset for help on using the changeset viewer.