src/main/jbake/assets/components/scriptingbundle-maven-plugin/help-mojo.html - sling-site - Git at Google

 <!DOCTYPE html>
 <!--
  | Generated by Apache Maven Doxia Site Renderer 1.9.2 from target/generated-site/xdoc/help-mojo.xml at 2021-09-28
  | Rendered using Apache Maven Fluido Skin 1.9
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
     <title>Scripting Bundle Maven Plugin &#x2013; scriptingbundle:help</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" />
     <link rel="stylesheet" href="./css/site.css" />
     <link rel="stylesheet" href="./css/print.css" media="print" />
     <script src="./js/apache-maven-fluido-1.9.min.js"></script>
   </head>
   <body class="topBarDisabled">
     <a href="https://github.com/apache/sling-scriptingbundle-maven-plugin">
       <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
         src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
         alt="Fork me on GitHub">
     </a>
     <div class="container-fluid">
       <header>
         <div id="banner">
           <div class="pull-left"><a href="https://sling.apache.org/" id="bannerLeft"><img src="https://sling.apache.org/res/logos/sling.svg"  alt="Apache Sling" width="123" height="63"/></a></div>
           <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="https://sling.apache.org/res/logos/apache.png"  alt="Apache"/></a></div>
           <div class="clear"><hr/></div>
         </div>

         <div id="breadcrumbs">
           <ul class="breadcrumb">
       <li class=""><a href="https://sling.apache.org/" class="externalLink" title="Apache Sling">Apache Sling</a><span class="divider">/</span></li>
       <li class=""><a href="https://sling.apache.org/components/" class="externalLink" title="Maven Plugins">Maven Plugins</a><span class="divider">/</span></li>
       <li class=""><a href="index.html" title="Scripting Bundle Maven Plugin">Scripting Bundle Maven Plugin</a><span class="divider">/</span></li>
     <li class="active ">scriptingbundle:help</li>
         <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2021-09-28</li>
           <li id="projectVersion" class="pull-right">Version: 0.5.0</li>
           </ul>
         </div>
       </header>
       <div class="row-fluid">
         <header id="leftColumn" class="span2">
           <nav 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><a href="bnd.html" title="Bnd Plugin"><span class="none"></span>Bnd Plugin</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>
           </nav>
           <div class="well sidebar-nav">
             <hr />
             <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>
         </header>
         <main id="bodyColumn"  class="span10" >


     <section>
 <h2><a name="scriptingbundle:help"></a>scriptingbundle:help</h2>

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

 <p>org.apache.sling:scriptingbundle-maven-plugin:0.5.0:help</p>

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

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

 <p><b>Attributes</b>:</p>
       <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><code><a href="#detail">&lt;detail&gt;</a></code></td>

 <td><code>boolean</code></td>

 <td><code>-</code></td>

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

 <tr class="a">

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

 <td><code>String</code></td>

 <td><code>-</code></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>: <code>goal</code>.<br /></td>
           </tr>

 <tr class="b">

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

 <td><code>int</code></td>

 <td><code>-</code></td>

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

 <tr class="a">

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

 <td><code>int</code></td>

 <td><code>-</code></td>

 <td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <code>80</code>.<br /><b>User property is</b>: <code>lineLength</code>.<br /></td>
           </tr>
         </table>
       </section>
       <section>
 <h3><a name="Parameter_Details"></a>Parameter Details</h3>
         <section>
 <h4><a name="a.3Cdetail.3E"></a><b><a name="detail">&lt;detail&gt;</a></b></h4>

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

 <ul>

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

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

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

 <li><b>Default</b>: <code>false</code></li>
         </ul><hr /></section><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>: <code>java.lang.String</code></li>

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

 <li><b>User Property</b>: <code>goal</code></li>
         </ul><hr /></section><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>: <code>int</code></li>

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

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

 <li><b>Default</b>: <code>2</code></li>
         </ul><hr /></section><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>: <code>int</code></li>

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

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

 <li><b>Default</b>: <code>80</code></li>
         </ul>
       </section></section>
     </section>


         </main>
       </div>
     </div>
     <hr/>
     <footer>
       <div class="container-fluid">
         <div class="row-fluid">
             <p>&#169;      2007&#x2013;2021
 <a href="https://www.apache.org/">The Apache Software Foundation</a>
 </p>
         </div>
       </div>
     </footer>
   </body>
 </html>
	<!DOCTYPE html>
	<!--
	\| Generated by Apache Maven Doxia Site Renderer 1.9.2 from target/generated-site/xdoc/help-mojo.xml at 2021-09-28
	\| Rendered using Apache Maven Fluido Skin 1.9
	-->
	<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
	<head>
	<meta charset="UTF-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1" />
	<meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
	<title>Scripting Bundle Maven Plugin – scriptingbundle:help</title>
	<link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" />
	<link rel="stylesheet" href="./css/site.css" />
	<link rel="stylesheet" href="./css/print.css" media="print" />
	<script src="./js/apache-maven-fluido-1.9.min.js"></script>
	</head>
	<body class="topBarDisabled">
	<a href="https://github.com/apache/sling-scriptingbundle-maven-plugin">
	<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
	src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
	alt="Fork me on GitHub">
	</a>
	<div class="container-fluid">
	<header>
	<div id="banner">
	<div class="pull-left"><a href="https://sling.apache.org/" id="bannerLeft"><img src="https://sling.apache.org/res/logos/sling.svg" alt="Apache Sling" width="123" height="63"/></a></div>
	<div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="https://sling.apache.org/res/logos/apache.png" alt="Apache"/></a></div>
	<div class="clear"><hr/></div>
	</div>

	<div id="breadcrumbs">
	<ul class="breadcrumb">
	<li class=""><a href="https://sling.apache.org/" class="externalLink" title="Apache Sling">Apache Sling</a><span class="divider">/</span></li>
	<li class=""><a href="https://sling.apache.org/components/" class="externalLink" title="Maven Plugins">Maven Plugins</a><span class="divider">/</span></li>
	<li class=""><a href="index.html" title="Scripting Bundle Maven Plugin">Scripting Bundle Maven Plugin</a><span class="divider">/</span></li>
	<li class="active ">scriptingbundle:help</li>
	<li id="publishDate" class="pull-right"><span class="divider">\|</span> Last Published: 2021-09-28</li>
	<li id="projectVersion" class="pull-right">Version: 0.5.0</li>
	</ul>
	</div>
	</header>
	<div class="row-fluid">
	<header id="leftColumn" class="span2">
	<nav 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><a href="bnd.html" title="Bnd Plugin"><span class="none"></span>Bnd Plugin</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>
	</nav>
	<div class="well sidebar-nav">
	<hr />
	<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>
	</header>
	<main id="bodyColumn" class="span10" >


	<section>
	<h2><a name="scriptingbundle:help"></a>scriptingbundle:help</h2>

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

	<p>org.apache.sling:scriptingbundle-maven-plugin:0.5.0:help</p>

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

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

	<p><b>Attributes</b>:</p>
	<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><code><a href="#detail"><detail></a></code></td>

	<td><code>boolean</code></td>

	<td><code>-</code></td>

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

	<tr class="a">

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

	<td><code>String</code></td>

	<td><code>-</code></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>: <code>goal</code>.<br /></td>
	</tr>

	<tr class="b">

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

	<td><code>int</code></td>

	<td><code>-</code></td>

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

	<tr class="a">

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

	<td><code>int</code></td>

	<td><code>-</code></td>

	<td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <code>80</code>.<br /><b>User property is</b>: <code>lineLength</code>.<br /></td>
	</tr>
	</table>
	</section>
	<section>
	<h3><a name="Parameter_Details"></a>Parameter Details</h3>
	<section>
	<h4><a name="a.3Cdetail.3E"></a><b><a name="detail"><detail></a></b></h4>

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

	<ul>

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

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

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

	<li><b>Default</b>: <code>false</code></li>
	</ul><hr /></section><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>: <code>java.lang.String</code></li>

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

	<li><b>User Property</b>: <code>goal</code></li>
	</ul><hr /></section><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>: <code>int</code></li>

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

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

	<li><b>Default</b>: <code>2</code></li>
	</ul><hr /></section><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>: <code>int</code></li>

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

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

	<li><b>Default</b>: <code>80</code></li>
	</ul>
	</section></section>
	</section>


	</main>
	</div>
	</div>
	<hr/>
	<footer>
	<div class="container-fluid">
	<div class="row-fluid">
	<p>© 2007–2021
	<a href="https://www.apache.org/">The Apache Software Foundation</a>
	</p>
	</div>
	</div>
	</footer>
	</body>
	</html>