Google Git
Sign in
eclipse / www.eclipse.org / cbi / ab46e314787d5ac1c195b47be0152d3b05d751a7 / . / maven-plugins / documentation / 1.1.3 / eclipse-dmg-packager / package-dmg-mojo.html
blob: c4bca7f03576ce4230a085bf670d28faf9ea1e94 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2016-01-28
| Rendered using Apache Maven Fluido Skin 1.4
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20160128" />
<meta http-equiv="Content-Language" content="en" />
<title>eclipse-dmg-packager &#x2013; eclipse-dmg-packager:package-dmg</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<a href="https://eclipse.org" id="bannerLeft">
<img src="https://eclipse.org/eclipse.org-common/themes/solstice/public/images/logo/eclipse.png" alt="Eclipse"/>
</a>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-01-28
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.1.3
</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">CBI Maven Plugins</li>
<li>
<a href="../index.html" title="Introduction">
<span class="none"></span>
Introduction</a>
</li>
<li>
<a href="../eclipse-jarsigner-plugin/plugin-info.html" title="Jar Signer">
<span class="none"></span>
Jar Signer</a>
</li>
<li>
<a href="../eclipse-winsigner-plugin/plugin-info.html" title="Windows Exe Signer">
<span class="none"></span>
Windows Exe Signer</a>
</li>
<li>
<a href="../eclipse-macsigner-plugin/plugin-info.html" title="OS X App Signer">
<span class="none"></span>
OS X App Signer</a>
</li>
<li>
<a href="../eclipse-dmg-packager/plugin-info.html" title="OS X DMG Packager">
<span class="none"></span>
OS X DMG Packager</a>
</li>
<li>
<a href="../eclipse-cbi-plugin/plugin-info.html" title="Utilities">
<span class="none"></span>
Utilities</a>
</li>
</ul>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<div class="section">
<h2><a name="eclipse-dmg-packager:package-dmg"></a>eclipse-dmg-packager:package-dmg</h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.cbi.maven.plugins:eclipse-dmg-packager:1.1.3:package-dmg</p>
<p><b>Description</b>:</p>
<div>Create a DMG file from the file specified as argument. This plug-in
requires access to the Eclipse DMG packager web service.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>package</tt>.</li>
</ul>
<div class="section">
<h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#serviceUrl">serviceUrl</a></b></td>
<td><tt>String</tt></td>
<td><tt>1.1.3</tt></td>
<td>The URL for creating DMG files
<p>The signing service return a dmg file of the application passed
as a source.</p><br /><b>Default value is</b>: <tt>http://build.eclipse.org:31338/dmg-packager</tt>.<br /><b>User property is</b>: <tt>cbi.dmgpackager.serviceUrl</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#source">source</a></b></td>
<td><tt>File</tt></td>
<td><tt>1.1.3</tt></td>
<td>An <tt>.tar.gz</tt> or <tt>.zip</tt> file containing a
single OS X application to create the DMG for.<br /></td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#backgroundImage">backgroundImage</a></b></td>
<td><tt>File</tt></td>
<td><tt>1.1.3</tt></td>
<td>A png file for background image for the installer.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#continueOnFail">continueOnFail</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>1.1.3</tt></td>
<td>Whether the build should be stopped if the packaging process fails.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cbi.dmgpackager.continueOnFail</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#dropLinkPosition">dropLinkPosition</a></b></td>
<td><tt>String</tt></td>
<td><tt>1.1.3</tt></td>
<td>Location of the drop link to Applications folder.<br /><b>Default value is</b>: <tt>375 125</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#eulaFile">eulaFile</a></b></td>
<td><tt>File</tt></td>
<td><tt>1.1.3</tt></td>
<td>File to attach as a license.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#icon">icon</a></b></td>
<td><tt>String</tt></td>
<td><tt>1.1.3</tt></td>
<td>Name of the icon to display and position, e.g., <tt>&quot;Eclipse.app
x y&quot;</tt>. Recommended size 100 125<br /></td>
</tr>
<tr class="a">
<td><b><a href="#iconSize">iconSize</a></b></td>
<td><tt>String</tt></td>
<td><tt>1.1.3</tt></td>
<td>The size of the icon to display in the installer.<br /><b>Default value is</b>: <tt>125</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#skip">skip</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>1.1.3</tt></td>
<td>Skips the execution of this plugin<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cbi.dmgpackager.skip</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#target">target</a></b></td>
<td><tt>File</tt></td>
<td><tt>1.1.3</tt></td>
<td>Where the new DMG file should be saved. If it is not specified, the
file is placed beside <tt>source</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#volumeIcon">volumeIcon</a></b></td>
<td><tt>File</tt></td>
<td><tt>1.1.3</tt></td>
<td>The icns file used for the DMG.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#volumeName">volumeName</a></b></td>
<td><tt>String</tt></td>
<td><tt>1.1.3</tt></td>
<td>The user readable name of the DMG created. It is displayed in the
Finder sidebar and window title.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#windowPosition">windowPosition</a></b></td>
<td><tt>String</tt></td>
<td><tt>1.1.3</tt></td>
<td>The position of the installer window when it opens. Coordinates are
expressed as X Y (e.g. 50 50).<br /><b>Default value is</b>: <tt>50 50</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#windowSize">windowSize</a></b></td>
<td><tt>String</tt></td>
<td><tt>1.1.3</tt></td>
<td>The size of the installer window. Coordinates are expressed as X Y
(e.g. 480 300)<br /><b>Default value is</b>: <tt>480 300</tt>.<br /></td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><b><a name="backgroundImage">backgroundImage</a>:</b></p>
<div>A png file for background image for the installer.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="continueOnFail">continueOnFail</a>:</b></p>
<div>Whether the build should be stopped if the packaging process fails.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>cbi.dmgpackager.continueOnFail</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="dropLinkPosition">dropLinkPosition</a>:</b></p>
<div>Location of the drop link to Applications folder.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>375 125</tt></li>
</ul><hr />
<p><b><a name="eulaFile">eulaFile</a>:</b></p>
<div>File to attach as a license.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="icon">icon</a>:</b></p>
<div>Name of the icon to display and position, e.g., <tt>&quot;Eclipse.app
x y&quot;</tt>. Recommended size 100 125</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="iconSize">iconSize</a>:</b></p>
<div>The size of the icon to display in the installer.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>125</tt></li>
</ul><hr />
<p><b><a name="serviceUrl">serviceUrl</a>:</b></p>
<div>The URL for creating DMG files
<p>The signing service return a dmg file of the application passed
as a source.</p></div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
<li><b>User Property</b>: <tt>cbi.dmgpackager.serviceUrl</tt></li>
<li><b>Default</b>: <tt>http://build.eclipse.org:31338/dmg-packager</tt></li>
</ul><hr />
<p><b><a name="skip">skip</a>:</b></p>
<div>Skips the execution of this plugin</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>cbi.dmgpackager.skip</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="source">source</a>:</b></p>
<div>An <tt>.tar.gz</tt> or <tt>.zip</tt> file containing a
single OS X application to create the DMG for.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
</ul><hr />
<p><b><a name="target">target</a>:</b></p>
<div>Where the new DMG file should be saved. If it is not specified, the
file is placed beside <tt>source</tt>.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="volumeIcon">volumeIcon</a>:</b></p>
<div>The icns file used for the DMG.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="volumeName">volumeName</a>:</b></p>
<div>The user readable name of the DMG created. It is displayed in the
Finder sidebar and window title.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="windowPosition">windowPosition</a>:</b></p>
<div>The position of the installer window when it opens. Coordinates are
expressed as X Y (e.g. 50 50).</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>50 50</tt></li>
</ul><hr />
<p><b><a name="windowSize">windowSize</a>:</b></p>
<div>The size of the installer window. Coordinates are expressed as X Y
(e.g. 480 300)</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>1.1.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>480 300</tt></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p >Copyright &copy; 2016
<a href="http://eclipse.org/">Eclipse Foundation</a>.
All rights reserved.
</p>
</div>
</div>
</footer>
</body>
</html>