1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<!-- Documenting T:NAnt.VisualCpp.Tasks.LibTask-->
5
<meta http-equiv="Content-Language" content="en-ca" />
6
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
<link rel="stylesheet" type="text/css" href="../style.css" />
8
<title><lib> Task</title>
11
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
13
<td class="NavBar-Cell">
14
<a href="http://nant.sourceforge.net">
17
<img alt="->" src="../images/arrow.gif" />
18
<a href="../index.html">Help</a>
19
<img alt="->" src="../images/arrow.gif" />
20
<a href="../tasks/index.html">Task Reference</a>
21
<img alt="->" src="../images/arrow.gif" /> <lib></td>
22
<td class="NavBar-Cell" align="right">
27
<p> Run <code>lib.exe</code>, Microsoft's Library Manager. </p>
33
<th style="text-align: center;">Type</th>
35
<th style="text-align: center;">Required</th>
38
<td valign="top" class="required">output</td>
39
<td style="text-align: center;">file</td>
40
<td> The output file. </td>
41
<td style="text-align: center;">True</td>
44
<td valign="top">moduledefinition</td>
45
<td style="text-align: center;">file</td>
46
<td> The module definition file. </td>
47
<td style="text-align: center;">False</td>
50
<td valign="top">options</td>
51
<td style="text-align: center;">string</td>
52
<td> Options to pass to the compiler. </td>
53
<td style="text-align: center;">False</td>
56
<td valign="top">failonerror</td>
57
<td style="text-align: center;">bool</td>
58
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
59
<td style="text-align: center;">False</td>
62
<td valign="top">if</td>
63
<td style="text-align: center;">bool</td>
64
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
65
<td style="text-align: center;">False</td>
68
<td valign="top">timeout</td>
69
<td style="text-align: center;">int</td>
70
<td> The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. </td>
71
<td style="text-align: center;">False</td>
74
<td valign="top">unless</td>
75
<td style="text-align: center;">bool</td>
76
<td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
77
<td style="text-align: center;">False</td>
80
<td valign="top">verbose</td>
81
<td style="text-align: center;">bool</td>
82
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
83
<td style="text-align: center;">False</td>
87
<h3>Framework-configurable parameters</h3>
92
<th style="text-align: center;">Type</th>
94
<th style="text-align: center;">Required</th>
97
<td valign="top">exename</td>
98
<td style="text-align: center;">string</td>
99
<td> The name of the executable that should be used to launch the external program. </td>
100
<td style="text-align: center;">False</td>
103
<td valign="top">managed</td>
104
<td style="text-align: center;">
105
<a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
107
<td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
108
<td style="text-align: center;">False</td>
111
<td valign="top">useruntimeengine</td>
112
<td style="text-align: center;">bool</td>
114
<i>Deprecated.</i> Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
115
<td style="text-align: center;">False</td>
119
<h3>Nested Elements:</h3>
124
<<a href="../types/fileset.html">sources</a>>
126
<div class="nested-element"> The list of files to combine into the output file. <p /></div>
130
</<a href="../types/fileset.html">sources</a>>
138
<div class="nested-element"> Symbols to add to the symbol table. <h5><symbol></h5><div class="nested-element"><p> Represents a symbol. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The name of the symbol. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be processed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be skipped; otherwise, processed. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h5></symbol></h5></div>
139
<h4></symbols></h4>
142
<a id="ignorelibraries">
144
<ignorelibraries>
146
<div class="nested-element"> Names of default libraries to ignore. <h5><library></h5><div class="nested-element"><p> Represents a library. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The name of the library. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be processed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be skipped; otherwise, processed. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h5></library></h5></div>
147
<h4></ignorelibraries></h4>
152
<<a href="../types/fileset.html">libdirs</a>>
154
<div class="nested-element"> The list of additional library directories to search. <p /></div>
158
</<a href="../types/fileset.html">libdirs</a>>
161
<!--NestedElementArray=T:NAnt.Core.Types.Argument-->
167
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><p> When passed to an external application, the argument will be quoted when appropriate. This does not apply to the <code>line</code> parameter, which is always passed as is. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the argument should be passed to the external program. If <b>true</b> then the argument will be passed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;"><path></td><td> The value for a PATH-like command-line argument; you can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the argument should not be passed to the external program. If <b>false</b> then the argument will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
168
<<a href="../types/path.html">path</a>>
169
</h4><div class="nested-element"> Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div><h4><a id="path"></a>
170
</<a href="../types/path.html">path</a>>
171
</h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
172
<arg value="-l -a" />
173
</pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
174
<arg line="-l -a" />
175
</pre></li><li><p> A single command-line argument with the value <code>\dir;\dir2;\dir3</code> on DOS-based systems and <code>/dir:/dir2:/dir3</code> on Unix-like systems. </p><pre class="code">
176
<arg path="/dir;/dir2:\dir3" />
177
</pre></li></ul></div>
184
<ul class="examples">
186
<p>Create a library.</p>
188
<lib output="library.lib">
190
<include name="library.obj" />
196
<h3>Requirements</h3>
197
<div style="margin-left: 20px;">
198
<b>Assembly:</b> NAnt.VisualCppTasks (0.90.3780.0)
b'\\ No newline at end of file'
added
removed
tools/Nant/doc/help/tasks/lib.html
