docs/wix.html - ant-antlibs-dotnet - Git at Google

 <!--
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
 -->
 <html>
   <head>
     <meta http-equiv="Content-Language" content="en-us"></meta>
     <link rel="stylesheet" type="text/css" href="style.css">
     <title>Wix Task</title>
   </head>

   <body>
     <h2>Wix</h2>

     <h3>Description</h3>

     <p>Runs candle or light/lit from the
       <a href="http://wixtoolset.org/">Wix</a> toolset - or
       both of them in sequence.</p>

     <h3>Parameters</h3>
     <table border="1" cellpadding="2" cellspacing="0">
       <tr>
         <td valign="top"><b>Attribute</b></td>
         <td valign="top"><b>Description</b></td>
         <td align="center" valign="top"><b>Required</b></td>
       </tr>
       <tr>
         <td valign="top">source</td>
         <td valign="top">The single source file to process.</td>
         <td align="center">Either this or at least one nested
         &lt;sources&gt; set.</td>
       </tr>
       <tr>
         <td valign="top">target</td>
         <td valign="top">The expected target file.</td>
         <td align="center">Yes, unless you run candle without light.</td>
       </tr>
       <tr>
         <td valign="top">mode</td>
         <td valign="top">Which part of the toolset to run, one of
         &quot;candle&quot;, &quot;light&quot; or
         &quot;both&quot;.</td>
         <td align="center">No, default is &quot;both&quot;.</td>
       </tr>
       <tr>
         <td valign="top">vm</td>
         <td valign="top">Same as <a
             href="dotnetexec.html">dotnetexec</a>'s vm attribute.
           Specify the framework to use.</td>
         <td align="center">No.</td>
       </tr>
       <tr>
         <td valign="top">wixHome</td>
         <td valign="top">Installation directory of WiX.</td>
         <td align="center">No - Ant will assume WiX is on your PATH
         otherwise.</td>
       </tr>
       <tr>
         <td valign="top">wixobjDestDir</td>
         <td valign="top">Directory that shall hold the .wixobj files
           generated by candle.</td>
         <td align="center">No - Ant will candle have its way and use
           the current working directory if omitted.</td>
       </tr>
       <tr>
         <td valign="top">useLit</td>
         <td valign="top">Whether to use lit.exe rather than
           light.exe.  <em>since .NET Antlib 1.1</em></td>
         <td align="center">No, default is &quot;false&quot;.</td>
       </tr>
     </table>

     <h3>Parameters specified as nested elements</h3>

     <h4>sources</h4>

     <p>Specify source files that shall be passed on the command line.
     This is a <a
     href="http://ant.apache.org/manual/CoreTypes/fileset.html">fileset</a>.</p>

     <h4>moresources</h4>

     <p>Specify source files that shall not be passed on the command
     line.  This is a <a
     href="http://ant.apache.org/manual/CoreTypes/fileset.html">fileset</a>.</p>

     <p>Typically this would list include files when running candle or
     the files that become part of the MSI file when running light.</p>

     <p>The files in this set are only used for timestamp comparisons.
     If neither these files nor the given &quot;normal&quot; sources
     are newer than the expected target, the task won't do
     anything.</p>

     <h4>candleParameter</h4>

     <p>Specifies preprocessor parameters for candle</p>

     <p><code>candleParameter</code> has two required attributes.
     name and value that specify name and value of a parameter.</p>

     <h4>candleArg</h4>

     <p>Specifies additional arguments for candle</p>

     <p><code>candleArg</code> is
       a <a href="http://ant.apache.org/manual/using.html#arg">command
         line argument</a>.</p>

     <h4>lightParameter</h4>

     <p>Specifies parameters for light</p>

     <p><code>lightParameter</code> has two required attributes.
     name and value that specify name and value of a parameter.</p>

     <h4>lightArg</h4>

     <p>Specifies additional arguments for light</p>

     <p><code>lightArg</code> is
       a <a href="http://ant.apache.org/manual/using.html#arg">command
         line argument</a>.</p>

     <h3>Examples</h3>

     <p>Create <code>product.wixobj</code> from <code>product.wxs</code>:</p>

     <pre>
       &lt;wix mode="candle" source="product.wxs"/&gt;
     </pre>

     <p>The same but using a nested sources element:</p>

     <pre>
       &lt;wix mode="candle"&gt;
         &lt;sources dir="."&gt;
           &lt;include name="product.wxs"/&gt;
         &lt;/sources&gt;
       &lt;/wix&gt;
     </pre>

     <p>Create <code>product.msi</code> from <code>product.wixobj</code>:</p>

     <pre>
       &lt;wix mode="light" source="product.wixobj" target="product.msi"/&gt;
     </pre>

     <p>Combine the examples into a single step:</p>

     <pre>
       &lt;wix source="product.wxs" target="product.msi"/&gt;
     </pre>

     <p>Note that the task wouldn't do anything if
     <code>product.wxs</code> was older than
     <code>product.wixobj</code> and <code>product.wixobj</code> was
     older than <code>product.msi</code>.</p>

     <p>Compile multiple <code>.wxs</code> files at once:</p>

     <pre>
       &lt;wix mode="candle"&gt;
         &lt;sources dir="."&gt;
           &lt;include name="*.wxs"/&gt;
         &lt;/sources&gt;
       &lt;/wix&gt;
     </pre>

     <p>Compile multiple <code>.wxs</code> files at once, specify some
     include files in addition to that:</p>

     <pre>
       &lt;wix mode="candle"&gt;
         &lt;sources dir="."&gt;
           &lt;include name="*.wxs"/&gt;
         &lt;/sources&gt;
         &lt;moresources dir="."&gt;
           &lt;include name="*.wxi"/&gt;
         &lt;/moresources&gt;
       &lt;/wix&gt;
     </pre>

     <p>Link multiple <code>.wixobj</code> files at once:</p>

     <pre>
       &lt;wix mode="light" target="product.msi"&gt;
         &lt;sources dir="."&gt;
           &lt;include name="*.wixobj"/&gt;
         &lt;/sources&gt;
       &lt;/wix&gt;
     </pre>

     <p>Link multiple <code>.wixobj</code> files at once and specify
     that the files in directory &quot;source&quot; will become part of
     the package:</p>

     <pre>
       &lt;wix mode="light" target="product.msi"&gt;
         &lt;sources dir="."&gt;
           &lt;include name="*.wixobj"/&gt;
         &lt;/sources&gt;
         &lt;moresources dir="source"/&gt;
       &lt;/wix&gt;
     </pre>

     <pre>Combine multiple <code>.wxs</code> files and include files
     into a single package and specify that the package will contain
     files from the source directory:</pre>

     <pre>
       &lt;wix target="product.msi"&gt;
         &lt;sources dir="."&gt;
           &lt;include name="*.wxs"/&gt;
         &lt;/sources&gt;
         &lt;moresources dir="."&gt;
           &lt;include name="*.wxi"/&gt;
         &lt;/moresources&gt;
         &lt;moresources dir="source"/&gt;
       &lt;/wix&gt;
     </pre>

     <p>Again, if the intermediate <code>.wixobj</code> files are newer
     that the corresponding <code>.wxs</code> files (and all include
     files) the candle step will be skipped.  If
     <code>product.msi</code> is newer than all files, the task won't
     do anything.</p>

     <p class="copyright">
       Apache Ant, Apache .NET Ant Library, Ant, .NET Ant Library, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation.
     </p>
   </body>
 </html>
	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<html>
	<head>
	<meta http-equiv="Content-Language" content="en-us"></meta>
	<link rel="stylesheet" type="text/css" href="style.css">
	<title>Wix Task</title>
	</head>

	<body>
	<h2>Wix</h2>

	<h3>Description</h3>

	<p>Runs candle or light/lit from the
	<a href="http://wixtoolset.org/">Wix</a> toolset - or
	both of them in sequence.</p>

	<h3>Parameters</h3>
	<table border="1" cellpadding="2" cellspacing="0">
	<tr>
	<td valign="top"><b>Attribute</b></td>
	<td valign="top"><b>Description</b></td>
	<td align="center" valign="top"><b>Required</b></td>
	</tr>
	<tr>
	<td valign="top">source</td>
	<td valign="top">The single source file to process.</td>
	<td align="center">Either this or at least one nested
	<sources> set.</td>
	</tr>
	<tr>
	<td valign="top">target</td>
	<td valign="top">The expected target file.</td>
	<td align="center">Yes, unless you run candle without light.</td>
	</tr>
	<tr>
	<td valign="top">mode</td>
	<td valign="top">Which part of the toolset to run, one of
	"candle", "light" or
	"both".</td>
	<td align="center">No, default is "both".</td>
	</tr>
	<tr>
	<td valign="top">vm</td>
	<td valign="top">Same as <a
	href="dotnetexec.html">dotnetexec</a>'s vm attribute.
	Specify the framework to use.</td>
	<td align="center">No.</td>
	</tr>
	<tr>
	<td valign="top">wixHome</td>
	<td valign="top">Installation directory of WiX.</td>
	<td align="center">No - Ant will assume WiX is on your PATH
	otherwise.</td>
	</tr>
	<tr>
	<td valign="top">wixobjDestDir</td>
	<td valign="top">Directory that shall hold the .wixobj files
	generated by candle.</td>
	<td align="center">No - Ant will candle have its way and use
	the current working directory if omitted.</td>
	</tr>
	<tr>
	<td valign="top">useLit</td>
	<td valign="top">Whether to use lit.exe rather than
	light.exe. <em>since .NET Antlib 1.1</em></td>
	<td align="center">No, default is "false".</td>
	</tr>
	</table>

	<h3>Parameters specified as nested elements</h3>

	<h4>sources</h4>

	<p>Specify source files that shall be passed on the command line.
	This is a <a
	href="http://ant.apache.org/manual/CoreTypes/fileset.html">fileset</a>.</p>

	<h4>moresources</h4>

	<p>Specify source files that shall not be passed on the command
	line. This is a <a
	href="http://ant.apache.org/manual/CoreTypes/fileset.html">fileset</a>.</p>

	<p>Typically this would list include files when running candle or
	the files that become part of the MSI file when running light.</p>

	<p>The files in this set are only used for timestamp comparisons.
	If neither these files nor the given "normal" sources
	are newer than the expected target, the task won't do
	anything.</p>

	<h4>candleParameter</h4>

	<p>Specifies preprocessor parameters for candle</p>

	<p><code>candleParameter</code> has two required attributes.
	name and value that specify name and value of a parameter.</p>

	<h4>candleArg</h4>

	<p>Specifies additional arguments for candle</p>

	<p><code>candleArg</code> is
	a <a href="http://ant.apache.org/manual/using.html#arg">command
	line argument</a>.</p>

	<h4>lightParameter</h4>

	<p>Specifies parameters for light</p>

	<p><code>lightParameter</code> has two required attributes.
	name and value that specify name and value of a parameter.</p>

	<h4>lightArg</h4>

	<p>Specifies additional arguments for light</p>

	<p><code>lightArg</code> is
	a <a href="http://ant.apache.org/manual/using.html#arg">command
	line argument</a>.</p>

	<h3>Examples</h3>

	<p>Create <code>product.wixobj</code> from <code>product.wxs</code>:</p>

	<pre>
	<wix mode="candle" source="product.wxs"/>
	</pre>

	<p>The same but using a nested sources element:</p>

	<pre>
	<wix mode="candle">
	<sources dir=".">
	<include name="product.wxs"/>
	</sources>
	</wix>
	</pre>

	<p>Create <code>product.msi</code> from <code>product.wixobj</code>:</p>

	<pre>
	<wix mode="light" source="product.wixobj" target="product.msi"/>
	</pre>

	<p>Combine the examples into a single step:</p>

	<pre>
	<wix source="product.wxs" target="product.msi"/>
	</pre>

	<p>Note that the task wouldn't do anything if
	<code>product.wxs</code> was older than
	<code>product.wixobj</code> and <code>product.wixobj</code> was
	older than <code>product.msi</code>.</p>

	<p>Compile multiple <code>.wxs</code> files at once:</p>

	<pre>
	<wix mode="candle">
	<sources dir=".">
	<include name="*.wxs"/>
	</sources>
	</wix>
	</pre>

	<p>Compile multiple <code>.wxs</code> files at once, specify some
	include files in addition to that:</p>

	<pre>
	<wix mode="candle">
	<sources dir=".">
	<include name="*.wxs"/>
	</sources>
	<moresources dir=".">
	<include name="*.wxi"/>
	</moresources>
	</wix>
	</pre>

	<p>Link multiple <code>.wixobj</code> files at once:</p>

	<pre>
	<wix mode="light" target="product.msi">
	<sources dir=".">
	<include name="*.wixobj"/>
	</sources>
	</wix>
	</pre>

	<p>Link multiple <code>.wixobj</code> files at once and specify
	that the files in directory "source" will become part of
	the package:</p>

	<pre>
	<wix mode="light" target="product.msi">
	<sources dir=".">
	<include name="*.wixobj"/>
	</sources>
	<moresources dir="source"/>
	</wix>
	</pre>

	<pre>Combine multiple <code>.wxs</code> files and include files
	into a single package and specify that the package will contain
	files from the source directory:</pre>

	<pre>
	<wix target="product.msi">
	<sources dir=".">
	<include name="*.wxs"/>
	</sources>
	<moresources dir=".">
	<include name="*.wxi"/>
	</moresources>
	<moresources dir="source"/>
	</wix>
	</pre>

	<p>Again, if the intermediate <code>.wixobj</code> files are newer
	that the corresponding <code>.wxs</code> files (and all include
	files) the candle step will be skipped. If
	<code>product.msi</code> is newer than all files, the task won't
	do anything.</p>

	<p class="copyright">
	Apache Ant, Apache .NET Ant Library, Ant, .NET Ant Library, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation.
	</p>
	</body>
	</html>