content/pages/atr/maven/help-mojo.html - tooling-docs - Git at Google

 <!DOCTYPE html>


 <!--
  | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.2:report at 2026-05-24
  | Rendered using Apache Maven Fluido Skin 2.1.0
 -->
 <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 2.0.0" />
     <title>atr:help – Tooling ATR Maven Plugin</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" />
     <link rel="stylesheet" href="./css/site.css" />
     <link rel="stylesheet" href="./css/print.css" media="print" />
     <script src="./js/apache-maven-fluido-2.1.0.min.js"></script>
   </head>
   <body class="topBarEnabled">
     <header id="topbar" class="navbar navbar-fixed-top ">
       <div class="navbar-inner">
             <div class="container" style="width: 90%;">
               <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
                   <span class="icon-bar"></span>
                   <span class="icon-bar"></span>
                   <span class="icon-bar"></span>
               </a>
           <nav class="nav-collapse">
 <a class="brand" href="https://release-test.apache.org/docs/"><img src="https://release-test.apache.org/static/svg/atr_logo.svg" alt="Apache Tooling ATR Maven Plugin" />
 </a>
             <ul class="nav">
       <li class="dropdown">
         <a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
         <ul class="dropdown-menu">
             <li><a href="index.html">Introduction</a></li>
             <li class="dropdown-submenu">
 <a href="plugin-info.html">Goals</a>
               <ul class="dropdown-menu">
                   <li><a href="check-composing-mojo.html">atr:check-composing</a></li>
                   <li><a href="upload-mojo.html">atr:upload</a></li>
               </ul>
             </li>
             <li><a href="usage.html">Usage</a></li>
             <li><a href="https://www.apache.org/licenses/">License</a></li>
         </ul>
       </li>
       <li class="dropdown">
         <a 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">Project Information</a>
               <ul class="dropdown-menu">
                   <li><a href="ci-management.html">CI Management</a></li>
                   <li><a href="dependencies.html">Dependencies</a></li>
                   <li><a href="issue-management.html">Issue Management</a></li>
                   <li><a href="mailing-lists.html">Mailing Lists</a></li>
                   <li><a href="plugin-management.html">Plugin Management</a></li>
                   <li><a href="plugins.html">Plugins</a></li>
                   <li><a href="scm.html">Source Code Management</a></li>
                   <li><a href="summary.html">Summary</a></li>
                   <li><a href="team.html">Team</a></li>
               </ul>
             </li>
             <li class="dropdown-submenu">
 <a href="project-reports.html">Project Reports</a>
               <ul class="dropdown-menu">
                   <li><a href="plugin-info.html">Plugin Details</a></li>
               </ul>
             </li>
         </ul>
       </li>
             </ul>
           </nav>
           <div class="nav-collapse">
           </div>
         </div>
       </div>
     </header>
     <div class="container container-top">
       <header>
         <div id="banner">
           <div class="pull-left"></div>
           <div class="pull-right"></div>
           <div class="clear"><hr/></div>
         </div>

         <div id="breadcrumbs">
           <ul class="breadcrumb">
       <li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li>
       <li><a href="https://tooling.apache.org/">Tooling</a><span class="divider">/</span></li>
       <li><a href="https://release-test.apache.org/docs/">ATR</a><span class="divider">/</span></li>
       <li><a href="./">Maven Plugin</a><span class="divider">/</span></li>
     <li class="active">atr:help</li>
         <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2026-05-17</li>
           <li id="projectVersion" class="pull-right">Version: 1.0.0-beta-1-SNAPSHOT</li>
           </ul>
         </div>
       </header>
         <main id="bodyColumn">
 <section><a id="atr.3Ahelp"></a>
 <h1>atr:help</h1>
 <p><strong>Full name</strong>:</p>
 <p>org.apache.tooling:atr-maven-plugin:1.0.0-beta-1-SNAPSHOT:help</p>
 <p><strong>Description</strong>:</p>
 <p>Display help information on atr-maven-plugin.
 <br />
  Call <code>mvn atr:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</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><a id="Optional_Parameters"></a>
 <h2>Optional Parameters</h2>
 <table class="table table-striped">
 <tr class="a">
 <th>Name</th>
 <th>Type</th>
 <th>Since</th>
 <th>Description</th></tr>
 <tr class="b">
 <td><a href="#detail"><code>&lt;detail&gt;</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><a href="#goal"><code>&lt;goal&gt;</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><a href="#indentSize"><code>&lt;indentSize&gt;</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><a href="#lineLength"><code>&lt;lineLength&gt;</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><a id="Parameter_Details"></a>
 <h2>Parameter Details</h2><a id="detail"></a><section><a id="a.3Cdetail.3E"></a>
 <h3>&lt;detail&gt;</h3>
 <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 id="goal"></a><section><a id="a.3Cgoal.3E"></a>
 <h3>&lt;goal&gt;</h3>
 <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 id="indentSize"></a><section><a id="a.3CindentSize.3E"></a>
 <h3>&lt;indentSize&gt;</h3>
 <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 id="lineLength"></a><section><a id="a.3ClineLength.3E"></a>
 <h3>&lt;lineLength&gt;</h3>
 <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>        </main>
     </div>
     <hr/>
     <footer>
       <div class="container">
         <div class="row">
             <p>©      2026
 <a href="https://www.apache.org/">The Apache Software Foundation</a>
 </p>
         </div>
         <p id="poweredBy" class="pull-right"><a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
 </p>
       </div>
     </footer>
     <script>
     anchors.add();
     </script>
   </body>
 </html>
	<!DOCTYPE html>


	<!--
	\| Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.2:report at 2026-05-24
	\| Rendered using Apache Maven Fluido Skin 2.1.0
	-->
	<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 2.0.0" />
	<title>atr:help – Tooling ATR Maven Plugin</title>
	<link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" />
	<link rel="stylesheet" href="./css/site.css" />
	<link rel="stylesheet" href="./css/print.css" media="print" />
	<script src="./js/apache-maven-fluido-2.1.0.min.js"></script>
	</head>
	<body class="topBarEnabled">
	<header id="topbar" class="navbar navbar-fixed-top ">
	<div class="navbar-inner">
	<div class="container" style="width: 90%;">
	<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</a>
	<nav class="nav-collapse">
	<a class="brand" href="https://release-test.apache.org/docs/"><img src="https://release-test.apache.org/static/svg/atr_logo.svg" alt="Apache Tooling ATR Maven Plugin" />
	</a>
	<ul class="nav">
	<li class="dropdown">
	<a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="index.html">Introduction</a></li>
	<li class="dropdown-submenu">
	<a href="plugin-info.html">Goals</a>
	<ul class="dropdown-menu">
	<li><a href="check-composing-mojo.html">atr:check-composing</a></li>
	<li><a href="upload-mojo.html">atr:upload</a></li>
	</ul>
	</li>
	<li><a href="usage.html">Usage</a></li>
	<li><a href="https://www.apache.org/licenses/">License</a></li>
	</ul>
	</li>
	<li class="dropdown">
	<a 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">Project Information</a>
	<ul class="dropdown-menu">
	<li><a href="ci-management.html">CI Management</a></li>
	<li><a href="dependencies.html">Dependencies</a></li>
	<li><a href="issue-management.html">Issue Management</a></li>
	<li><a href="mailing-lists.html">Mailing Lists</a></li>
	<li><a href="plugin-management.html">Plugin Management</a></li>
	<li><a href="plugins.html">Plugins</a></li>
	<li><a href="scm.html">Source Code Management</a></li>
	<li><a href="summary.html">Summary</a></li>
	<li><a href="team.html">Team</a></li>
	</ul>
	</li>
	<li class="dropdown-submenu">
	<a href="project-reports.html">Project Reports</a>
	<ul class="dropdown-menu">
	<li><a href="plugin-info.html">Plugin Details</a></li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</nav>
	<div class="nav-collapse">
	</div>
	</div>
	</div>
	</header>
	<div class="container container-top">
	<header>
	<div id="banner">
	<div class="pull-left"></div>
	<div class="pull-right"></div>
	<div class="clear"><hr/></div>
	</div>

	<div id="breadcrumbs">
	<ul class="breadcrumb">
	<li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li>
	<li><a href="https://tooling.apache.org/">Tooling</a><span class="divider">/</span></li>
	<li><a href="https://release-test.apache.org/docs/">ATR</a><span class="divider">/</span></li>
	<li><a href="./">Maven Plugin</a><span class="divider">/</span></li>
	<li class="active">atr:help</li>
	<li id="publishDate" class="pull-right"><span class="divider">\|</span> Last Published: 2026-05-17</li>
	<li id="projectVersion" class="pull-right">Version: 1.0.0-beta-1-SNAPSHOT</li>
	</ul>
	</div>
	</header>
	<main id="bodyColumn">
	<section><a id="atr.3Ahelp"></a>
	<h1>atr:help</h1>
	<p><strong>Full name</strong>:</p>
	<p>org.apache.tooling:atr-maven-plugin:1.0.0-beta-1-SNAPSHOT:help</p>
	<p><strong>Description</strong>:</p>
	<p>Display help information on atr-maven-plugin.
	<br />
	Call <code>mvn atr: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><a id="Optional_Parameters"></a>
	<h2>Optional Parameters</h2>
	<table class="table table-striped">
	<tr class="a">
	<th>Name</th>
	<th>Type</th>
	<th>Since</th>
	<th>Description</th></tr>
	<tr class="b">
	<td><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><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><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><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><a id="Parameter_Details"></a>
	<h2>Parameter Details</h2><a id="detail"></a><section><a id="a.3Cdetail.3E"></a>
	<h3><detail></h3>
	<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 id="goal"></a><section><a id="a.3Cgoal.3E"></a>
	<h3><goal></h3>
	<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 id="indentSize"></a><section><a id="a.3CindentSize.3E"></a>
	<h3><indentSize></h3>
	<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 id="lineLength"></a><section><a id="a.3ClineLength.3E"></a>
	<h3><lineLength></h3>
	<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> </main>
	</div>
	<hr/>
	<footer>
	<div class="container">
	<div class="row">
	<p>© 2026
	<a href="https://www.apache.org/">The Apache Software Foundation</a>
	</p>
	</div>
	<p id="poweredBy" class="pull-right"><a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
	</p>
	</div>
	</footer>
	<script>
	anchors.add();
	</script>
	</body>
	</html>