Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/evaluate-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/evaluate-mojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/evaluate-mojo.html Sun Jun 2 15:20:18 2024 @@ -1,267 +1,196 @@ -<!DOCTYPE html> -<!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/evaluate-mojo.xml at 2023-03-14 - | 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.11.1" /> - <title>Apache Maven Help Plugin – help:evaluate</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"> - <div class="container-fluid"> - <header> - <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Help Plugin"/></a></div> - <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div> - <div class="clear"><hr/></div> - </div> - - <div id="breadcrumbs"> - <ul class="breadcrumb"> - <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> - <li class=""><a href="index.html" title="Apache Maven Help Plugin">Apache Maven Help Plugin</a><span class="divider">/</span></li> - <li class="active ">help:evaluate</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-03-14</li> - <li id="projectVersion" class="pull-right">Version: 3.4.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="icon-chevron-down"></span>Goals</a> - <ul class="nav nav-list"> - <li><a href="active-profiles-mojo.html" title="help:active-profiles"><span class="none"></span>help:active-profiles</a></li> - <li><a href="all-profiles-mojo.html" title="help:all-profiles"><span class="none"></span>help:all-profiles</a></li> - <li><a href="describe-mojo.html" title="help:describe"><span class="none"></span>help:describe</a></li> - <li><a href="effective-pom-mojo.html" title="help:effective-pom"><span class="none"></span>help:effective-pom</a></li> - <li><a href="effective-settings-mojo.html" title="help:effective-settings"><span class="none"></span>help:effective-settings</a></li> - <li class="active"><a href="#"><span class="none"></span>help:evaluate</a></li> - <li><a href="system-mojo.html" title="help:system"><span class="none"></span>help:system</a></li> - <li><a href="help-mojo.html" title="help:help"><span class="none"></span>help:help</a></li> - </ul></li> - <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li> - <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> - <li><a href="https://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> - <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> - <li class="nav-header">Examples</li> - <li><a href="examples/describe-configuration.html" title="Configuring Describe Goal"><span class="none"></span>Configuring Describe Goal</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> - <li class="nav-header">Maven Projects</li> - <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> - <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</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="help:evaluate"></a>help:evaluate</h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.maven.plugins:maven-help-plugin:3.4.0:evaluate</p> - -<p><b>Description</b>:</p> - -<div>Evaluates Maven expressions given by the user in an interactive mode.</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li> - -<li>Since version: <code>2.1</code>.</li> - </ul> - <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 align="left"><code><a href="#artifact"><artifact></a></code></td> - -<td><code>String</code></td> - -<td><code>-</code></td> - -<td>An artifact for evaluating Maven expressions. <br /> <b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The latest version of the artifact will be used when no version is specified.<br /><b>User property is</b>: <code>artifact</code>.<br /></td> - </tr> - -<tr class="a"> - -<td align="left"><code><a href="#expression"><expression></a></code></td> - -<td><code>String</code></td> - -<td><code>-</code></td> - -<td>An expression to evaluate instead of prompting. Note that this <i>must not</i> include the surrounding ${...}.<br /><b>User property is</b>: <code>expression</code>.<br /></td> - </tr> - -<tr class="b"> - -<td align="left"><code><a href="#forceStdout"><forceStdout></a></code></td> - -<td><code>boolean</code></td> - -<td><code>3.1.0</code></td> - -<td>This options gives the option to output information in cases where the output has been suppressed by using <code>-q</code> (quiet option) in Maven. This is useful if you like to use <code>maven-help-plugin:evaluate</code> in a script call (for example in bash) like this: - -<div> -<pre>RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) -echo $RESULT -</pre></div> This will only printout the information which has been requested by <code>expression</code> to <code>stdout</code>.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>forceStdout</code>.<br /></td> - </tr> - -<tr class="a"> - -<td align="left"><code><a href="#output"><output></a></code></td> - -<td><code>File</code></td> - -<td><code>3.0.0</code></td> - -<td>Optional parameter to write the output of this help in a given file, instead of writing to the console. This parameter will be ignored if no <code>expression</code> is specified. <br /> <b>Note</b>: Could be a relative path.<br /><b>User property is</b>: <code>output</code>.<br /></td> - </tr> - </table> - </section> - <section> -<h3><a name="Parameter_Details"></a>Parameter Details</h3> - <section> -<h4><a name="a.3Cartifact.3E"></a><b><a name="artifact"><artifact></a></b></h4> - -<div>An artifact for evaluating Maven expressions. <br /> <b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The latest version of the artifact will be used when no version is specified.</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>artifact</code></li> - </ul><hr /></section><section> -<h4><a name="a.3Cexpression.3E"></a><b><a name="expression"><expression></a></b></h4> - -<div>An expression to evaluate instead of prompting. Note that this <i>must not</i> include the surrounding ${...}.</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>expression</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CforceStdout.3E"></a><b><a name="forceStdout"><forceStdout></a></b></h4> - -<div>This options gives the option to output information in cases where the output has been suppressed by using <code>-q</code> (quiet option) in Maven. This is useful if you like to use <code>maven-help-plugin:evaluate</code> in a script call (for example in bash) like this: - -<div> -<pre>RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) -echo $RESULT -</pre></div> This will only printout the information which has been requested by <code>expression</code> to <code>stdout</code>.</div> - -<ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>3.1.0</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>forceStdout</code></li> - -<li><b>Default</b>: <code>false</code></li> - </ul><hr /></section><section> -<h4><a name="a.3Coutput.3E"></a><b><a name="output"><output></a></b></h4> - -<div>Optional parameter to write the output of this help in a given file, instead of writing to the console. This parameter will be ignored if no <code>expression</code> is specified. <br /> <b>Note</b>: Could be a relative path.</div> - -<ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Since</b>: <code>3.0.0</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>output</code></li> - </ul> - </section></section> - </section> - - - </main> - </div> - </div> - <hr/> - <footer> - <div class="container-fluid"> - <div class="row-fluid"> - <p>© 2001–2023 -<a href="https://www.apache.org/";>The Apache Software Foundation</a> -</p> - </div> - </div> - </footer> - </body> +<!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-06-02 + | 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.11.1" /> + <title>Apache Maven Help Plugin – help:evaluate</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"> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Help Plugin"/></a></div> + <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Apache Maven Help Plugin">Apache Maven Help Plugin</a><span class="divider">/</span></li> + <li class="active ">help:evaluate</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-06-02</li> + <li id="projectVersion" class="pull-right">Version: 3.4.1</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="icon-chevron-down"></span>Goals</a> + <ul class="nav nav-list"> + <li><a href="active-profiles-mojo.html" title="help:active-profiles"><span class="none"></span>help:active-profiles</a></li> + <li><a href="all-profiles-mojo.html" title="help:all-profiles"><span class="none"></span>help:all-profiles</a></li> + <li><a href="describe-mojo.html" title="help:describe"><span class="none"></span>help:describe</a></li> + <li><a href="effective-pom-mojo.html" title="help:effective-pom"><span class="none"></span>help:effective-pom</a></li> + <li><a href="effective-settings-mojo.html" title="help:effective-settings"><span class="none"></span>help:effective-settings</a></li> + <li class="active"><a href="#"><span class="none"></span>help:evaluate</a></li> + <li><a href="system-mojo.html" title="help:system"><span class="none"></span>help:system</a></li> + <li><a href="help-mojo.html" title="help:help"><span class="none"></span>help:help</a></li> + </ul></li> + <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li> + <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li><a href="https://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li class="nav-header">Examples</li> + <li><a href="examples/describe-configuration.html" title="Configuring Describe Goal"><span class="none"></span>Configuring Describe Goal</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> + <li class="nav-header">Maven Projects</li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> + <li><a href="../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> + <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> + <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> + <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> + <li><a href="" title=""><span class="icon-chevron-down"></span></a> + <ul class="nav nav-list"> + <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> + <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> + <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> + <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> + <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> + <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> + <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + </ul></li> + <li class="nav-header">ASF</li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</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="help:evaluate"></a>help:evaluate</h2><a name="help:evaluate"></a> +<p><strong>Full name</strong>:</p> +<p>org.apache.maven.plugins:maven-help-plugin:3.4.1:evaluate</p> +<p><strong>Description</strong>:</p> +<p>Evaluates Maven expressions given by the user in an interactive mode.</p> +<p><strong>Attributes</strong>:</p> +<ul> +<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li> +<li>Since version: <code>2.1</code>.</li></ul><section> +<h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> +<table border="0" class="table table-striped"> +<tr class="a"> +<th>Name</th> +<th>Type</th> +<th>Since</th> +<th>Description</th></tr> +<tr class="b"> +<td align="left"><a href="#artifact"><code><artifact></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>An artifact for evaluating Maven expressions. +<br /><b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The latest version of the artifact will be used when no version is specified.<br /><strong>User Property</strong>: <code>artifact</code></td></tr> +<tr class="a"> +<td align="left"><a href="#expression"><code><expression></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>An expression to evaluate instead of prompting. Note that this <i>must not</i> include the surrounding ${...}.<br /><strong>User Property</strong>: <code>expression</code></td></tr> +<tr class="b"> +<td align="left"><a href="#forceStdout"><code><forceStdout></code></a></td> +<td><code>boolean</code></td> +<td><code>3.1.0</code></td> +<td>This options gives the option to output information in cases where the output has been suppressed by using <code>-q</code> (quiet option) in Maven. This is useful if you like to use <code>maven-help-plugin:evaluate</code> in a script call (for example in bash) like this: +<pre> +RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) +echo $RESULT +</pre> This will only printout the information which has been requested by <code>expression</code> to <code>stdout</code>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>forceStdout</code></td></tr> +<tr class="a"> +<td align="left"><a href="#output"><code><output></code></a></td> +<td><code>File</code></td> +<td><code>3.0.0</code></td> +<td>Optional parameter to write the output of this help in a given file, instead of writing to the console. This parameter will be ignored if no <code>expression</code> is specified. +<br /><b>Note</b>: Could be a relative path.<br /><strong>User Property</strong>: <code>output</code></td></tr></table></section><section> +<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="artifact"><section> +<h4><a name="a.3Cartifact.3E"></a><artifact></h4><a name="a.3Cartifact.3E"></a></a> +<div>An artifact for evaluating Maven expressions. +<br /><b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The latest version of the artifact will be used when no version is specified.</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>artifact</code></li></ul><hr /></section><a name="expression"><section> +<h4><a name="a.3Cexpression.3E"></a><expression></h4><a name="a.3Cexpression.3E"></a></a> +<div>An expression to evaluate instead of prompting. Note that this <i>must not</i> include the surrounding ${...}.</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>expression</code></li></ul><hr /></section><a name="forceStdout"><section> +<h4><a name="a.3CforceStdout.3E"></a><forceStdout></h4><a name="a.3CforceStdout.3E"></a></a> +<div>This options gives the option to output information in cases where the output has been suppressed by using <code>-q</code> (quiet option) in Maven. This is useful if you like to use <code>maven-help-plugin:evaluate</code> in a script call (for example in bash) like this: +<pre> +RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) +echo $RESULT +</pre> This will only printout the information which has been requested by <code>expression</code> to <code>stdout</code>.</div> +<ul> +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>3.1.0</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>forceStdout</code></li> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="output"><section> +<h4><a name="a.3Coutput.3E"></a><output></h4><a name="a.3Coutput.3E"></a></a> +<div>Optional parameter to write the output of this help in a given file, instead of writing to the console. This parameter will be ignored if no <code>expression</code> is specified. +<br /><b>Note</b>: Could be a relative path.</div> +<ul> +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Since</strong>: <code>3.0.0</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>output</code></li></ul></section></section></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>© 2001–2024 +<a href="https://www.apache.org/";>The Apache Software Foundation</a> +</p> + </div> + </div> + </footer> + </body> </html> \ No newline at end of file
Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/examples/describe-configuration.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/examples/describe-configuration.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/examples/describe-configuration.html Sun Jun 2 15:20:18 2024 @@ -1,270 +1,288 @@ -<!DOCTYPE html> -<!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/apt/examples/describe-configuration.apt at 2023-03-14 - | 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.11.1" /> - <meta name="author" content="John Casey -Maria Odea Ching -Vincent Siveton" /> - <meta name="date" content="2010-01-21" /> - <title>Apache Maven Help Plugin – Configuring Describe Goal</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"> - <div class="container-fluid"> - <header> - <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../../images/apache-maven-project.png" alt="Apache Maven Help Plugin"/></a></div> - <div class="pull-right"><a href="../../../" id="bannerRight"><img src="../../../images/maven-logo-black-on-white.png" alt=""/></a></div> - <div class="clear"><hr/></div> - </div> - - <div id="breadcrumbs"> - <ul class="breadcrumb"> - <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li class=""><a href="../../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class=""><a href="../../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> - <li class=""><a href="../index.html" title="Apache Maven Help Plugin">Apache Maven Help Plugin</a><span class="divider">/</span></li> - <li class="active ">Configuring Describe Goal <a href="https://github.com/apache/maven-help-plugin/tree/maven-help-plugin-3.4.0/src/site/apt/examples/describe-configuration.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-03-14</li> - <li id="projectVersion" class="pull-right">Version: 3.4.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="icon-chevron-right"></span>Goals</a></li> - <li><a href="../usage.html" title="Usage"><span class="none"></span>Usage</a></li> - <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> - <li><a href="https://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> - <li><a href="../download.html" title="Download"><span class="none"></span>Download</a></li> - <li class="nav-header">Examples</li> - <li class="active"><a href="#"><span class="none"></span>Configuring Describe Goal</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> - <li class="nav-header">Maven Projects</li> - <li><a href="../../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="../../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> - <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</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="Configuring_Describe_Goal"></a>Configuring Describe Goal</h2> -<p>Below are other configuration examples for the <code><a href="../describe-mojo.html">help:describe</a></code> goal.</p><section> -<h3><a name="The_plugin_Parameter"></a>The <code>plugin</code> Parameter</h3> -<p>The <code>plugin</code> parameter is meant to provide two things: convenience and prefix-based access.</p> -<p>The convenience comes when specifying a plugin by <code>groupId:artifactId</code>, or by <code>groupId:artifactId:version</code>. Where the more traditional specification of separate fields would mean specifying this:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -DgroupId=org.somewhere -DartifactId=some-plugin -Dversion=0.0.0</pre></div> -<p>the use of the plugin parameter allows this:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0</pre></div> -<p>Here is an example to describe the Help plugin:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=org.apache.maven.plugins:maven-help-plugin</pre></div> -<p><b>Note</b>: <code>version</code> is always optional here.</p> -<p>On the other hand, the plugin parameter also offers the option to specify a plugin by its prefix, like this:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help</pre></div></section><section> -<h3><a name="The_goal_Parameter"></a>The <code>goal</code> Parameter</h3> -<p>You can use the <code>goal</code> parameter of the <code>describe</code> goal to show or display relative information about a particular goal of the plugin you specified.</p> -<p>For example, when you execute the following command:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dgoal=describe -DgroupId=org.apache.maven.plugins -DartifactId=maven-help-plugin</pre></div> -<p>This would display brief information about the <code>describe</code> goal only.</p></section><section> -<h3><a name="The_cmd_Parameter"></a>The <code>cmd</code> Parameter</h3> -<p>You could also ask for a single Maven command, i.e. a goal or a phase or a lifecycle. It is the command when you call Maven, i.e.:</p> -<div class="source"><pre class="prettyprint linenums"># mvn -help - -usage: mvn [options] [<goal(s)>] [<phase(s)>] -...</pre></div> -<p>The following are some examples:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dcmd=clean -... -[INFO] [help:describe] -[INFO] 'clean' is a lifecycle with the following phases: -* pre-clean: NOT DEFINED -* clean: org.apache.maven.plugins:maven-clean-plugin:clean -* post-clean: NOT DEFINED -...</pre></div> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dcmd=compile -... -[INFO] [help:describe] -[INFO] 'compile' is a phase corresponding to this plugin: -org.apache.maven.plugins:maven-compiler-plugin:compile - -It is a part of the lifecycle for the POM packaging 'jar'. This lifecycle includes the following phases: -* validate: NOT DEFINED -* initialize: NOT DEFINED -* generate-sources: NOT DEFINED -* process-sources: NOT DEFINED -* generate-resources: NOT DEFINED -* process-resources: org.apache.maven.plugins:maven-resources-plugin:resources -* compile: org.apache.maven.plugins:maven-compiler-plugin:compile -* process-classes: NOT DEFINED -* generate-test-sources: NOT DEFINED -* process-test-sources: NOT DEFINED -* generate-test-resources: NOT DEFINED -* process-test-resources: org.apache.maven.plugins:maven-resources-plugin:testResources -* test-compile: org.apache.maven.plugins:maven-compiler-plugin:testCompile -* process-test-classes: NOT DEFINED -* test: org.apache.maven.plugins:maven-surefire-plugin:test -* package: org.apache.maven.plugins:maven-jar-plugin:jar -* pre-integration-test: NOT DEFINED -* integration-test: NOT DEFINED -* post-integration-test: NOT DEFINED -* verify: NOT DEFINED -* install: org.apache.maven.plugins:maven-install-plugin:install -* deploy: org.apache.maven.plugins:maven-deploy-plugin:deploy -...</pre></div> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dcmd=compiler:compile -... -[INFO] 'compiler:compile' is a plugin goal (aka mojo). -Mojo: 'compiler:compile' -compiler:compile - Description: Compiles application sources - Deprecated. No reason given - -For more information, run 'mvn help:describe [...] -Ddetail' -...</pre></div></section><section> -<h3><a name="The_minimal.2C_and_detail_Parameters"></a>The <code>minimal</code>, and <code>detail</code> Parameters</h3> -<p>If you want to display less or more detailed information, you can use the <code>minimal</code>, or <code>detail</code> parameters.</p> -<p>The <code>minimal</code> parameter adds a minimal list of information:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help -Dminimal=true -... -[INFO] [help:describe] -[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT -Group Id: org.apache.maven.plugins -Artifact Id: maven-help-plugin -Version: 2.1-SNAPSHOT -Goal Prefix: help -Description: The Maven Help plugin provides goals aimed at helping to make - sense out of the build environment. It includes the ability to view the - effective POM and settings files, after inheritance and active profiles have - been applied, as well as a describe a particular plugin goal to give usage - information. - -For more information, run 'mvn help:describe [...] -Ddetail' -...</pre></div> -<p>If you don't provide a paremeter a list is added with the mojos of the plugin and their descriptions:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help -... -[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT -Group Id: org.apache.maven.plugins -Artifact Id: maven-help-plugin -Version: 2.1-SNAPSHOT -Goal Prefix: help -Description: The Maven Help plugin provides goals aimed at helping to make - sense out of the build environment. It includes the ability to view the - effective POM and settings files, after inheritance and active profiles have - been applied, as well as a describe a particular plugin goal to give usage - information. - -This plugin has 9 goals: - -help:active-profiles - Description: Displays a list of the profiles which are currently active for - this build. - Deprecated. No reason given - -help:all-profiles - Description: Displays a list of available profiles under the current - project. - Note: it will list all profiles for a project. If a profile comes up with a - status inactive then there might be a need to set profile activation - switches/property. - Deprecated. No reason given - -help:describe - Description: Displays a list of the attributes for a Maven Plugin and/or - Mojo (Maven plain Old Java Object). - Deprecated. No reason given - -help:effective-pom - Description: Displays the effective POM as an XML for this build, with the - active profiles factored in. - Deprecated. No reason given - -help:effective-settings - Description: Displays the calculated settings as XML for this project, - given any profile enhancement and the inheritance of the global settings - into the user-level settings. - Deprecated. No reason given - -help:evaluate - Description: Evaluates Maven expressions given by the user in an - interactive mode. - Deprecated. No reason given - -help:help - Description: Display help information on maven-help-plugin. - Call - mvn help:help -Ddetail=true -Dgoal=<goal-name> - to display parameter details. - Deprecated. No reason given - -help:system - Description: Displays a list of the platform details like system properties - and environment variables. - Deprecated. No reason given - -For more information, run 'mvn help:describe [...] -Ddetail' -...</pre></div> -<p>The <code>detail</code> parameter also displays information about the goal's implementation, their parameters and component requirements, among others.</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help -Ddetail=true</pre></div></section><section> -<h3><a name="The_output_Parameter"></a>The <code>output</code> Parameter</h3> -<p>This <code>describe</code> goal can use the optional <code>output</code> parameter to redirect the output to a file. Here is an example of that:</p> -<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help -Ddetail=true -Doutput=/path/to/file</pre></div></section></section> - </main> - </div> - </div> - <hr/> - <footer> - <div class="container-fluid"> - <div class="row-fluid"> - <p>© 2001–2023 -<a href="https://www.apache.org/";>The Apache Software Foundation</a> -</p> - </div> - </div> - </footer> - </body> +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src\site\apt/examples\describe-configuration.apt at 2024-06-02 + | 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.11.1" /> + <meta name="author" content="John Casey +Maria Odea Ching +Vincent Siveton" /> + <meta name="date" content="2010-01-21" /> + <title>Apache Maven Help Plugin – Configuring Describe Goal</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"> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../../images/apache-maven-project.png" alt="Apache Maven Help Plugin"/></a></div> + <div class="pull-right"><a href="../../../" id="bannerRight"><img src="../../../images/maven-logo-black-on-white.png" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> + <li class=""><a href="../index.html" title="Apache Maven Help Plugin">Apache Maven Help Plugin</a><span class="divider">/</span></li> + <li class="active ">Configuring Describe Goal <a href="https://github.com/apache/maven-help-plugin/tree/maven-help-plugin-3.4.1/src\site\apt/examples\describe-configuration.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-06-02</li> + <li id="projectVersion" class="pull-right">Version: 3.4.1</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="icon-chevron-right"></span>Goals</a></li> + <li><a href="../usage.html" title="Usage"><span class="none"></span>Usage</a></li> + <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li><a href="https://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> + <li><a href="../download.html" title="Download"><span class="none"></span>Download</a></li> + <li class="nav-header">Examples</li> + <li class="active"><a href="#"><span class="none"></span>Configuring Describe Goal</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> + <li class="nav-header">Maven Projects</li> + <li><a href="../../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> + <li><a href="../../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> + <li><a href="../../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> + <li><a href="../../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> + <li><a href="../../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="../../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> + <li><a href="../" title=""><span class="icon-chevron-down"></span></a> + <ul class="nav nav-list"> + <li><a href="../../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> + <li><a href="../../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> + <li><a href="../../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> + <li><a href="../../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> + <li><a href="../../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> + <li><a href="../../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> + <li><a href="../../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> + <li><a href="../../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> + <li><a href="../../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + </ul></li> + <li class="nav-header">ASF</li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</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="Configuring_Describe_Goal"></a>Configuring Describe Goal</h2> +<p>Below are other configuration examples for the <code><a href="../describe-mojo.html">help:describe</a></code> goal.</p><section> +<h3><a name="The_plugin_Parameter"></a>The <code>plugin</code> Parameter</h3> +<p>The <code>plugin</code> parameter is meant to provide two things: convenience and prefix-based access.</p> +<p>The convenience comes when specifying a plugin by <code>groupId:artifactId</code>, or by <code>groupId:artifactId:version</code>. Where the more traditional specification of separate fields would mean specifying this:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -DgroupId=org.somewhere -DartifactId=some-plugin -Dversion=0.0.0 +</pre></div> +<p>the use of the plugin parameter allows this:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0 +</pre></div> +<p>Here is an example to describe the Help plugin:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=org.apache.maven.plugins:maven-help-plugin +</pre></div> +<p><b>Note</b>: <code>version</code> is always optional here.</p> +<p>On the other hand, the plugin parameter also offers the option to specify a plugin by its prefix, like this:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help +</pre></div></section><section> +<h3><a name="The_goal_Parameter"></a>The <code>goal</code> Parameter</h3> +<p>You can use the <code>goal</code> parameter of the <code>describe</code> goal to show or display relative information about a particular goal of the plugin you specified.</p> +<p>For example, when you execute the following command:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dgoal=describe -DgroupId=org.apache.maven.plugins -DartifactId=maven-help-plugin +</pre></div> +<p>This would display brief information about the <code>describe</code> goal only.</p></section><section> +<h3><a name="The_cmd_Parameter"></a>The <code>cmd</code> Parameter</h3> +<p>You could also ask for a single Maven command, i.e. a goal or a phase or a lifecycle. It is the command when you call Maven, i.e.:</p> +<div class="source"><pre class="prettyprint linenums"># mvn -help + +usage: mvn [options] [<goal(s)>] [<phase(s)>] +... +</pre></div> +<p>The following are some examples:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dcmd=clean +... +[INFO] [help:describe] +[INFO] 'clean' is a lifecycle with the following phases: +* pre-clean: NOT DEFINED +* clean: org.apache.maven.plugins:maven-clean-plugin:clean +* post-clean: NOT DEFINED +... +</pre></div> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dcmd=compile +... +[INFO] [help:describe] +[INFO] 'compile' is a phase corresponding to this plugin: +org.apache.maven.plugins:maven-compiler-plugin:compile + +It is a part of the lifecycle for the POM packaging 'jar'. This lifecycle includes the following phases: +* validate: NOT DEFINED +* initialize: NOT DEFINED +* generate-sources: NOT DEFINED +* process-sources: NOT DEFINED +* generate-resources: NOT DEFINED +* process-resources: org.apache.maven.plugins:maven-resources-plugin:resources +* compile: org.apache.maven.plugins:maven-compiler-plugin:compile +* process-classes: NOT DEFINED +* generate-test-sources: NOT DEFINED +* process-test-sources: NOT DEFINED +* generate-test-resources: NOT DEFINED +* process-test-resources: org.apache.maven.plugins:maven-resources-plugin:testResources +* test-compile: org.apache.maven.plugins:maven-compiler-plugin:testCompile +* process-test-classes: NOT DEFINED +* test: org.apache.maven.plugins:maven-surefire-plugin:test +* package: org.apache.maven.plugins:maven-jar-plugin:jar +* pre-integration-test: NOT DEFINED +* integration-test: NOT DEFINED +* post-integration-test: NOT DEFINED +* verify: NOT DEFINED +* install: org.apache.maven.plugins:maven-install-plugin:install +* deploy: org.apache.maven.plugins:maven-deploy-plugin:deploy +... +</pre></div> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dcmd=compiler:compile +... +[INFO] 'compiler:compile' is a plugin goal (aka mojo). +Mojo: 'compiler:compile' +compiler:compile + Description: Compiles application sources + Deprecated. No reason given + +For more information, run 'mvn help:describe [...] -Ddetail' +... +</pre></div></section><section> +<h3><a name="The_minimal.2C_and_detail_Parameters"></a>The <code>minimal</code>, and <code>detail</code> Parameters</h3> +<p>If you want to display less or more detailed information, you can use the <code>minimal</code>, or <code>detail</code> parameters.</p> +<p>The <code>minimal</code> parameter adds a minimal list of information:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help -Dminimal=true +... +[INFO] [help:describe] +[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT +Group Id: org.apache.maven.plugins +Artifact Id: maven-help-plugin +Version: 2.1-SNAPSHOT +Goal Prefix: help +Description: The Maven Help plugin provides goals aimed at helping to make + sense out of the build environment. It includes the ability to view the + effective POM and settings files, after inheritance and active profiles have + been applied, as well as a describe a particular plugin goal to give usage + information. + +For more information, run 'mvn help:describe [...] -Ddetail' +... +</pre></div> +<p>If you don't provide a paremeter a list is added with the mojos of the plugin and their descriptions:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help +... +[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT +Group Id: org.apache.maven.plugins +Artifact Id: maven-help-plugin +Version: 2.1-SNAPSHOT +Goal Prefix: help +Description: The Maven Help plugin provides goals aimed at helping to make + sense out of the build environment. It includes the ability to view the + effective POM and settings files, after inheritance and active profiles have + been applied, as well as a describe a particular plugin goal to give usage + information. + +This plugin has 9 goals: + +help:active-profiles + Description: Displays a list of the profiles which are currently active for + this build. + Deprecated. No reason given + +help:all-profiles + Description: Displays a list of available profiles under the current + project. + Note: it will list all profiles for a project. If a profile comes up with a + status inactive then there might be a need to set profile activation + switches/property. + Deprecated. No reason given + +help:describe + Description: Displays a list of the attributes for a Maven Plugin and/or + Mojo (Maven plain Old Java Object). + Deprecated. No reason given + +help:effective-pom + Description: Displays the effective POM as an XML for this build, with the + active profiles factored in. + Deprecated. No reason given + +help:effective-settings + Description: Displays the calculated settings as XML for this project, + given any profile enhancement and the inheritance of the global settings + into the user-level settings. + Deprecated. No reason given + +help:evaluate + Description: Evaluates Maven expressions given by the user in an + interactive mode. + Deprecated. No reason given + +help:help + Description: Display help information on maven-help-plugin. + Call + mvn help:help -Ddetail=true -Dgoal=<goal-name> + to display parameter details. + Deprecated. No reason given + +help:system + Description: Displays a list of the platform details like system properties + and environment variables. + Deprecated. No reason given + +For more information, run 'mvn help:describe [...] -Ddetail' +... +</pre></div> +<p>The <code>detail</code> parameter also displays information about the goal's implementation, their parameters and component requirements, among others.</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help -Ddetail=true +</pre></div></section><section> +<h3><a name="The_output_Parameter"></a>The <code>output</code> Parameter</h3> +<p>This <code>describe</code> goal can use the optional <code>output</code> parameter to redirect the output to a file. Here is an example of that:</p> +<div class="source"><pre class="prettyprint linenums"># mvn help:describe -Dplugin=help -Ddetail=true -Doutput=/path/to/file +</pre></div></section></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>© 2001–2024 +<a href="https://www.apache.org/";>The Apache Software Foundation</a> +</p> + </div> + </div> + </footer> + </body> </html> \ No newline at end of file Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/faq.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/faq.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/faq.html Sun Jun 2 15:20:18 2024 @@ -1,126 +1,131 @@ -<!DOCTYPE html> -<!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/fml/faq.fml at 2023-03-14 - | 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.11.1" /> - <title>Apache Maven Help Plugin – Frequently Asked Questions</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"> - <div class="container-fluid"> - <header> - <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Help Plugin"/></a></div> - <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div> - <div class="clear"><hr/></div> - </div> - - <div id="breadcrumbs"> - <ul class="breadcrumb"> - <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> - <li class=""><a href="index.html" title="Apache Maven Help Plugin">Apache Maven Help Plugin</a><span class="divider">/</span></li> - <li class="active ">Frequently Asked Questions <a href="https://github.com/apache/maven-help-plugin/tree/maven-help-plugin-3.4.0/src/site/fml/faq.fml";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-03-14</li> - <li id="projectVersion" class="pull-right">Version: 3.4.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="icon-chevron-right"></span>Goals</a></li> - <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li> - <li class="active"><a href="#"><span class="none"></span>FAQ</a></li> - <li><a href="https://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> - <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> - <li class="nav-header">Examples</li> - <li><a href="examples/describe-configuration.html" title="Configuring Describe Goal"><span class="none"></span>Configuring Describe Goal</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> - <li class="nav-header">Maven Projects</li> - <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> - <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</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="Frequently_Asked_Questions"></a><a name="top">Frequently Asked Questions</a></h2> -<ol style="list-style-type: decimal"> -<li><a href="#What_is_a_Mojo">What is a Mojo</a></li> -<li><a href="#Why_mvn_help:active-profiles_wont_show_the_active_profiles_under_Maven_2.1">Why <code>mvn help:active-profiles</code> won't show the active profiles under Maven 2.1?</a></li></ol></section> -<dl> -<dt><a name="What_is_a_Mojo">What is a Mojo</a></dt> -<dd> - -<p> - See the Maven FAQ: <a class="externalLink" href="http://maven.apache.org/general.html#What_is_a_Mojo";>What is a Mojo</a>. - </p> - -<p align="right"><a href="#top">[top]</a></p><hr /></dd> -<dt><a name="Why_mvn_help:active-profiles_wont_show_the_active_profiles_under_Maven_2.1">Why <code>mvn help:active-profiles</code> won't show the active profiles under Maven 2.1?</a></dt> -<dd> - -<p> - See <a class="externalLink" href="https://issues.apache.org/jira/browse/MPH-38";>MPH-38</a> for more info. - </p> - -<p align="right"><a href="#top">[top]</a></p></dd></dl> - </main> - </div> - </div> - <hr/> - <footer> - <div class="container-fluid"> - <div class="row-fluid"> - <p>© 2001–2023 -<a href="https://www.apache.org/";>The Apache Software Foundation</a> -</p> - </div> - </div> - </footer> - </body> +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src\site\fml/faq.fml at 2024-06-02 + | 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.11.1" /> + <title>Apache Maven Help Plugin – Frequently Asked Questions</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"> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Help Plugin"/></a></div> + <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Apache Maven Help Plugin">Apache Maven Help Plugin</a><span class="divider">/</span></li> + <li class="active ">Frequently Asked Questions <a href="https://github.com/apache/maven-help-plugin/tree/maven-help-plugin-3.4.1/src\site\fml/faq.fml";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-06-02</li> + <li id="projectVersion" class="pull-right">Version: 3.4.1</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="icon-chevron-right"></span>Goals</a></li> + <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li> + <li class="active"><a href="#"><span class="none"></span>FAQ</a></li> + <li><a href="https://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li class="nav-header">Examples</li> + <li><a href="examples/describe-configuration.html" title="Configuring Describe Goal"><span class="none"></span>Configuring Describe Goal</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> + <li class="nav-header">Maven Projects</li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> + <li><a href="../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> + <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> + <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> + <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> + <li><a href="" title=""><span class="icon-chevron-down"></span></a> + <ul class="nav nav-list"> + <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> + <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> + <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> + <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> + <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> + <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> + <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + </ul></li> + <li class="nav-header">ASF</li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</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="Frequently_Asked_Questions"></a><a name="top">Frequently Asked Questions</a></h2> +<ol style="list-style-type: decimal"> +<li><a href="#What_is_a_Mojo">What is a Mojo</a></li> +<li><a href="#Why_mvn_help:active-profiles_wont_show_the_active_profiles_under_Maven_2.1">Why <code>mvn help:active-profiles</code> won't show the active profiles under Maven 2.1?</a></li></ol></section> +<dl> +<dt><a name="What_is_a_Mojo">What is a Mojo</a></dt> +<dd> + +<p> + See the Maven FAQ: <a class="externalLink" href="http://maven.apache.org/general.html#What_is_a_Mojo";>What is a Mojo</a>. + </p> + +<p align="right"><a href="#top">[top]</a></p><hr /></dd> +<dt><a name="Why_mvn_help:active-profiles_wont_show_the_active_profiles_under_Maven_2.1">Why <code>mvn help:active-profiles</code> won't show the active profiles under Maven 2.1?</a></dt> +<dd> + +<p> + See <a class="externalLink" href="https://issues.apache.org/jira/browse/MPH-38";>MPH-38</a> for more info. + </p> + +<p align="right"><a href="#top">[top]</a></p></dd></dl> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>© 2001–2024 +<a href="https://www.apache.org/";>The Apache Software Foundation</a> +</p> + </div> + </div> + </footer> + </body> </html> \ No newline at end of file
