source: release-kits/lirk3/resources/gs3-release-maker/apache-ant-1.6.5/docs/manual/OptionalTasks/vbc.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 21.8 KB
Line 
1
2<html>
3<head>
4 <meta http-equiv="Content-Language" content="en-us">
5 <title>Vbc
6 Task</title>
7</head>
8
9<body bgcolor="#ffffff" text="#000000" link="#525D76"
10 alink="#525D76" vlink="#525D76">
11
12<table border="0" width="100%" cellspacing="4">
13
14 <!-- PAGE HEADER -->
15 <tr>
16 <td>
17 <table border="0" width="100%"><tr>
18 <td valign="bottom">
19 <font size="+3" face="arial,helvetica,sanserif"><strong>Vbc
20 Task</strong></font>
21 <br><font face="arial,helvetica,sanserif">This task compiles Visual Basic.NET source into executables or modules. <p>For historical reasons the pattern <code>**/*.vb</code> is preset as includes list and you can not override it with an explicit includes attribute. Use nested <code>&lt;src&gt;</code> elements instead of the basedir attribute if you need more control.</p></font>
22 </td>
23 <td>
24 <!-- PROJECT LOGO -->
25 <a href="http://ant.apache.org/">
26 <img src="../../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0"/>
27 </a>
28 </td>
29 </tr></table>
30 </td>
31 </tr>
32
33 <!-- START RIGHT SIDE MAIN BODY -->
34 <tr>
35 <td valign="top" align="left">
36
37 <!-- Applying task/long-description -->
38 <!-- Start Description -->
39 <table border="0" cellspacing="0" cellpadding="2" width="100%">
40 <tr><td>&nbsp;</td></tr>
41
42 <tr><td bgcolor="#525D76">
43 <font color="#ffffff" face="arial,helvetica.sanserif">
44 <a name="description">
45 <strong>Description</strong></a></font>
46 </td></tr>
47
48 <tr><td><blockquote>
49 This task compiles Visual Basic.NET source into executables or modules. The task requires vbc.exe on the execute path, unless it or an equivalent program is specified in the <tt>executable</tt> parameter <p> All parameters are optional: <code>&lt;vbc/&gt;</code> should suffice to produce a debug build of all *.vb files. <p> The task is a directory based task, so attributes like <tt>includes=&quot;**\/*.vb&quot;</tt> and <tt>excludes=&quot;broken.vb&quot;</tt> can be used to control the files pulled in. By default, all *.vb files from the project folder down are included in the command. When this happens the destFile -if not specified- is taken as the first file in the list, which may be somewhat hard to control. Specifying the output file with <tt>destfile</tt> is prudent. </p> <p> Also, dependency checking only works if destfile is set. As with <code>&lt;csc&gt;</code> nested <tt>src</tt> filesets of source, reference filesets, definitions and resources can be provided. <p> Example </p> <pre>&lt;vbc optimize=&quot;true&quot; debug=&quot;false&quot; warnLevel=&quot;4&quot; targetType=&quot;exe&quot; definitions=&quot;RELEASE&quot; excludes=&quot;src/unicode_class.vb&quot; mainClass = &quot;MainApp&quot; destFile=&quot;NetApp.exe&quot; optionExplicit=&quot;true&quot; optionCompare=&quot;text&quot; references="System.Xml,System.Web.Xml" &gt; &lt;reference file="${testCSC.dll}"/&gt; &lt;define name="RELEASE"/&gt; &lt;define name="DEBUG" if="debug.property"/&gt; &lt;define name="def3" unless="def2.property"/&gt; &lt;/vbc&gt; </pre>
50 </blockquote></td></tr>
51
52 </table>
53 <!-- End Description -->
54
55 <!-- Start Attributes -->
56 <table border="0" cellspacing="0" cellpadding="2" width="100%">
57 <tr><td>&nbsp;</td></tr>
58 <tr><td bgcolor="#525D76">
59 <font color="#ffffff" face="arial,helvetica.sanserif">
60 <a name="attributes">
61 <strong>Parameters</strong></a></font>
62 </td></tr>
63 <tr><td><blockquote>
64 <table>
65 <tr>
66 <td bgcolor="#cccccc" valign="top" align="left">
67 <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font>
68 </td>
69 <td bgcolor="#cccccc" valign="top" align="left">
70 <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font>
71 </td>
72 <td bgcolor="#cccccc" valign="top" align="left">
73 <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font>
74 </td>
75 <td bgcolor="#cccccc" valign="top" align="left">
76 <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font>
77 </td>
78 </tr>
79 <!-- Attribute Group -->
80
81 <!-- Attribute Group -->
82 <!-- Attribute -->
83 <tr>
84 <td bgcolor="#eeeeee" valign="top" align="left">
85 <font color="#000000" size="-1" face="arial,helvetica,sanserif">additionalmodules</font>
86 </td>
87 <td bgcolor="#eeeeee" valign="top" align="left">
88 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Semicolon separated list of modules to refer to.</font>
89 </td>
90 <td bgcolor="#eeeeee" valign="top" align="left">
91 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
92 </td>
93 <td bgcolor="#eeeeee" valign="top" align="left" rowspan="24">
94 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Optional</font>
95 </td>
96 </tr>
97 <!-- Attribute -->
98 <tr>
99 <td bgcolor="#eeeeee" valign="top" align="left">
100 <font color="#000000" size="-1" face="arial,helvetica,sanserif">debug</font>
101 </td>
102 <td bgcolor="#eeeeee" valign="top" align="left">
103 <font color="#000000" size="-1" face="arial,helvetica,sanserif">set the debug flag on or off.</font>
104 </td>
105 <td bgcolor="#eeeeee" valign="top" align="left">
106 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
107 </td>
108 </tr>
109 <!-- Attribute -->
110 <tr>
111 <td bgcolor="#eeeeee" valign="top" align="left">
112 <font color="#000000" size="-1" face="arial,helvetica,sanserif">destdir</font>
113 </td>
114 <td bgcolor="#eeeeee" valign="top" align="left">
115 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the destination directory of files to be compiled.</font>
116 </td>
117 <td bgcolor="#eeeeee" valign="top" align="left">
118 <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
119 </td>
120 </tr>
121 <!-- Attribute -->
122 <tr>
123 <td bgcolor="#eeeeee" valign="top" align="left">
124 <font color="#000000" size="-1" face="arial,helvetica,sanserif">destfile</font>
125 </td>
126 <td bgcolor="#eeeeee" valign="top" align="left">
127 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the name of exe/library to create.</font>
128 </td>
129 <td bgcolor="#eeeeee" valign="top" align="left">
130 <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
131 </td>
132 </tr>
133 <!-- Attribute -->
134 <tr>
135 <td bgcolor="#eeeeee" valign="top" align="left">
136 <font color="#000000" size="-1" face="arial,helvetica,sanserif">executable</font>
137 </td>
138 <td bgcolor="#eeeeee" valign="top" align="left">
139 <font color="#000000" size="-1" face="arial,helvetica,sanserif">set the name of the program, overriding the defaults. Can be used to set the full path to a program, or to switch to an alternate implementation of the command, such as the Mono or Rotor versions -provided they use the same command line arguments as the .NET framework edition</font>
140 </td>
141 <td bgcolor="#eeeeee" valign="top" align="left">
142 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
143 </td>
144 </tr>
145 <!-- Attribute -->
146 <tr>
147 <td bgcolor="#eeeeee" valign="top" align="left">
148 <font color="#000000" size="-1" face="arial,helvetica,sanserif">extraoptions</font>
149 </td>
150 <td bgcolor="#eeeeee" valign="top" align="left">
151 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Any extra options which are not explicitly supported by this task.</font>
152 </td>
153 <td bgcolor="#eeeeee" valign="top" align="left">
154 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
155 </td>
156 </tr>
157 <!-- Attribute -->
158 <tr>
159 <td bgcolor="#eeeeee" valign="top" align="left">
160 <font color="#000000" size="-1" face="arial,helvetica,sanserif">failonerror</font>
161 </td>
162 <td bgcolor="#eeeeee" valign="top" align="left">
163 <font color="#000000" size="-1" face="arial,helvetica,sanserif">If true, fail on compilation errors.</font>
164 </td>
165 <td bgcolor="#eeeeee" valign="top" align="left">
166 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
167 </td>
168 </tr>
169 <!-- Attribute -->
170 <tr>
171 <td bgcolor="#eeeeee" valign="top" align="left">
172 <font color="#000000" size="-1" face="arial,helvetica,sanserif">imports</font>
173 </td>
174 <td bgcolor="#eeeeee" valign="top" align="left">
175 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Declare global imports for namespaces in referenced metadata files.</font>
176 </td>
177 <td bgcolor="#eeeeee" valign="top" align="left">
178 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
179 </td>
180 </tr>
181 <!-- Attribute -->
182 <tr>
183 <td bgcolor="#eeeeee" valign="top" align="left">
184 <font color="#000000" size="-1" face="arial,helvetica,sanserif">includedefaultreferences</font>
185 </td>
186 <td bgcolor="#eeeeee" valign="top" align="left">
187 <font color="#000000" size="-1" face="arial,helvetica,sanserif">If true, automatically includes the common assemblies in dotnet, and tells the compiler to link in mscore.dll. set the automatic reference inclusion flag on or off this flag controls the /nostdlib option in CSC</font>
188 </td>
189 <td bgcolor="#eeeeee" valign="top" align="left">
190 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
191 </td>
192 </tr>
193 <!-- Attribute -->
194 <tr>
195 <td bgcolor="#eeeeee" valign="top" align="left">
196 <font color="#000000" size="-1" face="arial,helvetica,sanserif">mainclass</font>
197 </td>
198 <td bgcolor="#eeeeee" valign="top" align="left">
199 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the name of main class for executables.</font>
200 </td>
201 <td bgcolor="#eeeeee" valign="top" align="left">
202 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
203 </td>
204 </tr>
205 <!-- Attribute -->
206 <tr>
207 <td bgcolor="#eeeeee" valign="top" align="left">
208 <font color="#000000" size="-1" face="arial,helvetica,sanserif">optimize</font>
209 </td>
210 <td bgcolor="#eeeeee" valign="top" align="left">
211 <font color="#000000" size="-1" face="arial,helvetica,sanserif">If true, enables optimization flag.</font>
212 </td>
213 <td bgcolor="#eeeeee" valign="top" align="left">
214 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
215 </td>
216 </tr>
217 <!-- Attribute -->
218 <tr>
219 <td bgcolor="#eeeeee" valign="top" align="left">
220 <font color="#000000" size="-1" face="arial,helvetica,sanserif">optioncompare</font>
221 </td>
222 <td bgcolor="#eeeeee" valign="top" align="left">
223 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Specify binary- or text-style string comparisons. Defaults to "binary"</font>
224 </td>
225 <td bgcolor="#eeeeee" valign="top" align="left">
226 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
227 </td>
228 </tr>
229 <!-- Attribute -->
230 <tr>
231 <td bgcolor="#eeeeee" valign="top" align="left">
232 <font color="#000000" size="-1" face="arial,helvetica,sanserif">optionexplicit</font>
233 </td>
234 <td bgcolor="#eeeeee" valign="top" align="left">
235 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Whether to require explicit declaration of variables.</font>
236 </td>
237 <td bgcolor="#eeeeee" valign="top" align="left">
238 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
239 </td>
240 </tr>
241 <!-- Attribute -->
242 <tr>
243 <td bgcolor="#eeeeee" valign="top" align="left">
244 <font color="#000000" size="-1" face="arial,helvetica,sanserif">optionstrict</font>
245 </td>
246 <td bgcolor="#eeeeee" valign="top" align="left">
247 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Enforce strict language semantics.</font>
248 </td>
249 <td bgcolor="#eeeeee" valign="top" align="left">
250 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
251 </td>
252 </tr>
253 <!-- Attribute -->
254 <tr>
255 <td bgcolor="#eeeeee" valign="top" align="left">
256 <font color="#000000" size="-1" face="arial,helvetica,sanserif">referencefiles</font>
257 </td>
258 <td bgcolor="#eeeeee" valign="top" align="left">
259 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Path of references to include. Wildcards should work.</font>
260 </td>
261 <td bgcolor="#eeeeee" valign="top" align="left">
262 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Path</font>
263 </td>
264 </tr>
265 <!-- Attribute -->
266 <tr>
267 <td bgcolor="#eeeeee" valign="top" align="left">
268 <font color="#000000" size="-1" face="arial,helvetica,sanserif">references</font>
269 </td>
270 <td bgcolor="#eeeeee" valign="top" align="left">
271 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Semicolon separated list of DLLs to refer to.</font>
272 </td>
273 <td bgcolor="#eeeeee" valign="top" align="left">
274 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
275 </td>
276 </tr>
277 <!-- Attribute -->
278 <tr>
279 <td bgcolor="#eeeeee" valign="top" align="left">
280 <font color="#000000" size="-1" face="arial,helvetica,sanserif">removeintchecks</font>
281 </td>
282 <td bgcolor="#eeeeee" valign="top" align="left">
283 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Whether to remove integer checks. Default false.</font>
284 </td>
285 <td bgcolor="#eeeeee" valign="top" align="left">
286 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
287 </td>
288 </tr>
289 <!-- Attribute -->
290 <tr>
291 <td bgcolor="#eeeeee" valign="top" align="left">
292 <font color="#000000" size="-1" face="arial,helvetica,sanserif">rootnamespace</font>
293 </td>
294 <td bgcolor="#eeeeee" valign="top" align="left">
295 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Specifies the root namespace for all type declarations.</font>
296 </td>
297 <td bgcolor="#eeeeee" valign="top" align="left">
298 <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
299 </td>
300 </tr>
301 <!-- Attribute -->
302 <tr>
303 <td bgcolor="#eeeeee" valign="top" align="left">
304 <font color="#000000" size="-1" face="arial,helvetica,sanserif">srcdir</font>
305 </td>
306 <td bgcolor="#eeeeee" valign="top" align="left">
307 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the source directory of the files to be compiled.</font>
308 </td>
309 <td bgcolor="#eeeeee" valign="top" align="left">
310 <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
311 </td>
312 </tr>
313 <!-- Attribute -->
314 <tr>
315 <td bgcolor="#eeeeee" valign="top" align="left">
316 <font color="#000000" size="-1" face="arial,helvetica,sanserif">targettype</font>
317 </td>
318 <td bgcolor="#eeeeee" valign="top" align="left">
319 <font color="#000000" size="-1" face="arial,helvetica,sanserif">set the target type to one of exe|library|module|winexe</font>
320 </td>
321 <td bgcolor="#eeeeee" valign="top" align="left">
322 <font color="#000000" size="-1" face="arial,helvetica,sanserif">"exe", "library", "module", "winexe"</font>
323 </td>
324 </tr>
325 <!-- Attribute -->
326 <tr>
327 <td bgcolor="#eeeeee" valign="top" align="left">
328 <font color="#000000" size="-1" face="arial,helvetica,sanserif">utf8output</font>
329 </td>
330 <td bgcolor="#eeeeee" valign="top" align="left">
331 <font color="#000000" size="-1" face="arial,helvetica,sanserif">If true, require all compiler output to be in UTF8 format.</font>
332 </td>
333 <td bgcolor="#eeeeee" valign="top" align="left">
334 <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
335 </td>
336 </tr>
337 <!-- Attribute -->
338 <tr>
339 <td bgcolor="#eeeeee" valign="top" align="left">
340 <font color="#000000" size="-1" face="arial,helvetica,sanserif">warnlevel</font>
341 </td>
342 <td bgcolor="#eeeeee" valign="top" align="left">
343 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Level of warning currently between 1 and 4 with 4 being the strictest.</font>
344 </td>
345 <td bgcolor="#eeeeee" valign="top" align="left">
346 <font color="#000000" size="-1" face="arial,helvetica,sanserif">int</font>
347 </td>
348 </tr>
349 <!-- Attribute -->
350 <tr>
351 <td bgcolor="#eeeeee" valign="top" align="left">
352 <font color="#000000" size="-1" face="arial,helvetica,sanserif">win32icon</font>
353 </td>
354 <td bgcolor="#eeeeee" valign="top" align="left">
355 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the filename of icon to include.</font>
356 </td>
357 <td bgcolor="#eeeeee" valign="top" align="left">
358 <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
359 </td>
360 </tr>
361 <!-- Attribute -->
362 <tr>
363 <td bgcolor="#eeeeee" valign="top" align="left">
364 <font color="#000000" size="-1" face="arial,helvetica,sanserif">win32res</font>
365 </td>
366 <td bgcolor="#eeeeee" valign="top" align="left">
367 <font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the filename of a win32 resource (.RES) file to include. This is not a .NET resource, but what Windows is used to.</font>
368 </td>
369 <td bgcolor="#eeeeee" valign="top" align="left">
370 <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
371 </td>
372 </tr>
373
374
375 </table>
376 </blockquote></td></tr>
377
378 </table>
379 <!-- End Attributes -->
380
381 <!-- Start Elements -->
382 <table border="0" cellspacing="0" cellpadding="2" width="100%">
383 <tr><td>&nbsp;</td></tr>
384
385 <tr><td bgcolor="#525D76">
386 <font color="#ffffff" face="arial,helvetica.sanserif">
387 <a name="elements">
388 <strong>Parameters as nested elements</strong></a></font>
389 </td></tr>
390
391 <tr><td><blockquote>
392 <!-- Start Element -->
393 <table border="0" cellspacing="0" cellpadding="2" width="100%">
394 <tr><td>&nbsp;</td></tr>
395 <tr><td bgcolor="#828DA6">
396 <font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
397 <strong>define</strong> (org.apache.tools.ant.taskdefs.optional.dotnet.DotnetDefine)</font>
398 </td></tr>
399 <tr><td><blockquote>
400 add a define to the list of definitions
401<short-description><![CDATA[Add a define to the list of definitions.]]></short-description>
402<description>
403 <![CDATA[add a define to the list of definitions]]>
404 </description>
405
406 </blockquote></td></tr>
407 </table>
408 <!-- End Element -->
409 <!-- Start Element -->
410 <table border="0" cellspacing="0" cellpadding="2" width="100%">
411 <tr><td>&nbsp;</td></tr>
412 <tr><td bgcolor="#828DA6">
413 <font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
414 <strong>reference</strong> (org.apache.tools.ant.types.FileSet)</font>
415 </td></tr>
416 <tr><td><blockquote>
417 add a new reference fileset to the compilation
418<short-description><![CDATA[Add a new reference fileset to the compilation.]]></short-description>
419<description>
420 <![CDATA[add a new reference fileset to the compilation]]>
421 </description>
422
423 </blockquote></td></tr>
424 </table>
425 <!-- End Element -->
426 <!-- Start Element -->
427 <table border="0" cellspacing="0" cellpadding="2" width="100%">
428 <tr><td>&nbsp;</td></tr>
429 <tr><td bgcolor="#828DA6">
430 <font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
431 <strong>resource</strong> (org.apache.tools.ant.taskdefs.optional.dotnet.DotnetResource)</font>
432 </td></tr>
433 <tr><td><blockquote>
434 link or embed a resource
435<short-description><![CDATA[Link or embed a resource.]]></short-description>
436<description>
437 <![CDATA[link or embed a resource]]>
438 </description>
439
440 </blockquote></td></tr>
441 </table>
442 <!-- End Element -->
443 <!-- Start Element -->
444 <table border="0" cellspacing="0" cellpadding="2" width="100%">
445 <tr><td>&nbsp;</td></tr>
446 <tr><td bgcolor="#828DA6">
447 <font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
448 <strong>src</strong> (org.apache.tools.ant.types.FileSet)</font>
449 </td></tr>
450 <tr><td><blockquote>
451 add a new source directory to the compile
452<short-description><![CDATA[Add a new source directory to the compile.]]></short-description>
453<description>
454 <![CDATA[add a new source directory to the compile]]>
455 </description>
456
457 </blockquote></td></tr>
458 </table>
459 <!-- End Element -->
460
461 </blockquote></td></tr>
462
463 </table>
464 <!-- End Elements -->
465
466
467 </td>
468 </tr>
469 <!-- END RIGHT SIDE MAIN BODY -->
470
471 <!-- FOOTER SEPARATOR -->
472 <tr>
473 <td>
474 <hr noshade="" size="1"/>
475 </td>
476 </tr>
477
478 <!-- PAGE FOOTER -->
479 <tr>
480 <td>
481 <div align="center"><font color="#525D76" size="-1"><em>
482 Copyright &copy; 2000-2005, The Apache Software Foundation. All Rights Reserved.
483 </em></font></div>
484 </td>
485 </tr>
486
487</table>
488
489</body>
490</html>
Note: See TracBrowser for help on using the repository browser.