Describing a Maven Plugin

Describing a Maven Plugin

Using the Maven Help Plugin

	Description
	Example
	Available parameters

Description

Displays a list of the attributes for a Maven Plugin and/or goals (aka Mojo - Maven plain Old Java Object).
Deprecated. No reason given
Implementation: org.apache.maven.plugins.help.DescribeMojo
Language: java

回页首

Example

You must specify either: both 'groupId' and 'artifactId' parameters OR a 'plugin' parameter OR a 'cmd' parameter. For instance:
  # mvn help:describe -Dcmd=install
or
  # mvn help:describe -Dcmd=help:describe
or
  # mvn help:describe -Dplugin=org.apache.maven.plugins:maven-help-plugin
or
  # mvn help:describe -DgroupId=org.apache.maven.plugins -DartifactId=maven-help-plugin

回页首

Available parameters

• artifactId

• The Maven Plugin artifactId to describe.
  Note: Should be used with groupId parameter.
  Deprecated. No reason given

• cmd

• A Maven command like a single goal or a single phase following the Maven
  command line:
  mvn [options] [<goal(s)>] [<phase(s)>]
  Deprecated. No reason given

• detail (Default: false)

• This flag specifies that a detailed (verbose) list of goal (Mojo)
  information should be given.
  Deprecated. No reason given

• 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.
  Deprecated. No reason given

• groupId

• The Maven Plugin groupId to describe.
  Note: Should be used with artifactId parameter.
  Deprecated. No reason given

• medium (Default: true)

• This flag specifies that a medium list of goal (Mojo) information should
  be given.
  Deprecated. No reason given

• minimal (Default: false)

• This flag specifies that a minimal list of goal (Mojo) information should
  be given.
  Deprecated. No reason given

• 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.
  Deprecated. No reason given

• 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'
• version

• The Maven Plugin version to describe.
  Note: Should be used with groupId/artifactId parameters.
  Deprecated. No reason given

回页首