content/builds/3.1.2/openjpa-maven-plugin/help-mojo.html - openjpa-site - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from target/generated-site/xdoc/help-mojo.xml at 06 Sep 2020 22:02 CEST -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
     <title>OpenJPA Maven Plugin &#x2013; openjpa:help</title>
     <style type="text/css" media="all">
       @import url("./css/maven-base.css");
       @import url("./css/maven-theme.css");
       @import url("./css/site.css");
     </style>
     <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
     <meta http-equiv="Content-Language" content="en" />

   </head>
   <body class="composite">
     <div id="banner">
 <div id="bannerLeft">
 OpenJPA
 </div>
       <div class="clear">
         <hr/>
       </div>
     </div>
     <div id="breadcrumbs">
       <div class="xleft">
         <span id="publishDate">Last Published: 06 Sep 2020 22:02 CEST</span>
           &nbsp;| <span id="projectVersion">Version: 3.1.3-SNAPSHOT</span>
       </div>
       <div class="xright">      </div>
       <div class="clear">
         <hr/>
       </div>
     </div>
     <div id="leftColumn">
       <div id="navcolumn">
        <h5>Overview</h5>
     <ul>
      <li class="none"><a href="index.html" title="Introduction">Introduction</a></li>
      <li class="none"><a href="usage.html" title="Usage">Usage</a></li>
      <li class="none"><a href="plugin-info.html" title="Goals">Goals</a></li>
     </ul>
        <h5>Examples</h5>
     <ul>
      <li class="none"><a href="examples/enhance.html" title="Enhance">Enhance</a></li>
      <li class="none"><a href="examples/sql.html" title="SQL">SQL</a></li>
      <li class="none"><a href="examples/schema.html" title="Schema">Schema</a></li>
      <li class="none"><a href="examples/testenhance.html" title="TestEnhance">TestEnhance</a></li>
     </ul>
       <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
         <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
       </a>
       </div>
     </div>
     <div id="bodyColumn">
       <div id="contentBox">


     <div class="section">
 <h2><a name="openjpa:help"></a>openjpa:help</h2>

 <p><b>Full name</b>:</p>

 <p>org.apache.openjpa:openjpa-maven-plugin:3.1.3-SNAPSHOT:help</p>

 <p><b>Description</b>:</p>

 <div>Display help information on openjpa-maven-plugin.<br />
 Call <tt>mvn openjpa:help -Ddetail=true
 -Dgoal=&lt;goal-name&gt;</tt> to display parameter details.</div>

 <p><b>Attributes</b>:</p>

 <div class="section">
 <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>

 <table class="bodyTable" 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="#detail">&lt;detail&gt;</a></tt></td>

 <td><tt>boolean</tt></td>

 <td><tt>-</tt></td>

 <td>If <tt>true</tt>, display all settable properties for each
 goal.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>detail</tt>.<br /></td>
           </tr>

 <tr class="a">

 <td><tt><a href="#goal">&lt;goal&gt;</a></tt></td>

 <td><tt>String</tt></td>

 <td><tt>-</tt></td>

 <td>The name of the goal for which to show help. If unspecified, all
 goals will be displayed.<br /><b>User property is</b>: <tt>goal</tt>.<br /></td>
           </tr>

 <tr class="b">

 <td><tt><a href="#indentSize">&lt;indentSize&gt;</a></tt></td>

 <td><tt>int</tt></td>

 <td><tt>-</tt></td>

 <td>The number of spaces per indentation level, should be positive.<br /><b>Default value is</b>: <tt>2</tt>.<br /><b>User property is</b>: <tt>indentSize</tt>.<br /></td>
           </tr>

 <tr class="a">

 <td><tt><a href="#lineLength">&lt;lineLength&gt;</a></tt></td>

 <td><tt>int</tt></td>

 <td><tt>-</tt></td>

 <td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <tt>80</tt>.<br /><b>User property is</b>: <tt>lineLength</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.3Cdetail.3E"></a><b><a name="detail">&lt;detail&gt;</a></b></h4>

 <div>If <tt>true</tt>, display all settable properties for each
 goal.</div>

 <ul>

 <li><b>Type</b>: <tt>boolean</tt></li>

 <li><b>Required</b>: <tt>No</tt></li>

 <li><b>User Property</b>: <tt>detail</tt></li>

 <li><b>Default</b>: <tt>false</tt></li>
         </ul><hr /></div>
 <div class="section">
 <h4><a name="a.3Cgoal.3E"></a><b><a name="goal">&lt;goal&gt;</a></b></h4>

 <div>The name of the goal for which to show help. If unspecified, all
 goals will be displayed.</div>

 <ul>

 <li><b>Type</b>: <tt>java.lang.String</tt></li>

 <li><b>Required</b>: <tt>No</tt></li>

 <li><b>User Property</b>: <tt>goal</tt></li>
         </ul><hr /></div>
 <div class="section">
 <h4><a name="a.3CindentSize.3E"></a><b><a name="indentSize">&lt;indentSize&gt;</a></b></h4>

 <div>The number of spaces per indentation level, should be positive.</div>

 <ul>

 <li><b>Type</b>: <tt>int</tt></li>

 <li><b>Required</b>: <tt>No</tt></li>

 <li><b>User Property</b>: <tt>indentSize</tt></li>

 <li><b>Default</b>: <tt>2</tt></li>
         </ul><hr /></div>
 <div class="section">
 <h4><a name="a.3ClineLength.3E"></a><b><a name="lineLength">&lt;lineLength&gt;</a></b></h4>

 <div>The maximum length of a display line, should be positive.</div>

 <ul>

 <li><b>Type</b>: <tt>int</tt></li>

 <li><b>Required</b>: <tt>No</tt></li>

 <li><b>User Property</b>: <tt>lineLength</tt></li>

 <li><b>Default</b>: <tt>80</tt></li>
         </ul>
       </div></div>
     </div>


       </div>
     </div>
     <div class="clear">
       <hr/>
     </div>
     <div id="footer">
       <div class="xright">
         Copyright &#169;      2011&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>.
 All rights reserved.      </div>
       <div class="clear">
         <hr/>
       </div>
     </div>
   </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from target/generated-site/xdoc/help-mojo.xml at 06 Sep 2020 22:02 CEST -->
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>OpenJPA Maven Plugin – openjpa:help</title>
	<style type="text/css" media="all">
	@import url("./css/maven-base.css");
	@import url("./css/maven-theme.css");
	@import url("./css/site.css");
	</style>
	<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
	<meta http-equiv="Content-Language" content="en" />

	</head>
	<body class="composite">
	<div id="banner">
	<div id="bannerLeft">
	OpenJPA
	</div>
	<div class="clear">
	<hr/>
	</div>
	</div>
	<div id="breadcrumbs">
	<div class="xleft">
	<span id="publishDate">Last Published: 06 Sep 2020 22:02 CEST</span>
	\| <span id="projectVersion">Version: 3.1.3-SNAPSHOT</span>
	</div>
	<div class="xright"> </div>
	<div class="clear">
	<hr/>
	</div>
	</div>
	<div id="leftColumn">
	<div id="navcolumn">
	<h5>Overview</h5>
	<ul>
	<li class="none"><a href="index.html" title="Introduction">Introduction</a></li>
	<li class="none"><a href="usage.html" title="Usage">Usage</a></li>
	<li class="none"><a href="plugin-info.html" title="Goals">Goals</a></li>
	</ul>
	<h5>Examples</h5>
	<ul>
	<li class="none"><a href="examples/enhance.html" title="Enhance">Enhance</a></li>
	<li class="none"><a href="examples/sql.html" title="SQL">SQL</a></li>
	<li class="none"><a href="examples/schema.html" title="Schema">Schema</a></li>
	<li class="none"><a href="examples/testenhance.html" title="TestEnhance">TestEnhance</a></li>
	</ul>
	<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
	<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
	</a>
	</div>
	</div>
	<div id="bodyColumn">
	<div id="contentBox">


	<div class="section">
	<h2><a name="openjpa:help"></a>openjpa:help</h2>

	<p><b>Full name</b>:</p>

	<p>org.apache.openjpa:openjpa-maven-plugin:3.1.3-SNAPSHOT:help</p>

	<p><b>Description</b>:</p>

	<div>Display help information on openjpa-maven-plugin.<br />
	Call <tt>mvn openjpa:help -Ddetail=true
	-Dgoal=<goal-name></tt> to display parameter details.</div>

	<p><b>Attributes</b>:</p>

	<div class="section">
	<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>

	<table class="bodyTable" 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="#detail"><detail></a></tt></td>

	<td><tt>boolean</tt></td>

	<td><tt>-</tt></td>

	<td>If <tt>true</tt>, display all settable properties for each
	goal.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>detail</tt>.<br /></td>
	</tr>

	<tr class="a">

	<td><tt><a href="#goal"><goal></a></tt></td>

	<td><tt>String</tt></td>

	<td><tt>-</tt></td>

	<td>The name of the goal for which to show help. If unspecified, all
	goals will be displayed.<br /><b>User property is</b>: <tt>goal</tt>.<br /></td>
	</tr>

	<tr class="b">

	<td><tt><a href="#indentSize"><indentSize></a></tt></td>

	<td><tt>int</tt></td>

	<td><tt>-</tt></td>

	<td>The number of spaces per indentation level, should be positive.<br /><b>Default value is</b>: <tt>2</tt>.<br /><b>User property is</b>: <tt>indentSize</tt>.<br /></td>
	</tr>

	<tr class="a">

	<td><tt><a href="#lineLength"><lineLength></a></tt></td>

	<td><tt>int</tt></td>

	<td><tt>-</tt></td>

	<td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <tt>80</tt>.<br /><b>User property is</b>: <tt>lineLength</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.3Cdetail.3E"></a><b><a name="detail"><detail></a></b></h4>

	<div>If <tt>true</tt>, display all settable properties for each
	goal.</div>

	<ul>

	<li><b>Type</b>: <tt>boolean</tt></li>

	<li><b>Required</b>: <tt>No</tt></li>

	<li><b>User Property</b>: <tt>detail</tt></li>

	<li><b>Default</b>: <tt>false</tt></li>
	</ul><hr /></div>
	<div class="section">
	<h4><a name="a.3Cgoal.3E"></a><b><a name="goal"><goal></a></b></h4>

	<div>The name of the goal for which to show help. If unspecified, all
	goals will be displayed.</div>

	<ul>

	<li><b>Type</b>: <tt>java.lang.String</tt></li>

	<li><b>Required</b>: <tt>No</tt></li>

	<li><b>User Property</b>: <tt>goal</tt></li>
	</ul><hr /></div>
	<div class="section">
	<h4><a name="a.3CindentSize.3E"></a><b><a name="indentSize"><indentSize></a></b></h4>

	<div>The number of spaces per indentation level, should be positive.</div>

	<ul>

	<li><b>Type</b>: <tt>int</tt></li>

	<li><b>Required</b>: <tt>No</tt></li>

	<li><b>User Property</b>: <tt>indentSize</tt></li>

	<li><b>Default</b>: <tt>2</tt></li>
	</ul><hr /></div>
	<div class="section">
	<h4><a name="a.3ClineLength.3E"></a><b><a name="lineLength"><lineLength></a></b></h4>

	<div>The maximum length of a display line, should be positive.</div>

	<ul>

	<li><b>Type</b>: <tt>int</tt></li>

	<li><b>Required</b>: <tt>No</tt></li>

	<li><b>User Property</b>: <tt>lineLength</tt></li>

	<li><b>Default</b>: <tt>80</tt></li>
	</ul>
	</div></div>
	</div>


	</div>
	</div>
	<div class="clear">
	<hr/>
	</div>
	<div id="footer">
	<div class="xright">
	Copyright © 2011–2020 <a href="http://www.apache.org">Apache Software Foundation</a>.
	All rights reserved. </div>
	<div class="clear">
	<hr/>
	</div>
	</div>
	</body>
	</html>