71590d91c0
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@533617 13f79535-47bb-0310-9956-ffa450edef68
68 lines
2.7 KiB
XML
68 lines
2.7 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* 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.
|
|
*/
|
|
-->
|
|
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven NSIS Plug-in</title>
|
|
<author email="dion@apache.org">dIon Gillard</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="How it works">
|
|
<p>
|
|
The process of creating an installer from your <code>${maven.nsis.build.dir}</code>
|
|
using the plugin is as follows:
|
|
</p>
|
|
<ol>
|
|
<li>
|
|
You, the user invoke the <code>nsis</code>, or <code>nsis:installer</code>
|
|
goal.
|
|
</li>
|
|
<li>
|
|
This calls the <code>nsis:generate-project</code> goal, which creates
|
|
a file, <code>${maven.build.dir}/project.nsh</code>. This file contains
|
|
details from your project.xml file as constants so they are available
|
|
for during the NSIS compilation step. The file is generated from a jelly
|
|
template specified by the <code>${maven.nsis.project.template}</code>
|
|
variable. See the <a href="properties.html">properties</a> documentation
|
|
for more information on the defaults for this variable.
|
|
</li>
|
|
<li>
|
|
Next the <code>nsis:generate-setup</code> goal is called, which creates
|
|
a file, <code>${maven.build.dir}/setup.nsi</code>. This file is later
|
|
the file passed to the NSIS executable compiler, <code>makensis.exe</code>.
|
|
This file is generated from a jelly template specified by the
|
|
<code>${maven.nsis.setup.template}</code> variable. See the
|
|
<a href="properties.html">properties</a> documentation
|
|
for more information on the defaults for this variable.
|
|
</li>
|
|
<li>
|
|
Lastly, <code>makensis.exe</code> is called to compile to generated
|
|
setup.nsi file.
|
|
</li>
|
|
</ol>
|
|
<!--p>
|
|
reference up coming customisation doc here
|
|
</p-->
|
|
</section>
|
|
</body>
|
|
</document>
|