| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.8 from target/generated-site/xdoc/package-dmg-mojo.xml at 2018-04-12 |
| | Rendered using Apache Maven Fluido Skin 1.7 |
| --> |
| <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="20180412" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>eclipse-dmg-packager – eclipse-dmg-packager:package-dmg</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.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.7.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://www.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: 2018-04-12<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.1.5</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="macOS App Signer"><span class="none"></span>macOS App Signer</a></li> |
| <li><a href="../eclipse-dmg-packager/plugin-info.html" title="macOS DMG Packager"><span class="none"></span>macOS DMG Packager</a></li> |
| <li><a href="../eclipse-flatpak-packager/plugin-info.html" title="Linux Flatpak Packager"><span class="none"></span>Linux Flatpak 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.5: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><tt><a href="#serviceUrl"><serviceUrl></a></tt></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>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#source"><source></a></tt></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><tt><a href="#backgroundImage"><backgroundImage></a></tt></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><tt><a href="#continueOnFail"><continueOnFail></a></tt></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>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#dropLinkPosition"><dropLinkPosition></a></tt></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><tt><a href="#eulaFile"><eulaFile></a></tt></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><tt><a href="#icon"><icon></a></tt></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>"Eclipse.app |
| x y"</tt>. Recommended size 100 125<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#iconSize"><iconSize></a></tt></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><tt><a href="#sign"><sign></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>1.1.4</tt></td> |
| |
| <td>Controls signing of the dmg file<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cbi.dmgpackager.sign</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#skip"><skip></a></tt></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>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#target"><target></a></tt></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="a"> |
| |
| <td><tt><a href="#timeoutMillis"><timeoutMillis></a></tt></td> |
| |
| <td><tt>int</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>Determines the timeout in milliseconds for any communication with |
| the packaging/signing server. A timeout value of zero is |
| interpreted as an infinite timeout.<br /><b>Default value is</b>: <tt>0</tt>.<br /><b>User property is</b>: <tt>cbi.dmgpackager.timeoutMillis</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#volumeIcon"><volumeIcon></a></tt></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><tt><a href="#volumeName"><volumeName></a></tt></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><tt><a href="#windowPosition"><windowPosition></a></tt></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><tt><a href="#windowSize"><windowSize></a></tt></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> |
| |
| <div class="section"> |
| <h4><a name="a.3CbackgroundImage.3E"></a><b><a name="backgroundImage"><backgroundImage></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CcontinueOnFail.3E"></a><b><a name="continueOnFail"><continueOnFail></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CdropLinkPosition.3E"></a><b><a name="dropLinkPosition"><dropLinkPosition></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CeulaFile.3E"></a><b><a name="eulaFile"><eulaFile></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3Cicon.3E"></a><b><a name="icon"><icon></a></b></h4> |
| |
| <div>Name of the icon to display and position, e.g., <tt>"Eclipse.app |
| x y"</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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CiconSize.3E"></a><b><a name="iconSize"><iconSize></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CserviceUrl.3E"></a><b><a name="serviceUrl"><serviceUrl></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3Csign.3E"></a><b><a name="sign"><sign></a></b></h4> |
| |
| <div>Controls signing of the dmg file</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.4</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.dmgpackager.sign</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3Csource.3E"></a><b><a name="source"><source></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3Ctarget.3E"></a><b><a name="target"><target></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CtimeoutMillis.3E"></a><b><a name="timeoutMillis"><timeoutMillis></a></b></h4> |
| |
| <div>Determines the timeout in milliseconds for any communication with |
| the packaging/signing server. A timeout value of zero is |
| interpreted as an infinite timeout.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>int</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.dmgpackager.timeoutMillis</tt></li> |
| |
| <li><b>Default</b>: <tt>0</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CvolumeIcon.3E"></a><b><a name="volumeIcon"><volumeIcon></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CvolumeName.3E"></a><b><a name="volumeName"><volumeName></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CwindowPosition.3E"></a><b><a name="windowPosition"><windowPosition></a></b></h4> |
| |
| <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 /></div> |
| <div class="section"> |
| <h4><a name="a.3CwindowSize.3E"></a><b><a name="windowSize"><windowSize></a></b></h4> |
| |
| <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> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2018 |
| <a href="http://eclipse.org/">Eclipse Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
