blob: 6a9fe6c11a4259501acaf651ea8c18f8361a31c5 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2018-12-17
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<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="20181217" />
<meta http-equiv="Content-Language" content="en" />
<title>Eclipserun Plugin &#x2013; tycho-eclipserun:eclipse-run</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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.3.0.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<h2>Eclipserun Plugin</h2>
</div>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2018-12-17</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.3.0</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Tycho Extras</li>
<li>
<a href="../index.html" title="Introduction">
<i class="none"></i>
Introduction</a>
</li>
<li>
<a href="../tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin">
<i class="none"></i>
P2 Extras Plugin</a>
</li>
<li>
<a href="../target-platform-validation-plugin/plugin-info.html" title="Target Platform Validation Plugin">
<i class="none"></i>
Target Platform Validation Plugin</a>
</li>
<li>
<a href="../tycho-eclipserun-plugin/plugin-info.html" title="Eclipserun Plugin">
<i class="none"></i>
Eclipserun Plugin</a>
</li>
<li>
<a href="../tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin">
<i class="none"></i>
Document Bundle Plugin</a>
</li>
<li>
<a href="../tycho-source-feature-plugin/plugin-info.html" title="Source Feature Generation Plugin">
<i class="none"></i>
Source Feature Generation Plugin</a>
</li>
<li>
<a href="../tycho-pack200/index.html" title="Pack200 Plugins">
<i class="icon-chevron-down"></i>
Pack200 Plugins</a>
<ul class="nav nav-list">
<li>
<a href="../tycho-pack200/tycho-pack200a-plugin/plugin-info.html" title="Normalization Plugin">
<i class="none"></i>
Normalization Plugin</a>
</li>
<li>
<a href="../tycho-pack200/tycho-pack200b-plugin/plugin-info.html" title="Pack Plugin">
<i class="none"></i>
Pack Plugin</a>
</li>
</ul>
</li>
</ul>
<hr class="divider" />
<div id="poweredBy">
<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="span9" >
<div class="section">
<h2><a name="tycho-eclipserun:eclipse-run"></a>tycho-eclipserun:eclipse-run</h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho.extras:tycho-eclipserun-plugin:1.3.0:eclipse-run</p>
<p><b>Description</b>:</p>
<div>Launch an eclipse process with arbitrary commandline arguments. The
eclipse installation is defined by the dependencies to bundles
specified.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</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="#repositories">&lt;repositories&gt;</a></tt></td>
<td><tt>List</tt></td>
<td><tt>-</tt></td>
<td>p2 repositories which will be used to resolve dependencies.
Example:
<div>
<pre>
&lt;repositories&gt;
&lt;repository&gt;
&lt;id&gt;juno&lt;/id&gt;
&lt;layout&gt;p2&lt;/layout&gt;
&lt;url&gt;http://download.eclipse.org/releases/juno&lt;/url&gt;
&lt;/repository&gt;
&lt;/repositories&gt;
</pre></div><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="#addDefaultDependencies">&lt;addDefaultDependencies&gt;</a></tt></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Whether to add default dependencies to bundles
org.eclipse.equinox.launcher, org.eclipse.osgi and
org.eclipse.core.runtime.<br /><b>Default value is</b>: <tt>true</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#appArgLine">&lt;appArgLine&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td><b>Deprecated.</b> use <tt>applicationsArgs</tt> instead.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#applicationsArgs">&lt;applicationsArgs&gt;</a></tt></td>
<td><tt>List</tt></td>
<td><tt>0.24.0</tt></td>
<td>List of applications arguments set on the command line. Example:
<div>
<pre>
&lt;applicationsArgs&gt;
&lt;args&gt;-buildfile&lt;/args&gt;
&lt;args&gt;build-test.xml&lt;/args&gt;
&lt;/applicationsArgs&gt;
</pre></div><br /></td>
</tr>
<tr class="a">
<td><tt><a href="#argLine">&lt;argLine&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td><b>Deprecated.</b> use <tt>jvmArgs</tt> instead.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#dependencies">&lt;dependencies&gt;</a></tt></td>
<td><tt>List</tt></td>
<td><tt>-</tt></td>
<td>Dependencies which will be resolved transitively to make up the
eclipse runtime. Example:
<div>
<pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;artifactId&gt;org.eclipse.ant.core&lt;/artifactId&gt;
&lt;type&gt;eclipse-plugin&lt;/type&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div><br /></td>
</tr>
<tr class="a">
<td><tt><a href="#environmentVariables">&lt;environmentVariables&gt;</a></tt></td>
<td><tt>Map</tt></td>
<td><tt>-</tt></td>
<td>Additional environments to set for the forked JVM.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#executionEnvironment">&lt;executionEnvironment&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Execution environment profile name used to resolve dependencies.<br /><b>Default value is</b>: <tt>JavaSE-1.7</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#forkedProcessTimeoutInSeconds">&lt;forkedProcessTimeoutInSeconds&gt;</a></tt></td>
<td><tt>int</tt></td>
<td><tt>-</tt></td>
<td>Kill the forked process after a certain number of seconds. If set
to 0, wait forever for the process, never timing out.<br /><b>User property is</b>: <tt>eclipserun.timeout</tt>.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#jvmArgs">&lt;jvmArgs&gt;</a></tt></td>
<td><tt>List</tt></td>
<td><tt>0.25.0</tt></td>
<td>List of JVM arguments set on the command line. Example:
<div>
<pre>
&lt;jvmArgs&gt;
&lt;args&gt;-Xdebug&lt;/args&gt;
&lt;args&gt;-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044&lt;/args&gt;
&lt;/jvmArgs&gt;
</pre></div><br /></td>
</tr>
<tr class="a">
<td><tt><a href="#project">&lt;project&gt;</a></tt></td>
<td><tt>MavenProject</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>User property is</b>: <tt>project</tt>.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#skip">&lt;skip&gt;</a></tt></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Whether to skip mojo execution.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>eclipserun.skip</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#work">&lt;work&gt;</a></tt></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/eclipserun-work</tt>.<br /></td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<div class="section">
<h4><a name="aaddDefaultDependencies"></a><b><a name="addDefaultDependencies">&lt;addDefaultDependencies&gt;</a></b></h4>
<div>Whether to add default dependencies to bundles
org.eclipse.equinox.launcher, org.eclipse.osgi and
org.eclipse.core.runtime.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aappArgLine"></a><b><a name="appArgLine">&lt;appArgLine&gt;</a></b></h4>
<div><b>Deprecated.</b> use <tt>applicationsArgs</tt> instead.</div>
<div>Arbitrary applications arguments to set on the command line.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aapplicationsArgs"></a><b><a name="applicationsArgs">&lt;applicationsArgs&gt;</a></b></h4>
<div>List of applications arguments set on the command line. Example:
<div>
<pre>
&lt;applicationsArgs&gt;
&lt;args&gt;-buildfile&lt;/args&gt;
&lt;args&gt;build-test.xml&lt;/args&gt;
&lt;/applicationsArgs&gt;
</pre></div></div>
<ul>
<li><b>Type</b>: <tt>java.util.List</tt></li>
<li><b>Since</b>: <tt>0.24.0</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aargLine"></a><b><a name="argLine">&lt;argLine&gt;</a></b></h4>
<div><b>Deprecated.</b> use <tt>jvmArgs</tt> instead.</div>
<div>Arbitrary JVM options to set on the command line.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="adependencies"></a><b><a name="dependencies">&lt;dependencies&gt;</a></b></h4>
<div>Dependencies which will be resolved transitively to make up the
eclipse runtime. Example:
<div>
<pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;artifactId&gt;org.eclipse.ant.core&lt;/artifactId&gt;
&lt;type&gt;eclipse-plugin&lt;/type&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div></div>
<ul>
<li><b>Type</b>: <tt>java.util.List</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aenvironmentVariables"></a><b><a name="environmentVariables">&lt;environmentVariables&gt;</a></b></h4>
<div>Additional environments to set for the forked JVM.</div>
<ul>
<li><b>Type</b>: <tt>java.util.Map</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aexecutionEnvironment"></a><b><a name="executionEnvironment">&lt;executionEnvironment&gt;</a></b></h4>
<div>Execution environment profile name used to resolve dependencies.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>JavaSE-1.7</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aforkedProcessTimeoutInSeconds"></a><b><a name="forkedProcessTimeoutInSeconds">&lt;forkedProcessTimeoutInSeconds&gt;</a></b></h4>
<div>Kill the forked process after a certain number of seconds. If set
to 0, wait forever for the process, never timing out.</div>
<ul>
<li><b>Type</b>: <tt>int</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>eclipserun.timeout</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="ajvmArgs"></a><b><a name="jvmArgs">&lt;jvmArgs&gt;</a></b></h4>
<div>List of JVM arguments set on the command line. Example:
<div>
<pre>
&lt;jvmArgs&gt;
&lt;args&gt;-Xdebug&lt;/args&gt;
&lt;args&gt;-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044&lt;/args&gt;
&lt;/jvmArgs&gt;
</pre></div></div>
<ul>
<li><b>Type</b>: <tt>java.util.List</tt></li>
<li><b>Since</b>: <tt>0.25.0</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aproject"></a><b><a name="project">&lt;project&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>org.apache.maven.project.MavenProject</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>project</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="arepositories"></a><b><a name="repositories">&lt;repositories&gt;</a></b></h4>
<div>p2 repositories which will be used to resolve dependencies.
Example:
<div>
<pre>
&lt;repositories&gt;
&lt;repository&gt;
&lt;id&gt;juno&lt;/id&gt;
&lt;layout&gt;p2&lt;/layout&gt;
&lt;url&gt;http://download.eclipse.org/releases/juno&lt;/url&gt;
&lt;/repository&gt;
&lt;/repositories&gt;
</pre></div></div>
<ul>
<li><b>Type</b>: <tt>java.util.List</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="askip"></a><b><a name="skip">&lt;skip&gt;</a></b></h4>
<div>Whether to skip mojo execution.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>eclipserun.skip</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="awork"></a><b><a name="work">&lt;work&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/eclipserun-work</tt></li>
</ul>
</div></div>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row span12">Copyright &copy; 2010-2018
<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
All Rights Reserved.
</div>
</div>
</footer>
</body>
</html>