source: trunk/doc/guide/xml/commands.xml @ 3977

Last change on this file since 3977 was 3977, checked in by jkh, 17 years ago

Fix the historical "sufx botch" by renaming it to "suffix"
Reviewed by: fkr & darwinports mailing list

  • Property svn:eol-style set to native
File size: 12.2 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<chapter id="commands">
5  <title>Portfile Command Reference</title>
6
7  <sect1>
8    <title>Commands</title>
9   
10    <sect2>
11      <title>Fetch Options</title>
12
13      <para></para>
14
15    </sect2>
16   
17    <sect2>
18      <title>Extract Options</title>
19
20      <variablelist>
21        <varlistentry>
22          <term>extract.only</term>
23
24          <listitem>
25            <synopsis>Type: Optional Default: ${distfiles}</synopsis>
26
27            <para>List of files to extract into ${workpath}.</para>
28
29            <para><userinput>extract.only worksrc-1.4.4.tar.gz
30            </userinput></para>
31
32          </listitem>
33        </varlistentry>
34
35        <varlistentry>
36          <term>extract.cmd</term>
37
38          <listitem>
39            <synopsis>Type: optional Default: gzip</synopsis>
40
41            <para>Command to perform extract.</para>
42
43            <para><userinput>extract.cmd bzip2</userinput></para>
44
45          </listitem>
46        </varlistentry>
47
48        <varlistentry>
49          <term>extract.pre_args</term>
50
51          <listitem>
52            <synopsis>Type: optional Default: -dc</synopsis>
53
54            <para>Arguments added to ${extract.cmd} before a file name.</para>
55
56            <para><userinput>extract.pre_args -cd</userinput></para>
57
58          </listitem>
59        </varlistentry>
60
61        <varlistentry>
62          <term>extract.args</term>
63
64          <listitem>
65            <synopsis>Type: read-only Default: ${distpath}/${distfile}</synopsis>
66
67            <para>Arguments to ${extract.cmd}.</para>
68          </listitem>
69        </varlistentry>
70
71        <varlistentry>
72          <term>extract.post_args</term>
73
74          <listitem>
75            <synopsis>Type: optional Default: | tar -xf -</synopsis>
76
77            <para>Arguments added to extract command after a file name.</para>
78
79            <para><userinput>
80            extract.post_args | tar -x -s@bladeenc-0.94.2/other_makefiles/BladeEnc..@@p -f -
81            </userinput></para>
82
83          </listitem>
84        </varlistentry>
85
86        <varlistentry>
87          <term>extract.suffix</term>
88
89          <listitem>
90            <synopsis>Type: optional Default: .tar.gz</synopsis>
91
92            <para>Suffix to append to ${distname}</para>
93
94            <para><userinput>extract.suffix .tgz</userinput></para>
95
96          </listitem>
97        </varlistentry>
98
99        <varlistentry>
100          <term>use_zip</term>
101
102          <listitem>
103            <synopsis>Type: optional</synopsis>
104
105            <para>Sets extract.suffix to: .zip Sets extract.cmd to:
106            unzip Sets extract.pre_args to: -q Sets extract.post_args
107            to: "-d $portpath/$workdir"</para>
108
109            <para><userinput>use_zip yes</userinput></para>
110
111          </listitem>
112        </varlistentry>
113      </variablelist>
114    </sect2>
115   
116    <sect2>
117      <title>File Verification Options</title>
118                <variablelist>
119                  <varlistentry>
120                          <term>checksums</term>
121       
122                          <listitem>
123                                <synopsis>Type: optional</synopsis>
124                               
125                                <para>List of checksums in the format: &lt;file name&gt; 
126                                &lt;checksum type&gt; &lt;checksum&gt; Currently, the only
127                                supported checksum type is md5. If only one file is
128                                downloaded, the filename may be ommitted.</para>
129
130                                <para><userinput>checksums dictd-1.7.1.tar.gz
131                                md5 81317b86ea0a5df0163900ad2e6bb12c</userinput></para>
132
133                          </listitem>
134                        </varlistentry>
135      </variablelist>
136    </sect2>
137
138    <sect2>
139      <title>CVS Options</title>
140
141      <para></para>
142
143    </sect2>
144
145    <sect2>
146      <title>Patch Options</title>
147
148      <para></para>
149
150    </sect2>
151        <sect2>
152      <title>Configure Options</title>
153
154      <variablelist>
155        <varlistentry>
156          <term>configure.pre_args</term>
157
158          <listitem>
159            <synopsis>Type: optional</synopsis>
160
161            <para>Arguments added to configure command before
162            ${configure.args}.</para>
163
164            <para><userinput>configure.pre_args
165            --prefix=${prefix}/etc</userinput></para>
166
167          </listitem>
168        </varlistentry>
169
170        <varlistentry>
171          <term>configure.args</term>
172
173          <listitem>
174            <synopsis>Type: optional</synopsis>
175
176            <para>Arguments to pass to ${configure.cmd}.</para>
177
178            <para><userinput>configure.args
179            --etcdir=${prefix}/etc</userinput></para>
180
181          </listitem>
182        </varlistentry>
183
184        <varlistentry>
185          <term>configure.dir</term>
186
187          <listitem>
188            <synopsis>Type: optional</synopsis>
189
190            <para>Directory in which to run ${configure-cmd}.</para>
191
192            <para><userinput>configure.dir src</userinput></para>
193
194          </listitem>
195        </varlistentry>
196      </variablelist>
197    </sect2>
198
199    <sect2>
200      <title>Automake Options</title>
201
202      <variablelist>
203        <varlistentry>
204          <term>use_automake</term>
205
206          <listitem>
207            <synopsis>Type: optional Default: ${workpath}/${worksrcdir}
208            </synopsis>
209
210            <para>If set to yes, use ${automake.cmd}.</para>
211
212            <para><userinput>use_automake yes</userinput></para>
213
214          </listitem>
215        </varlistentry>
216
217        <varlistentry>
218          <term>automake.env</term>
219
220          <listitem>
221            <synopsis>Type: optional</synopsis>
222
223            <para>Environmental variables to pass to ${automake.cmd}.</para>
224
225            <para><userinput>automake.env
226            CFLAGS=-I${prefix}/include/gtk12</userinput></para>
227
228          </listitem>
229        </varlistentry>
230
231        <varlistentry>
232          <term>automake.args</term>
233
234          <listitem>
235            <synopsis>Type: optional</synopsis>
236
237            <para>Arguments to pass to ${automake.cmd}.</para>
238
239            <para><userinput>automake.args --foreign</userinput></para>
240
241          </listitem>
242        </varlistentry>
243
244        <varlistentry>
245          <term>automake.dir</term>
246
247          <listitem>
248            <synopsis>Type: optional Default:
249            ${workpath}/${worksrcdir}</synopsis>
250
251            <para>Directory in which to run ${automake.cmd}.</para>
252
253            <para><userinput>automake.dir src</userinput></para>
254
255          </listitem>
256        </varlistentry>
257      </variablelist>
258    </sect2>
259
260    <sect2>
261      <title>Autoconf Options</title>
262
263      <variablelist>
264        <varlistentry>
265          <term>use_autoconf</term>
266
267          <listitem>
268            <synopsis>Type: Optional</synopsis>
269
270            <para>If set to yes, run ${autoconf.cmd}.</para>
271
272            <para><userinput>use_autoconf yes</userinput></para>
273
274          </listitem>
275        </varlistentry>
276
277        <varlistentry>
278          <term>autoconf.env</term>
279
280          <listitem>
281            <synopsis>Type: optional</synopsis>
282
283            <para>Environment variables to pass to ${autoconf.cmd}.</para>
284
285            <para><userinput>autoconf.env
286            CFLAGS=-I${prefix}/include/gtk12</userinput></para>
287
288          </listitem>
289        </varlistentry>
290
291        <varlistentry>
292          <term>autoconf.args</term>
293
294          <listitem>
295            <synopsis>Type: optional</synopsis>
296
297            <para>Arguments to pass to ${autoconf.cmd}.</para>
298
299            <para><userinput>autoconf.args -l
300            src/aclocaldir</userinput></para>
301
302          </listitem>
303        </varlistentry>
304
305        <varlistentry>
306          <term>autoconf.dir</term>
307
308          <listitem>
309            <synopsis>Type: optional Default: ${autoconf.dir}</synopsis>
310
311            <para>Directory in which to run ${autoconf.cmd}.</para>
312
313            <para><userinput>autoconf.dir src</userinput></para>
314
315          </listitem>
316        </varlistentry>
317      </variablelist>
318    </sect2>
319   
320    <sect2>
321      <title>Build Options</title>
322
323      <variablelist>
324        <varlistentry>
325          <term>build.cmd</term>
326
327          <listitem>
328            <synopsis>cmdType: optional, Default: make</synopsis>
329
330            <para>Make command to run relative to ${worksrcdir}.</para>
331
332            <para><userinput>build.cmd pbxbuild</userinput></para>
333
334          </listitem>
335        </varlistentry>
336
337        <varlistentry>
338          <term>build.type</term>
339
340          <listitem>
341            <synopsis>Type: optional Default: make</synopsis>
342
343            <para>Defines which 'make' is required, either 'gnu' or 'bsd'
344            Sets build.cmd to either 'gnumake' or 'bsdmake' accordingly</para>
345
346            <para><userinput>build.type bsd</userinput></para>
347
348          </listitem>
349        </varlistentry>
350
351        <varlistentry>
352          <term>build.pre_args</term>
353
354          <listitem>
355            <synopsis>Type: read-only Default: ${build.target}</synopsis>
356
357            <para>Arguments to pass to ${build.cmd} before ${build.args}.</para>
358          </listitem>
359        </varlistentry>
360
361        <varlistentry>
362          <term>build.args</term>
363
364          <listitem>
365            <synopsis>Type: optional</synopsis>
366
367            <para>Arguments to pass to ${build.cmd}.</para>
368
369            <para><userinput>build.args -DNOWARN</userinput></para>
370
371          </listitem>
372        </varlistentry>
373
374        <varlistentry>
375          <term>build.target</term>
376
377          <listitem>
378            <synopsis>Type: optional Default: all</synopsis>
379
380            <para>Target to pass to make for building everything.</para>
381
382            <para><userinput>build.target all-src</userinput></para>
383
384          </listitem>
385        </varlistentry>
386      </variablelist>
387    </sect2>
388
389    <sect2>
390      <title>Install Options</title>
391
392      <variablelist>
393        <varlistentry>
394          <term>install.cmd</term>
395
396          <listitem>
397            <synopsis>cmdType: optional, Default: ${build.cmd}</synopsis>
398
399            <para>Install command to run relative to ${worksrcdir}.</para>
400
401            <para><userinput>install.cmd pbxbuild</userinput></para>
402
403          </listitem>
404        </varlistentry>
405
406        <varlistentry>
407          <term>install.type</term>
408
409          <listitem>
410            <synopsis>Type: optional Default: ${build.type}</synopsis>
411
412            <para>Defines which 'make' is required, either 'gnu' or 'bsd'
413            Sets build.cmd to either 'gnumake' or 'bsdmake'
414            accordingly. </para>
415
416            <para><userinput>install.type gnu</userinput></para>
417
418          </listitem>
419        </varlistentry>
420
421        <varlistentry>
422          <term>install.pre_args</term>
423
424          <listitem>
425            <synopsis>Type: read-only Default: ${install.target}</synopsis>
426
427            <para>Arguments to pass to ${install.cmd} before
428            ${install.args}.</para>
429           
430          </listitem>
431        </varlistentry>
432
433        <varlistentry>
434          <term>install.args</term>
435
436          <listitem>
437            <synopsis>Type: optional</synopsis>
438
439            <para>Arguments to pass to ${install.cmd}.</para>
440
441            <para><userinput>build.args -DNOWARN</userinput></para>
442
443          </listitem>
444        </varlistentry>
445
446        <varlistentry>
447          <term>install.target</term>
448
449          <listitem>
450            <synopsis>Type: optional Default: install</synopsis>
451
452            <para>Install target to pass to ${install.cmd}.</para>
453
454            <para><userinput>install.target install-src</userinput></para>
455
456          </listitem>
457        </varlistentry>
458
459                <varlistentry>
460          <term>install.destroot</term>
461
462          <listitem>
463            <synopsis>Type: optional Default: DESTDIR='${destroot}'</synopsis>
464
465            <para>Arguement passed to ${install.cmd} to cause port to
466            install via the temporary destroot.</para>
467
468            <para><userinput>install.destroot prefix='${destroot}'
469            </userinput></para>
470
471          </listitem>
472        </varlistentry>
473      </variablelist>
474    </sect2>
475
476    <sect2>
477      <title>Xmkmf Options</title>
478
479      <variablelist>
480        <varlistentry>
481          <term>xmkmf</term>
482
483          <listitem>
484            <synopsis>
485            </synopsis>
486
487            <para>Does nothing.</para>
488          </listitem>
489        </varlistentry>
490      </variablelist>
491    </sect2>
492
493    <sect2>
494      <title>Libtool Options</title>
495
496      <variablelist>
497        <varlistentry>
498          <term>libtool</term>
499
500          <listitem>
501            <synopsis>
502            </synopsis>
503
504            <para>Does nothing.</para>
505          </listitem>
506        </varlistentry>
507      </variablelist>
508    </sect2>
509  </sect1>
510</chapter>
511
512
Note: See TracBrowser for help on using the repository browser.