<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!-- Documenting T:NAnt.DotNet.Tasks.LicenseTask-->
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title><license> Task</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a href="http://nant.sourceforge.net">
<b>NAnt</b>
</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../index.html">Help</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../tasks/index.html">Task Reference</a>
<img alt="->" src="../images/arrow.gif" /> <license></td>
<td class="NavBar-Cell" align="right">
v0.92</td>
</tr>
</table>
<h1><license></h1>
<p> Generates a <code>.licence</code> file from a <code>.licx</code> file. </p>
<p> If no output file is specified, the default filename is the name of the target file with the extension <code>.licenses</code> appended. </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">input</td>
<td style="text-align: center;">file</td>
<td> Input file to process. </td>
<td style="text-align: center;">True</td>
</tr>
<tr>
<td valign="top">licensetarget</td>
<td style="text-align: center;">string</td>
<td>
<i>Deprecated.</i> Specifies the executable for which the .licenses file is generated. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">output</td>
<td style="text-align: center;">file</td>
<td> Name of the license file to output. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">target</td>
<td style="text-align: center;">string</td>
<td> Specifies the executable for which the .licenses file is generated. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td style="text-align: center;">bool</td>
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">if</td>
<td style="text-align: center;">bool</td>
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">timeout</td>
<td style="text-align: center;">int</td>
<td> The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">unless</td>
<td style="text-align: center;">bool</td>
<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>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td style="text-align: center;">bool</td>
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
</div>
<h3>Framework-configurable 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">exename</td>
<td style="text-align: center;">string</td>
<td> The name of the executable that should be used to launch the external program. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">hascommandlinecompiler</td>
<td style="text-align: center;">bool</td>
<td> Indicates whether the current target framework has a command line tool for compiling licenses files. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">managed</td>
<td style="text-align: center;">
<a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
</td>
<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>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">supportsassemblyreferences</td>
<td style="text-align: center;">bool</td>
<td> Indicates whether assembly references are supported by the current target framework. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">useruntimeengine</td>
<td style="text-align: center;">bool</td>
<td>
<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>
<td style="text-align: center;">False</td>
</tr>
</table>
</div>
<h3>Nested Elements:</h3>
<!--Element-->
<h4>
<a id="assemblies">
</a>
<<a href="../types/assemblyfileset.html">assemblies</a>>
</h4>
<div class="nested-element"> Names of the references to scan for the licensed component. <p /></div>
<h4>
<a id="assemblies">
</a>
</<a href="../types/assemblyfileset.html">assemblies</a>>
</h4>
<h3>Examples</h3>
<ul class="examples">
<li>
<p> Generate the file <code>component.exe.licenses</code> file from <code>component.licx</code>. </p>
<pre class="code">
<license input="component.licx" licensetarget="component.exe" />
</pre>
</li>
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.92.4543.0)
</div>
</body>
</html>
