| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.12.0:report at 2024-05-07 |
| |
| | Rendered using Apache Maven Default Skin |
| --> |
| <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="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> |
| <title>Apache Rat™ Plugin for Apache Maven – apache-rat:help</title> |
| <link rel="stylesheet" href="./css/maven-base.css" /> |
| <link rel="stylesheet" href="./css/maven-theme.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <link href="https://creadur.apache.org/font/matesc.css" type="text/css" rel="stylesheet" /> |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <a href="https://www.apache.org/" id="bannerLeft"><img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" title="The Apache Software Foundation"/></a> <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| <div class="xleft"> |
| <span id="publishDate">Last Published: 2024-05-07</span> |
| | <span id="projectVersion">Version: 0.17-SNAPSHOT</span> |
| | <a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a> > |
| <a href="https://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a> > |
| <a href="https://creadur.apache.org/rat/" class="externalLink" title="Rat">Rat</a> > |
| <a href="index.html" title="Apache Rat™ Plugin for Apache Maven">Apache Rat™ Plugin for Apache Maven</a> > |
| apache-rat:help |
| </div> |
| <div class="xright"> </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| <h5>Parent Project</h5> |
| <ul> |
| <li class="none"><a href="../index.html" title="Apache Creadur Rat">Apache Creadur Rat</a></li> |
| </ul> |
| <h5>Overview</h5> |
| <ul> |
| <li class="none"><a href="index.html" title="Introduction">Introduction</a></li> |
| <li class="none"><a href="plugin-info.html" title="Goals">Goals</a></li> |
| <li class="none"><a href="usage.html" title="Usage">Usage</a></li> |
| <li class="none"><a href="faq.html" title="FAQ">FAQ</a></li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| <li class="none"><a href="examples/basic.html" title="Basic use">Basic use</a></li> |
| <li class="none"><a href="examples/verify.html" title="Running the plugin automatically">Running the plugin automatically</a></li> |
| <li class="none"><a href="examples/site.html" title="Adding a report to the site">Adding a report to the site</a></li> |
| <li class="none"><a href="examples/custom-license.html" title="Custom license">Custom license</a></li> |
| </ul> |
| <h5>Project Documentation</h5> |
| <ul> |
| <li class="collapsed"><a href="project-info.html" title="Project Information">Project Information</a></li> |
| <li class="collapsed"><a href="project-reports.html" title="Project Reports">Project Reports</a></li> |
| </ul> |
| <h5>Apache Rat™</h5> |
| <ul> |
| <li class="none"><a href="../index.html" title="Introducing Rat">Introducing Rat</a></li> |
| <li class="none"><a href="../apidocs/index.html" title="Javadocs">Javadocs</a></li> |
| <li class="none"><a href="../download_rat.cgi" title="Downloads">Downloads</a></li> |
| <li class="none"><a href="../RELEASE_NOTES.txt" title="Changes">Changes</a></li> |
| </ul> |
| <h5>Running Rat</h5> |
| <ul> |
| <li class="none"><a href="../apache-rat/index.html" title="From The Command Line">From The Command Line</a></li> |
| <li class="none"><a href="../apache-rat-tasks/index.html" title="With Ant">With Ant</a></li> |
| <li class="none"><a href="../apache-rat-plugin/index.html" title="With Maven">With Maven</a></li> |
| </ul> |
| <h5>Apache Creadur™</h5> |
| <ul> |
| <li class="none"><a href="https://creadur.apache.org" class="externalLink" title="Creadur Project Home">Creadur Project Home</a></li> |
| <li class="none"><a href="https://creadur.apache.org/tentacles" class="externalLink" title="Apache Tentacles">Apache Tentacles</a></li> |
| <li class="none"><a href="https://creadur.apache.org/whisker" class="externalLink" title="Apache Whisker">Apache Whisker</a></li> |
| <li class="none"><a href="https://www.apache.org/security/" class="externalLink" title="Security">Security</a></li> |
| <li class="none"><a href="https://www.apache.org/licenses/" class="externalLink" title="License">License</a></li> |
| <li class="none"><a href="https://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Privacy">Privacy</a></li> |
| <li class="none"><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a></li> |
| <li class="none"><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a></li> |
| </ul> |
| <h5>The Apache Software Foundation</h5> |
| <ul> |
| <li class="none"><a href="https://www.apache.org/foundation" class="externalLink" title="About the Foundation">About the Foundation</a></li> |
| <li class="none"><a href="https://projects.apache.org" class="externalLink" title="The projects">The projects</a></li> |
| <li class="none"><a href="https://people.apache.org" class="externalLink" title="The people">The people</a></li> |
| <li class="none"><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How we work">How we work</a></li> |
| <li class="none"><a href="https://www.apache.org/foundation/how-it-works.html#history" class="externalLink" title="Our history">Our history</a></li> |
| <li class="none"><a href="https://blogs.apache.org/foundation/" class="externalLink" title="News">News</a></li> |
| </ul> |
| <h5>Contribute</h5> |
| <ul> |
| <li class="none"><a href="https://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">Get Involved</a></li> |
| </ul> |
| <h5>Committer Info</h5> |
| <ul> |
| <li class="none"><a href="https://www.apache.org/dev/committers.html" class="externalLink" title="ASF Committers' FAQ">ASF Committers' FAQ</a></li> |
| <li class="none"><a href="https://www.apache.org/dev/new-committers-guide.html" class="externalLink" title="New Committers Guide">New Committers Guide</a></li> |
| <li class="none"><a href="../site-publish.html" title="Howto publish this site">Howto publish this site</a></li> |
| <li class="none"><a href="https://community.apache.org/" class="externalLink" title="Community">Community</a></li> |
| <li class="none"><a href="https://www.apache.org/legal/" class="externalLink" title="Legal">Legal</a></li> |
| <li class="none"><a href="https://www.apache.org/foundation/marks/" class="externalLink" title="Branding">Branding</a></li> |
| <li class="none"><a href="https://www.apache.org/press/" class="externalLink" title="Media Relations">Media Relations</a></li> |
| </ul> |
| <a href="https://maven.apache.org/" title="Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> |
| </a> |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| <section> |
| <h2><a name="apache-rat:help"></a>apache-rat:help</h2><a name="apache-rat:help"></a> |
| <p><strong>Full name</strong>:</p> |
| <p>org.apache.rat:apache-rat-plugin:0.17-SNAPSHOT:help</p> |
| <p><strong>Description</strong>:</p> |
| <p>Display help information on apache-rat-plugin. |
| <br /> |
| Call <code>mvn apache-rat:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</p> |
| <p><strong>Attributes</strong>:</p> |
| <ul> |
| <li>The goal is thread-safe and supports parallel builds.</li></ul><section> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> |
| <table border="0" class="bodyTable"> |
| <tr class="a"> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td align="left"><a href="#detail"><code><detail></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>If <code>true</code>, display all settable properties for each goal.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>detail</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#goal"><code><goal></code></a></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 /><strong>User Property</strong>: <code>goal</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#indentSize"><code><indentSize></code></a></td> |
| <td><code>int</code></td> |
| <td><code>-</code></td> |
| <td>The number of spaces per indentation level, should be positive.<br /><strong>Default</strong>: <code>2</code><br /><strong>User Property</strong>: <code>indentSize</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#lineLength"><code><lineLength></code></a></td> |
| <td><code>int</code></td> |
| <td><code>-</code></td> |
| <td>The maximum length of a display line, should be positive.<br /><strong>Default</strong>: <code>80</code><br /><strong>User Property</strong>: <code>lineLength</code></td></tr></table></section><section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="detail"><section> |
| <h4><a name="a.3Cdetail.3E"></a><detail></h4><a name="a.3Cdetail.3E"></a></a> |
| <div>If <code>true</code>, display all settable properties for each goal.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>detail</code></li> |
| <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="goal"><section> |
| <h4><a name="a.3Cgoal.3E"></a><goal></h4><a name="a.3Cgoal.3E"></a></a> |
| <div>The name of the goal for which to show help. If unspecified, all goals will be displayed.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>goal</code></li></ul><hr /></section><a name="indentSize"><section> |
| <h4><a name="a.3CindentSize.3E"></a><indentSize></h4><a name="a.3CindentSize.3E"></a></a> |
| <div>The number of spaces per indentation level, should be positive.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>int</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>indentSize</code></li> |
| <li><strong>Default</strong>: <code>2</code></li></ul><hr /></section><a name="lineLength"><section> |
| <h4><a name="a.3ClineLength.3E"></a><lineLength></h4><a name="a.3ClineLength.3E"></a></a> |
| <div>The maximum length of a display line, should be positive.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>int</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>lineLength</code></li> |
| <li><strong>Default</strong>: <code>80</code></li></ul></section></section></section> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| Copyright © 2016-2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache Rat, Apache Tentacles, Apache Whisker, Apache and the Apache feather logo are trademarks |
| of The Apache Software Foundation. |
| Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
