Apache

Docs Plugins

Help Plugin 3.5.2 · Other versions

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.

Source
Generated from the code
Wrong?
Report a problem

help:help

Full name:

org.apache.maven.plugins:maven-help-plugin:3.5.2:help

Description:

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

Attributes:

  • The goal is thread-safe and supports parallel builds.

Optional Parameters

Name Type Since Description
<detail> boolean - If true, display all settable properties for each goal.
Default: false
User Property: detail
<goal> String - The name of the goal for which to show help. If unspecified, all goals will be displayed.
User Property: goal
<indentSize> int - The number of spaces per indentation level, should be positive.
Default: 2
User Property: indentSize
<lineLength> int - The maximum length of a display line, should be positive.
Default: 80
User Property: lineLength

Parameter Details

<detail>

If true, display all settable properties for each goal.
  • Type: boolean
  • Required: No
  • User Property: detail
  • Default: false

<goal>

The name of the goal for which to show help. If unspecified, all goals will be displayed.
  • Type: java.lang.String
  • Required: No
  • User Property: goal

<indentSize>

The number of spaces per indentation level, should be positive.
  • Type: int
  • Required: No
  • User Property: indentSize
  • Default: 2

<lineLength>

The maximum length of a display line, should be positive.
  • Type: int
  • Required: No
  • User Property: lineLength
  • Default: 80