78 lines
2.8 KiB
XML

<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed 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.
*/
-->
<document>
<properties>
<title>Maven NSIS Plug-in</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name="Maven NSIS Plug-in">
<subsection name="Overview of the Maven NSIS Plugin Reference Documentation">
<p>
This plugin is used to generate Win32 installer programs using
<a href="http://nsis.sourceforge.net">NSIS</a>.
</p>
<table>
<tr><th>Document</th><th>Description</th></tr>
<tr><td><a href="process.html">How it works</a></td>
<td>
This describes the process of using this plugin to create an
installation program.
</td>
</tr>
<tr><td><a href="properties.html">Properties</a></td>
<td>
The behavior of this plugin can be altered via
several properties. This document describes each property
available, and the default used.
</td>
</tr>
<tr><td><a href="goals.html">Goals</a></td>
<td>
This plugin provides goals to help in building the installer. This
document describes each goal available.
</td>
</tr>
<tr><td><a href="customizing.html">Customizing the installer</a></td>
<td>
This describes the ways you can customize the generated installer,
e.g. creating shortcuts, add environment variables etc.
</td>
</tr>
</table>
</subsection>
</section>
<section name="Using the NSIS Plugin">
<p>
The plugin creates an installation program from your <code>distribution</code>,
as created by <code>maven dist</code>. The <code>dist</code> goal is usually
run before using the plugin.
</p>
<p>
Once you've run <code>dist</code>, or created your directory with the installation contents,
run the <code>nsis</code> goal. This produces an executable in
<code>${maven.build.dir}/${maven.nsis.final.name}.exe</code>
</p>
</section>
</body>
</document>