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

Last change on this file since 1670 was 1670, checked in by landonf (Landon Fuller), 17 years ago

Update documentation to reflect changes to the build.target.* and related options

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