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

Last change on this file since 1102 was 1102, checked in by michaelm, 18 years ago

more guide files

  • Property svn:eol-style set to native
File size: 10.1 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>Type of make required, either 'gnu' or 'bsd'. Sets build.cmd to either 'gnumake' or 'bsdmake' accordingly.</para>
35
36            <para>
37              <userinput>build.type gnu</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.current}</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.all</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 all-src</userinput>
76            </para>
77          </listitem>
78        </varlistentry>
79
80        <varlistentry>
81          <term>build.target.install</term>
82
83          <listitem>
84            <synopsis>Type: optional Default: install</synopsis>
85
86            <para>Install target to pass to ${build.cmd}.</para>
87
88            <para>
89              <userinput>build.target.install install-src</userinput>
90            </para>
91          </listitem>
92        </varlistentry>
93      </variablelist>
94    </sect2>
95
96    <sect2>
97      <title>Configure Options</title>
98
99      <variablelist>
100        <varlistentry>
101          <term>configure.pre_args</term>
102
103          <listitem>
104            <synopsis>Type: optional</synopsis>
105
106            <para>Arguments added to configure command before ${configure.args}.</para>
107
108            <para>
109              <userinput>configure.pre_args --prefix=${prefix}/etc</userinput>
110            </para>
111          </listitem>
112        </varlistentry>
113
114        <varlistentry>
115          <term>configure.args</term>
116
117          <listitem>
118            <synopsis>Type: optional</synopsis>
119
120            <para>Arguments to pass to ${configure.cmd}.</para>
121
122            <para>
123              <userinput>configure.args --etcdir=${prefix}/etc</userinput>
124            </para>
125          </listitem>
126        </varlistentry>
127
128        <varlistentry>
129          <term>configure.dir</term>
130
131          <listitem>
132            <synopsis>Type: optional</synopsis>
133
134            <para>Directory in which to run ${configure-cmd}.</para>
135
136            <para>
137              <userinput>configure.dir src</userinput>
138            </para>
139          </listitem>
140        </varlistentry>
141      </variablelist>
142    </sect2>
143
144    <sect2>
145      <title>Automake Options</title>
146
147      <variablelist>
148        <varlistentry>
149          <term>use_automake</term>
150
151          <listitem>
152            <synopsis>Type: optional Default: ${workpath}/${worksrcdir}</synopsis>
153
154            <para>If set to yes, use ${automake.cmd}.</para>
155
156            <para>
157              <userinput>use_automake yes</userinput>
158            </para>
159          </listitem>
160        </varlistentry>
161
162        <varlistentry>
163          <term>automake.env</term>
164
165          <listitem>
166            <synopsis>Type: optional</synopsis>
167
168            <para>Environmental variables to pass to ${automake.cmd}.</para>
169
170            <para>
171              <userinput>automake.env CFLAGS=-I${prefix}/include/gtk12</userinput>
172            </para>
173          </listitem>
174        </varlistentry>
175
176        <varlistentry>
177          <term>automake.args</term>
178
179          <listitem>
180            <synopsis>Type: optional</synopsis>
181
182            <para>Arguments to pass to ${automake.cmd}.</para>
183
184            <para>
185              <userinput>automake.args --foreign</userinput>
186            </para>
187          </listitem>
188        </varlistentry>
189
190        <varlistentry>
191          <term>automake.dir</term>
192
193          <listitem>
194            <synopsis>Type: optional Default: ${workpath}/${worksrcdir}</synopsis>
195
196            <para>Directory in which to run ${automake.cmd}.</para>
197
198            <para>
199              <userinput>automake.dir src</userinput>
200            </para>
201          </listitem>
202        </varlistentry>
203      </variablelist>
204    </sect2>
205
206    <sect2>
207      <title>Autoconf Options</title>
208
209      <variablelist>
210        <varlistentry>
211          <term>use_autoconf</term>
212
213          <listitem>
214            <synopsis>Type: Optional</synopsis>
215
216            <para>If set to yes, run ${autoconf.cmd}.</para>
217
218            <para>
219              <userinput>use_autoconf yes</userinput>
220            </para>
221          </listitem>
222        </varlistentry>
223
224        <varlistentry>
225          <term>autoconf.env</term>
226
227          <listitem>
228            <synopsis>Type: optional</synopsis>
229
230            <para>Environment variables to pass to ${autoconf.cmd}.</para>
231
232            <para>
233              <userinput>autoconf.env CFLAGS=-I${prefix}/include/gtk12</userinput>
234            </para>
235          </listitem>
236        </varlistentry>
237
238        <varlistentry>
239          <term>autoconf.args</term>
240
241          <listitem>
242            <synopsis>Type: optional</synopsis>
243
244            <para>Arguments to pass to ${autoconf.cmd}.</para>
245
246            <para>
247              <userinput>autoconf.args -l src/aclocaldir</userinput>
248            </para>
249          </listitem>
250        </varlistentry>
251
252        <varlistentry>
253          <term>autoconf.dir</term>
254
255          <listitem>
256            <synopsis>Type: optional Default: ${autoconf.dir}</synopsis>
257
258            <para>Directory in which to run ${autoconf.cmd}.</para>
259
260            <para>
261              <userinput>autoconf.dir src</userinput>
262            </para>
263          </listitem>
264        </varlistentry>
265      </variablelist>
266    </sect2>
267
268    <sect2>
269      <title>Xmkmf Options</title>
270
271      <variablelist>
272        <varlistentry>
273          <term>xmkmf</term>
274
275          <listitem>
276            <synopsis>
277            </synopsis>
278
279            <para>Does nothing.</para>
280          </listitem>
281        </varlistentry>
282      </variablelist>
283    </sect2>
284
285    <sect2>
286      <title>Libtool Options</title>
287
288      <variablelist>
289        <varlistentry>
290          <term>libtool</term>
291
292          <listitem>
293            <synopsis>
294            </synopsis>
295
296            <para>Does nothing.</para>
297          </listitem>
298        </varlistentry>
299      </variablelist>
300    </sect2>
301
302    <sect2>
303      <title>Extract Options</title>
304
305      <variablelist>
306        <varlistentry>
307          <term>extract.only</term>
308
309          <listitem>
310            <synopsis>Type: Optional Default: ${distfiles}</synopsis>
311
312            <para>List of files to extract into ${workpath}.</para>
313
314            <para>
315              <userinput>extract.only worksrc-1.4.4.tar.gz</userinput>
316            </para>
317          </listitem>
318        </varlistentry>
319
320        <varlistentry>
321          <term>extract.cmd</term>
322
323          <listitem>
324            <synopsis>Type: optional Default: gzip</synopsis>
325
326            <para>Command to perform extract.</para>
327
328            <para>
329              <userinput>extract.cmd bzip2</userinput>
330            </para>
331          </listitem>
332        </varlistentry>
333
334        <varlistentry>
335          <term>extract.pre_args</term>
336
337          <listitem>
338            <synopsis>Type: optional Default: -dc</synopsis>
339
340            <para>Arguments added to ${extract.cmd} before a file name.</para>
341
342            <para>
343              <userinput>extract.pre_args -cd</userinput>
344            </para>
345          </listitem>
346        </varlistentry>
347
348        <varlistentry>
349          <term>extract.args</term>
350
351          <listitem>
352            <synopsis>Type: read-only Default: ${distpath}/${distfile}</synopsis>
353
354            <para>Arguments to ${extract.cmd}.</para>
355          </listitem>
356        </varlistentry>
357
358        <varlistentry>
359          <term>extract.post_args</term>
360
361          <listitem>
362            <synopsis>Type: optional Default: | tar -xf -</synopsis>
363
364            <para>Arguments added to extract command after a file name.</para>
365
366            <para>
367              <userinput>extract.post_args | tar -x -s@bladeenc-0.94.2/other_makefiles/BladeEnc..@@p -f -</userinput>
368            </para>
369          </listitem>
370        </varlistentry>
371
372        <varlistentry>
373          <term>extract.sufx</term>
374
375          <listitem>
376            <synopsis>Type: optional Default: .tar.gz</synopsis>
377
378            <para>Suffix to append to ${distname}</para>
379
380            <para>
381              <userinput>extract.sufx .tgz</userinput>
382            </para>
383          </listitem>
384        </varlistentry>
385
386        <varlistentry>
387          <term>use_zip</term>
388
389          <listitem>
390            <synopsis>Type: optional</synopsis>
391
392            <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>
393
394            <para>
395              <userinput>use_zip yes</userinput>
396            </para>
397          </listitem>
398        </varlistentry>
399      </variablelist>
400    </sect2>
401
402    <sect2>
403      <title>CVS Options</title>
404
405      <para>
406      </para>
407    </sect2>
408
409    <sect2>
410      <title>Fetch Options</title>
411
412      <para>
413      </para>
414    </sect2>
415
416    <sect2>
417      <title>Patch Options</title>
418
419      <para>
420      </para>
421    </sect2>
422  </sect1>
423</chapter>
424
425
Note: See TracBrowser for help on using the repository browser.