diff --git a/maven-plugins/maven-assembly-plugin/src/site/apt/howto.apt b/maven-plugins/maven-assembly-plugin/src/site/apt/howto.apt index 3323266bd3..f3e03a0eca 100644 --- a/maven-plugins/maven-assembly-plugin/src/site/apt/howto.apt +++ b/maven-plugins/maven-assembly-plugin/src/site/apt/howto.apt @@ -1,129 +1,129 @@ - ------ - Maven 2 Assembly Plugin - ------ - Johnny R. Ruiz III - - ------ - October 16, 2005 - -How to Use - - These is a brief example on how to use the assembly:assembly goal and assembly:unpack goal. - - To use the assembly:assembly goal, you must define the descriptor file that you are going to use or - define the descriptorId from the predefined {{{descriptor.html}descriptor ids}}. - - -* How To use assembly:assembly using a customized descriptor file. - ------ - m2 assembly:assembly -Ddescriptor=path/to/descriptor.xml ------ - - -* How to use assembly:assembly using predefined descriptor ids. - ----- - - m2 assembly:assembly -DdescriptorId=bin - - or m2 assembly:assembly -DdescriptorId=jar-with-dependencies - - or m2 assembly:assembly -DdescriptorId=src - ------ - -* How to configure assembly:assembly plugin in pom.xml - - You can also configure this plugin inside your pom.xml. To run use "m2 assembly:assembly". - -------------------- - - ... - - ... - - - maven-assembly-plugin - 2.0-beta-1 - - path/to/descriptor.xml - final_name - output/directory - target/assembly/work - - - - ... - - ... - -------------------- - -* How to use assembly:unpack - - After running this goal, all dependencies will be extracted at the specified "\". - ------ - m2 assembly:unpack ------ - - - -* How to generate Assembly Download Report - - To generate the Download report, maven-assembly-plugin must be configured in \ section of your pom.xml. - Take note that the parameter \ and \/\ are required parameters. - - You could generate the Download report by using this command: "m2 assembly:download". - - Here's a sample configuration. - ------------- - - ... - - ... - - - maven-assembly-plugin - 2.0 - - finalName-2.1-SNAPSHOT - bin - - - - ... - - ... - -------------- - - Or in your project pom.xml, add the assembly plugin in \ section. - Take note, that maven-assembly-plugin must also be configured in \ section your pom.xml. - - And also the parameter \ and \/\ are required parameters. - -------------------- - - ... - - - - org.apache.maven.plugins - maven-assembly-plugin - - - - ... - -------------------- - - Execute the site plugin to generate the report distribution. - -------------------- - m2 site:site -------------------- - - For full documentation of plugin's goals and parameters, click {{{index.html}here}}. + ------ + Maven 2 Assembly Plugin + ------ + Johnny R. Ruiz III + + ------ + October 16, 2005 + +How to Use + + These is a brief example on how to use the assembly:assembly goal and assembly:unpack goal. + + To use the assembly:assembly goal, you must define the descriptor file that you are going to use or + define the descriptorId from the predefined {{{descriptor.html}descriptor ids}}. + + +* How To use assembly:assembly using a customized descriptor file. + +----- + m2 assembly:assembly -Ddescriptor=path/to/descriptor.xml +----- + + +* How to use assembly:assembly using predefined descriptor ids. + +---- + + m2 assembly:assembly -DdescriptorId=bin + + or m2 assembly:assembly -DdescriptorId=jar-with-dependencies + + or m2 assembly:assembly -DdescriptorId=src + +----- + +* How to configure assembly:assembly plugin in pom.xml + + You can also configure this plugin inside your pom.xml. To run use "m2 assembly:assembly". + +------------------- + + ... + + ... + + + maven-assembly-plugin + 2.0-beta-1 + + path/to/descriptor.xml + final_name + output/directory + target/assembly/work + + + + ... + + ... + +------------------- + +* How to use assembly:unpack + + After running this goal, all dependencies will be extracted at the specified "\". + +----- + m2 assembly:unpack +----- + + + +* How to generate Assembly Download Report + + To generate the Download report, maven-assembly-plugin must be configured in \ section of your pom.xml. + Take note that the parameter \ and \/\ are required parameters. + + You could generate the Download report by using this command: "m2 assembly:download". + + Here's a sample configuration. + +------------ + + ... + + ... + + + maven-assembly-plugin + 2.0 + + finalName-2.1-SNAPSHOT + bin + + + + ... + + ... + +------------- + + Or in your project pom.xml, add the assembly plugin in \ section. + Take note, that maven-assembly-plugin must also be configured in \ section your pom.xml. + + And also the parameter \ and \/\ are required parameters. + +------------------- + + ... + + + + org.apache.maven.plugins + maven-assembly-plugin + + + + ... + +------------------- + + Execute the site plugin to generate the report distribution. + +------------------- + m2 site:site +------------------- + + For full documentation of plugin's goals and parameters, click {{{index.html}here}}.