| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2015-02-20 |
| | 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="20150220" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Sisu Maven Plugin – sisu:help</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="topBarEnabled"> |
| |
| |
| |
| |
| |
| <div id="topbar" class="navbar navbar-fixed-top "> |
| <div class="navbar-inner"> |
| <div class="container"><div class="nav-collapse"> |
| |
| |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| <li> <a href="index.html" title="Introduction">Introduction</a> |
| </li> |
| |
| <li> <a href="plugin-info.html" title="Goals">Goals</a> |
| </li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| <li class="dropdown-submenu"> |
| <a href="project-info.html" title="Project Information">Project Information</a> |
| <ul class="dropdown-menu"> |
| <li> <a href="index.html" title="About">About</a> |
| </li> |
| <li> <a href="plugin-management.html" title="Plugin Management">Plugin Management</a> |
| </li> |
| <li> <a href="distribution-management.html" title="Distribution Management">Distribution Management</a> |
| </li> |
| <li> <a href="dependency-info.html" title="Dependency Information">Dependency Information</a> |
| </li> |
| <li> <a href="source-repository.html" title="Source Repository">Source Repository</a> |
| </li> |
| <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a> |
| </li> |
| <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> |
| </li> |
| <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a> |
| </li> |
| <li> <a href="plugins.html" title="Project Plugins">Project Plugins</a> |
| </li> |
| <li> <a href="license.html" title="Project License">Project License</a> |
| </li> |
| <li> <a href="team-list.html" title="Project Team">Project Team</a> |
| </li> |
| <li> <a href="project-summary.html" title="Project Summary">Project Summary</a> |
| </li> |
| <li> <a href="dependencies.html" title="Dependencies">Dependencies</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="dropdown-submenu"> |
| <a href="project-reports.html" title="Project Reports">Project Reports</a> |
| <ul class="dropdown-menu"> |
| <li> <a href="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| |
| |
| <ul class="nav pull-right"> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li> <a href="http://eclipse.org/sisu/" title="Sisu">Sisu</a> |
| </li> |
| <li> <a href="http://maven.apache.org/" title="Maven">Maven</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <h2>Sisu 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: 2015-02-20</li> |
| <li class="divider">|</li> <li id="projectVersion">Version: 0.3.0</li> |
| |
| |
| |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| |
| |
| <div class="section"> |
| <h2><a name="sisu:help"></a>sisu:help</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.sisu:sisu-maven-plugin:0.3.0:help</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Display help information on sisu-maven-plugin.<br /> |
| Call <tt>mvn sisu:help -Ddetail=true |
| -Dgoal=<goal-name></tt> to display parameter details.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>The goal is thread-safe and supports parallel builds.</li> |
| </ul> |
| |
| <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><b><a href="#detail">detail</a></b></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>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#goal">goal</a></b></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>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#indentSize">indentSize</a></b></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>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#lineLength">lineLength</a></b></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>.</td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| |
| <p><b><a name="detail">detail</a>:</b></p> |
| |
| <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 /> |
| <p><b><a name="goal">goal</a>:</b></p> |
| |
| <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 /> |
| <p><b><a name="indentSize">indentSize</a>:</b></p> |
| |
| <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 /> |
| <p><b><a name="lineLength">lineLength</a>:</b></p> |
| |
| <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> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row span12">Copyright © 2010-2015 |
| <a href="http://www.eclipse.org/">The Eclipse Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| <p id="poweredBy" class="pull-right"> |
| <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> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |