help:describe

Full name:

org.apache.maven.plugins:maven-help-plugin:2.2:describe

Description:

Displays a list of the attributes for a Maven Plugin and/or goals (aka Mojo - Maven plain Old Java Object).

Attributes:

  • Executes as an aggregator plugin.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
artifactId String 2.0 The Maven Plugin artifactId to describe.
Note: Should be used with groupId parameter.
User property is: artifactId.
cmd String 2.1 A Maven command like a single goal or a single phase following the Maven command line:
mvn [options] [<goal(s)>] [<phase(s)>]
User property is: cmd.
detail boolean 2.1, was full in 2.0.x This flag specifies that a detailed (verbose) list of goal (Mojo) information should be given.
Default value is: false.
User property is: detail.
goal String 2.1, was mojo in 2.0.x The goal name of a Mojo to describe within the specified Maven Plugin. If this parameter is specified, only the corresponding goal (Mojo) will be described, rather than the whole Plugin.
User property is: goal.
groupId String 2.0 The Maven Plugin groupId to describe.
Note: Should be used with artifactId parameter.
User property is: groupId.
medium boolean 2.0.2 This flag specifies that a medium list of goal (Mojo) information should be given.
Default value is: true.
User property is: medium.
minimal boolean 2.1 This flag specifies that a minimal list of goal (Mojo) information should be given.
Default value is: false.
User property is: minimal.
output File 2.0 Optional parameter to write the output of this help in a given file, instead of writing to the console.
Note: Could be a relative path.
User property is: output.
plugin String 2.0 The Maven Plugin to describe. This must be specified in one of three ways:
  1. plugin-prefix, i.e. 'help'
  2. groupId:artifactId, i.e. 'org.apache.maven.plugins:maven-help-plugin'
  3. groupId:artifactId:version, i.e. 'org.apache.maven.plugins:maven-help-plugin:2.0'

User property is: plugin.
version String 2.0 The Maven Plugin version to describe.
Note: Should be used with groupId/artifactId parameters.
User property is: version.

Parameter Details

artifactId:

The Maven Plugin artifactId to describe.
Note: Should be used with groupId parameter.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: artifactId

cmd:

A Maven command like a single goal or a single phase following the Maven command line:
mvn [options] [<goal(s)>] [<phase(s)>]
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: cmd

detail:

This flag specifies that a detailed (verbose) list of goal (Mojo) information should be given.
  • Type: boolean
  • Since: 2.1, was full in 2.0.x
  • Required: No
  • User Property: detail
  • Default: false

goal:

The goal name of a Mojo to describe within the specified Maven Plugin. If this parameter is specified, only the corresponding goal (Mojo) will be described, rather than the whole Plugin.
  • Type: java.lang.String
  • Since: 2.1, was mojo in 2.0.x
  • Required: No
  • User Property: goal

groupId:

The Maven Plugin groupId to describe.
Note: Should be used with artifactId parameter.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: groupId

medium:

This flag specifies that a medium list of goal (Mojo) information should be given.
  • Type: boolean
  • Since: 2.0.2
  • Required: No
  • User Property: medium
  • Default: true

minimal:

This flag specifies that a minimal list of goal (Mojo) information should be given.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: minimal
  • Default: false

output:

Optional parameter to write the output of this help in a given file, instead of writing to the console.
Note: Could be a relative path.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • User Property: output

plugin:

The Maven Plugin to describe. This must be specified in one of three ways:
  1. plugin-prefix, i.e. 'help'
  2. groupId:artifactId, i.e. 'org.apache.maven.plugins:maven-help-plugin'
  3. groupId:artifactId:version, i.e. 'org.apache.maven.plugins:maven-help-plugin:2.0'
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: plugin

version:

The Maven Plugin version to describe.
Note: Should be used with groupId/artifactId parameters.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: version