blob: 62bff9ef434acb45970e9f93cb8a123fab7f2185 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2020-07-13
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20200713" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Sling Scripting Bundle Maven Plugin &#x2013; scriptingbundle:help</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.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.6.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h2>Apache Sling Scripting Bundle Maven 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: 2020-07-13<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 0.2.2</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">Overview</li>
<li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a> </li>
<li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a> </li>
<li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a> </li>
<li class="nav-header">Project Documentation</li>
<li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li>
<li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</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="scriptingbundle:help"></a>scriptingbundle:help</h2>
<p><b>Full name</b>:</p>
<p>org.apache.sling:scriptingbundle-maven-plugin:0.2.2:help</p>
<p><b>Description</b>:</p>
<div>Display help information on scriptingbundle-maven-plugin.<br />
Call <tt>mvn scriptingbundle: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="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="#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>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>Copyright &copy;2007&#x2013;2020
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.</p>
</div>
</div>
</footer>
</body>
</html>