Modified: websites/production/maven/content/plugins-archives/maven-install-plugin-LATEST/install-file-mojo.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-install-plugin-LATEST/install-file-mojo.html (original) +++ websites/production/maven/content/plugins-archives/maven-install-plugin-LATEST/install-file-mojo.html Wed Aug 27 20:10:49 2014 @@ -1,635 +1,641 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- - | Generated by Apache Maven Doxia at 2013-10-19 - | Rendered using Apache Maven Stylus Skin 1.5 ---> -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <title>Apache Maven Install Plugin - - install:install-file</title> - <style type="text/css" media="all"> - @import url("./css/maven-base.css"); - @import url("./css/maven-theme.css"); - @import url("./css/site.css"); - </style> - <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20131019" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - -<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> - -<script type="text/javascript">_uacct = "UA-140879-1"; - urchinTracker();</script> - </head> - <body class="composite"> - <div id="banner"> - <a href="../../" id="bannerLeft"> - <img src="../../images/apache-maven-project-2.png" alt="" /> - </a> - <span id="bannerRight"> - <img src="../../images/maven-logo-2.gif" alt="" /> - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - <div class="xleft"> - <a href="http://www.apache.org/"; class="externalLink">Apache</a> - > - <a href="../../index.html">Maven</a> - > - <a href="../index.html">Plugins</a> - > - <a href="./">Apache Maven Install Plugin</a> - > - - install:install-file - </div> - <div class="xright"> - Last Published: 2013-10-19 - | Version: 2.5.1 - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - <h5>Overview</h5> - <ul> - <li class="none"> - <a href="index.html">Introduction</a> - </li> - <li class="none"> - <a href="plugin-info.html">Goals</a> - </li> - <li class="none"> - <a href="usage.html">Usage</a> - </li> - <li class="none"> - <a href="faq.html">FAQ</a> - </li> - </ul> - <h5>Examples</h5> - <ul> - <li class="none"> - <a href="examples/custom-pom-installation.html">Installing Artifact with Custom POM</a> - </li> - <li class="none"> - <a href="examples/generic-pom-generation.html">Generating Generic POM</a> - </li> - <li class="none"> - <a href="examples/installing-checksums.html">Creating Checksums</a> - </li> - <li class="none"> - <a href="examples/update-release-info.html">Updating Release Info</a> - </li> - <li class="none"> - <a href="examples/specific-local-repo.html">Installing to a Specific Local Repository Path</a> - </li> - <li class="none"> - <a href="examples/installing-secondary-artifacts.html">Installing Secondary Artifacts</a> - </li> - </ul> - <h5>Project Documentation</h5> - <ul> - <li class="collapsed"> - <a href="project-info.html">Project Information</a> - </li> - <li class="collapsed"> - <a href="project-reports.html">Project Reports</a> - </li> - </ul> - <h5>Maven Projects</h5> - <ul> - <li class="none"> - <a href="../../ant-tasks/index.html">Ant Tasks</a> - </li> - <li class="none"> - <a href="../../archetype/index.html">Archetype</a> - </li> - <li class="none"> - <a href="../../doxia/index.html">Doxia</a> - </li> - <li class="none"> - <a href="../../jxr/index.html">JXR</a> - </li> - <li class="none"> - <a href="../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../index.html">Maven 2 & 3</a> - </li> - <li class="none"> - <a href="../../pom/index.html">Parent POMs</a> - </li> - <li class="none"> - <a href="../index.html">Plugins</a> - </li> - <li class="none"> - <a href="../../plugin-tools/index.html">Plugin Tools</a> - </li> - <li class="none"> - <a href="../../scm/index.html">SCM</a> - </li> - <li class="none"> - <a href="../../shared/index.html">Shared Components</a> - </li> - <li class="none"> - <a href="../../skins/index.html">Skins</a> - </li> - <li class="none"> - <a href="../../surefire/index.html">Surefire</a> - </li> - <li class="none"> - <a href="../../wagon/index.html">Wagon</a> - </li> - </ul> - <h5>ASF</h5> - <ul> - <li class="none"> - <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> - </a> - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - - - <div class="section"> -<h2>install:install-file<a name="install:install-file"></a></h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.maven.plugins:maven-install-plugin:2.5.1:install-file</p> - -<p><b>Description</b>:</p> - -<div>Installs a file in the local repository.</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>Executes as an aggregator plugin.</li> - -<li>The goal is thread-safe and supports parallel builds.</li> - </ul> - -<div class="section"> -<h3>Required Parameters<a name="Required_Parameters"></a></h3> - -<table class="bodyTable" border="0"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><b><a href="#file">file</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>The file to be installed in the local repository.<br /><b>User property is</b>: <tt>file</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#repositoryLayout">repositoryLayout</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>2.2</tt></td> - -<td>The type of remote repository layout to install to. Try -<tt>legacy</tt> for a Maven 1.x-style repository layout.<br /><b>Default value is</b>: <tt>default</tt>.<br /><b>User property is</b>: <tt>repositoryLayout</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - -<table class="bodyTable" border="0"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><b><a href="#artifactId">artifactId</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>ArtifactId of the artifact to be installed. Retrieved from POM file -if one is specified or extracted from <tt>pom.xml</tt> in jar -if available.<br /><b>User property is</b>: <tt>artifactId</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#classifier">classifier</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>2.2</tt></td> - -<td>Classifier type of the artifact to be installed. For example, -"sources" or "javadoc". Defaults to none which means this is the -project's main artifact.<br /><b>User property is</b>: <tt>classifier</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#createChecksum">createChecksum</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>2.2</tt></td> - -<td>Flag whether to create checksums (MD5, SHA-1) or not.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>createChecksum</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#generatePom">generatePom</a></b></td> - -<td><tt>Boolean</tt></td> - -<td><tt>2.1</tt></td> - -<td>Generate a minimal POM for the artifact if none is supplied via the -parameter <tt>pomFile</tt>. Defaults to <tt>true</tt> if -there is no existing POM in the local repository yet.<br /><b>User property is</b>: <tt>generatePom</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#groupId">groupId</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>GroupId of the artifact to be installed. Retrieved from POM file if -one is specified or extracted from <tt>pom.xml</tt> in jar if -available.<br /><b>User property is</b>: <tt>groupId</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#javadoc">javadoc</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>2.3</tt></td> - -<td>The bundled API docs for the artifact.<br /><b>User property is</b>: <tt>javadoc</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#localRepositoryPath">localRepositoryPath</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>2.2</tt></td> - -<td>The path for a specific local repository directory. If not -specified the local repository path configured in the Maven -settings will be used.<br /><b>User property is</b>: <tt>localRepositoryPath</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#packaging">packaging</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>Packaging type of the artifact to be installed. Retrieved from POM -file if one is specified or extracted from <tt>pom.xml</tt> in -jar if available.<br /><b>User property is</b>: <tt>packaging</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#pomFile">pomFile</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>2.1</tt></td> - -<td>Location of an existing POM file to be installed alongside the main -artifact, given by the <tt>file</tt> parameter.<br /><b>User property is</b>: <tt>pomFile</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#sources">sources</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>2.3</tt></td> - -<td>The bundled sources for the artifact.<br /><b>User property is</b>: <tt>sources</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Whether to update the metadata to make the artifact a release -version.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#version">version</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>Version of the artifact to be installed. Retrieved from POM file if -one is specified or extracted from <tt>pom.xml</tt> in jar if -available.<br /><b>User property is</b>: <tt>version</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3>Parameter Details<a name="Parameter_Details"></a></h3> - -<p><b><a name="artifactId">artifactId</a>:</b></p> - -<div>ArtifactId of the artifact to be installed. Retrieved from POM file -if one is specified or extracted from <tt>pom.xml</tt> in jar -if available.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>artifactId</tt></li> - </ul><hr /> -<p><b><a name="classifier">classifier</a>:</b></p> - -<div>Classifier type of the artifact to be installed. For example, -"sources" or "javadoc". Defaults to none which means this is the -project's main artifact.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Since</b>: <tt>2.2</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>classifier</tt></li> - </ul><hr /> -<p><b><a name="createChecksum">createChecksum</a>:</b></p> - -<div>Flag whether to create checksums (MD5, SHA-1) or not.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Since</b>: <tt>2.2</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>createChecksum</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="file">file</a>:</b></p> - -<div>The file to be installed in the local repository.</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>Yes</tt></li> - -<li><b>User Property</b>: <tt>file</tt></li> - </ul><hr /> -<p><b><a name="generatePom">generatePom</a>:</b></p> - -<div>Generate a minimal POM for the artifact if none is supplied via the -parameter <tt>pomFile</tt>. Defaults to <tt>true</tt> if -there is no existing POM in the local repository yet.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.Boolean</tt></li> - -<li><b>Since</b>: <tt>2.1</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>generatePom</tt></li> - </ul><hr /> -<p><b><a name="groupId">groupId</a>:</b></p> - -<div>GroupId of the artifact to be installed. Retrieved from POM file if -one is specified or extracted from <tt>pom.xml</tt> in jar if -available.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>groupId</tt></li> - </ul><hr /> -<p><b><a name="javadoc">javadoc</a>:</b></p> - -<div>The bundled API docs for the artifact.</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Since</b>: <tt>2.3</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>javadoc</tt></li> - </ul><hr /> -<p><b><a name="localRepositoryPath">localRepositoryPath</a>:</b></p> - -<div>The path for a specific local repository directory. If not -specified the local repository path configured in the Maven -settings will be used.</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Since</b>: <tt>2.2</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>localRepositoryPath</tt></li> - </ul><hr /> -<p><b><a name="packaging">packaging</a>:</b></p> - -<div>Packaging type of the artifact to be installed. Retrieved from POM -file if one is specified or extracted from <tt>pom.xml</tt> in -jar if available.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>packaging</tt></li> - </ul><hr /> -<p><b><a name="pomFile">pomFile</a>:</b></p> - -<div>Location of an existing POM file to be installed alongside the main -artifact, given by the <tt>file</tt> parameter.</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Since</b>: <tt>2.1</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>pomFile</tt></li> - </ul><hr /> -<p><b><a name="repositoryLayout">repositoryLayout</a>:</b></p> - -<div>The type of remote repository layout to install to. Try -<tt>legacy</tt> for a Maven 1.x-style repository layout.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Since</b>: <tt>2.2</tt></li> - -<li><b>Required</b>: <tt>Yes</tt></li> - -<li><b>User Property</b>: <tt>repositoryLayout</tt></li> - -<li><b>Default</b>: <tt>default</tt></li> - </ul><hr /> -<p><b><a name="sources">sources</a>:</b></p> - -<div>The bundled sources for the artifact.</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Since</b>: <tt>2.3</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>sources</tt></li> - </ul><hr /> -<p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> - -<div>Whether to update the metadata to make the artifact a release -version.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="version">version</a>:</b></p> - -<div>Version of the artifact to be installed. Retrieved from POM file if -one is specified or extracted from <tt>pom.xml</tt> in jar if -available.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>version</tt></li> - </ul> - </div> - </div> - - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright"> - © 2004-2013 - The Apache Software Foundation - - - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. - Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- + | Generated by Apache Maven Doxia at 2014-08-27 + | Rendered using Apache Maven Stylus Skin 1.5 +--> +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <title>Apache Maven Install Plugin - + install:install-file</title> + <style type="text/css" media="all"> + @import url("./css/maven-base.css"); + @import url("./css/maven-theme.css"); + @import url("./css/site.css"); + </style> + <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20140827" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + +<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> + +<script type="text/javascript">_uacct = "UA-140879-1"; + urchinTracker();</script> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../" id="bannerLeft"> + <img src="../../images/apache-maven-project-2.png" alt="" /> + </a> + <span id="bannerRight"> + <img src="../../images/maven-logo-2.gif" alt="" /> + </span> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + <div class="xleft"> + <a href="http://www.apache.org/"; class="externalLink">Apache</a> + > + <a href="../../index.html">Maven</a> + > + <a href="../index.html">Plugins</a> + > + <a href="./">Apache Maven Install Plugin</a> + > + + install:install-file + </div> + <div class="xright"> + Last Published: 2014-08-27 + | Version: 2.5.2 + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + <h5>Overview</h5> + <ul> + <li class="none"> + <a href="index.html">Introduction</a> + </li> + <li class="none"> + <a href="plugin-info.html">Goals</a> + </li> + <li class="none"> + <a href="usage.html">Usage</a> + </li> + <li class="none"> + <a href="faq.html">FAQ</a> + </li> + <li class="none"> + <a href="http://www.apache.org/licenses/"; class="externalLink">License</a> + </li> + <li class="none"> + <a href="download.html">Download</a> + </li> + </ul> + <h5>Examples</h5> + <ul> + <li class="none"> + <a href="examples/custom-pom-installation.html">Installing Artifact with Custom POM</a> + </li> + <li class="none"> + <a href="examples/generic-pom-generation.html">Generating Generic POM</a> + </li> + <li class="none"> + <a href="examples/installing-checksums.html">Creating Checksums</a> + </li> + <li class="none"> + <a href="examples/update-release-info.html">Updating Release Info</a> + </li> + <li class="none"> + <a href="examples/specific-local-repo.html">Installing to a Specific Local Repository Path</a> + </li> + <li class="none"> + <a href="examples/installing-secondary-artifacts.html">Installing Secondary Artifacts</a> + </li> + </ul> + <h5>Project Documentation</h5> + <ul> + <li class="collapsed"> + <a href="project-info.html">Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html">Project Reports</a> + </li> + </ul> + <h5>Maven Projects</h5> + <ul> + <li class="none"> + <a href="../../ant-tasks/index.html">Ant Tasks</a> + </li> + <li class="none"> + <a href="../../archetype/index.html">Archetype</a> + </li> + <li class="none"> + <a href="../../doxia/index.html">Doxia</a> + </li> + <li class="none"> + <a href="../../jxr/index.html">JXR</a> + </li> + <li class="none"> + <a href="../../maven-1.x/index.html">Maven 1.x</a> + </li> + <li class="none"> + <a href="../../index.html">Maven 2 & 3</a> + </li> + <li class="none"> + <a href="../../pom/index.html">Parent POMs</a> + </li> + <li class="none"> + <a href="../index.html">Plugins</a> + </li> + <li class="none"> + <a href="../../plugin-tools/index.html">Plugin Tools</a> + </li> + <li class="none"> + <a href="../../scm/index.html">SCM</a> + </li> + <li class="none"> + <a href="../../shared/index.html">Shared Components</a> + </li> + <li class="none"> + <a href="../../skins/index.html">Skins</a> + </li> + <li class="none"> + <a href="../../surefire/index.html">Surefire</a> + </li> + <li class="none"> + <a href="../../wagon/index.html">Wagon</a> + </li> + </ul> + <h5>ASF</h5> + <ul> + <li class="none"> + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> + </li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> + </a> + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + <div class="section"> +<h2>install:install-file<a name="install:install-file"></a></h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file</p> + +<p><b>Description</b>:</p> + +<div>Installs a file in the local repository.</div> + +<p><b>Attributes</b>:</p> + +<ul> + +<li>Executes as an aggregator plugin.</li> + +<li>The goal is thread-safe and supports parallel builds.</li> + </ul> + +<div class="section"> +<h3>Required Parameters<a name="Required_Parameters"></a></h3> + +<table class="bodyTable" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td><b><a href="#file">file</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>-</tt></td> + +<td>The file to be installed in the local repository.<br /><b>User property is</b>: <tt>file</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#repositoryLayout">repositoryLayout</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>2.2</tt></td> + +<td>The type of remote repository layout to install to. Try +<tt>legacy</tt> for a Maven 1.x-style repository layout.<br /><b>Default value is</b>: <tt>default</tt>.<br /><b>User property is</b>: <tt>repositoryLayout</tt>.</td> + </tr> + </table> + </div> + +<div class="section"> +<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> + +<table class="bodyTable" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td><b><a href="#artifactId">artifactId</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>ArtifactId of the artifact to be installed. Retrieved from POM file +if one is specified or extracted from <tt>pom.xml</tt> in jar +if available.<br /><b>User property is</b>: <tt>artifactId</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#classifier">classifier</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>2.2</tt></td> + +<td>Classifier type of the artifact to be installed. For example, +"sources" or "javadoc". Defaults to none which means this is the +project's main artifact.<br /><b>User property is</b>: <tt>classifier</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#createChecksum">createChecksum</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>2.2</tt></td> + +<td>Flag whether to create checksums (MD5, SHA-1) or not.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>createChecksum</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#generatePom">generatePom</a></b></td> + +<td><tt>Boolean</tt></td> + +<td><tt>2.1</tt></td> + +<td>Generate a minimal POM for the artifact if none is supplied via the +parameter <tt>pomFile</tt>. Defaults to <tt>true</tt> if +there is no existing POM in the local repository yet.<br /><b>User property is</b>: <tt>generatePom</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#groupId">groupId</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>GroupId of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from <tt>pom.xml</tt> in jar if +available.<br /><b>User property is</b>: <tt>groupId</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#javadoc">javadoc</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>2.3</tt></td> + +<td>The bundled API docs for the artifact.<br /><b>User property is</b>: <tt>javadoc</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#localRepositoryPath">localRepositoryPath</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>2.2</tt></td> + +<td>The path for a specific local repository directory. If not +specified the local repository path configured in the Maven +settings will be used.<br /><b>User property is</b>: <tt>localRepositoryPath</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#packaging">packaging</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Packaging type of the artifact to be installed. Retrieved from POM +file if one is specified or extracted from <tt>pom.xml</tt> in +jar if available.<br /><b>User property is</b>: <tt>packaging</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#pomFile">pomFile</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>2.1</tt></td> + +<td>Location of an existing POM file to be installed alongside the main +artifact, given by the <tt>file</tt> parameter.<br /><b>User property is</b>: <tt>pomFile</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#sources">sources</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>2.3</tt></td> + +<td>The bundled sources for the artifact.<br /><b>User property is</b>: <tt>sources</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>-</tt></td> + +<td>Whether to update the metadata to make the artifact a release +version.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#version">version</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Version of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from <tt>pom.xml</tt> in jar if +available.<br /><b>User property is</b>: <tt>version</tt>.</td> + </tr> + </table> + </div> + +<div class="section"> +<h3>Parameter Details<a name="Parameter_Details"></a></h3> + +<p><b><a name="artifactId">artifactId</a>:</b></p> + +<div>ArtifactId of the artifact to be installed. Retrieved from POM file +if one is specified or extracted from <tt>pom.xml</tt> in jar +if available.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>artifactId</tt></li> + </ul><hr /> +<p><b><a name="classifier">classifier</a>:</b></p> + +<div>Classifier type of the artifact to be installed. For example, +"sources" or "javadoc". Defaults to none which means this is the +project's main artifact.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Since</b>: <tt>2.2</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>classifier</tt></li> + </ul><hr /> +<p><b><a name="createChecksum">createChecksum</a>:</b></p> + +<div>Flag whether to create checksums (MD5, SHA-1) or not.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Since</b>: <tt>2.2</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>createChecksum</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="file">file</a>:</b></p> + +<div>The file to be installed in the local repository.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Required</b>: <tt>Yes</tt></li> + +<li><b>User Property</b>: <tt>file</tt></li> + </ul><hr /> +<p><b><a name="generatePom">generatePom</a>:</b></p> + +<div>Generate a minimal POM for the artifact if none is supplied via the +parameter <tt>pomFile</tt>. Defaults to <tt>true</tt> if +there is no existing POM in the local repository yet.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.Boolean</tt></li> + +<li><b>Since</b>: <tt>2.1</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>generatePom</tt></li> + </ul><hr /> +<p><b><a name="groupId">groupId</a>:</b></p> + +<div>GroupId of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from <tt>pom.xml</tt> in jar if +available.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>groupId</tt></li> + </ul><hr /> +<p><b><a name="javadoc">javadoc</a>:</b></p> + +<div>The bundled API docs for the artifact.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Since</b>: <tt>2.3</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>javadoc</tt></li> + </ul><hr /> +<p><b><a name="localRepositoryPath">localRepositoryPath</a>:</b></p> + +<div>The path for a specific local repository directory. If not +specified the local repository path configured in the Maven +settings will be used.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Since</b>: <tt>2.2</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>localRepositoryPath</tt></li> + </ul><hr /> +<p><b><a name="packaging">packaging</a>:</b></p> + +<div>Packaging type of the artifact to be installed. Retrieved from POM +file if one is specified or extracted from <tt>pom.xml</tt> in +jar if available.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>packaging</tt></li> + </ul><hr /> +<p><b><a name="pomFile">pomFile</a>:</b></p> + +<div>Location of an existing POM file to be installed alongside the main +artifact, given by the <tt>file</tt> parameter.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Since</b>: <tt>2.1</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>pomFile</tt></li> + </ul><hr /> +<p><b><a name="repositoryLayout">repositoryLayout</a>:</b></p> + +<div>The type of remote repository layout to install to. Try +<tt>legacy</tt> for a Maven 1.x-style repository layout.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Since</b>: <tt>2.2</tt></li> + +<li><b>Required</b>: <tt>Yes</tt></li> + +<li><b>User Property</b>: <tt>repositoryLayout</tt></li> + +<li><b>Default</b>: <tt>default</tt></li> + </ul><hr /> +<p><b><a name="sources">sources</a>:</b></p> + +<div>The bundled sources for the artifact.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Since</b>: <tt>2.3</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>sources</tt></li> + </ul><hr /> +<p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> + +<div>Whether to update the metadata to make the artifact a release +version.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="version">version</a>:</b></p> + +<div>Version of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from <tt>pom.xml</tt> in jar if +available.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>version</tt></li> + </ul> + </div> + </div> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + © 2004-2014 + The Apache Software Foundation + + - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. + Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> </html> \ No newline at end of file
Modified: websites/production/maven/content/plugins-archives/maven-install-plugin-LATEST/install-mojo.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-install-plugin-LATEST/install-mojo.html (original) +++ websites/production/maven/content/plugins-archives/maven-install-plugin-LATEST/install-mojo.html Wed Aug 27 20:10:49 2014 @@ -1,361 +1,367 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- - | Generated by Apache Maven Doxia at 2013-10-19 - | Rendered using Apache Maven Stylus Skin 1.5 ---> -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <title>Apache Maven Install Plugin - - install:install</title> - <style type="text/css" media="all"> - @import url("./css/maven-base.css"); - @import url("./css/maven-theme.css"); - @import url("./css/site.css"); - </style> - <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20131019" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - -<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> - -<script type="text/javascript">_uacct = "UA-140879-1"; - urchinTracker();</script> - </head> - <body class="composite"> - <div id="banner"> - <a href="../../" id="bannerLeft"> - <img src="../../images/apache-maven-project-2.png" alt="" /> - </a> - <span id="bannerRight"> - <img src="../../images/maven-logo-2.gif" alt="" /> - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - <div class="xleft"> - <a href="http://www.apache.org/"; class="externalLink">Apache</a> - > - <a href="../../index.html">Maven</a> - > - <a href="../index.html">Plugins</a> - > - <a href="./">Apache Maven Install Plugin</a> - > - - install:install - </div> - <div class="xright"> - Last Published: 2013-10-19 - | Version: 2.5.1 - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - <h5>Overview</h5> - <ul> - <li class="none"> - <a href="index.html">Introduction</a> - </li> - <li class="none"> - <a href="plugin-info.html">Goals</a> - </li> - <li class="none"> - <a href="usage.html">Usage</a> - </li> - <li class="none"> - <a href="faq.html">FAQ</a> - </li> - </ul> - <h5>Examples</h5> - <ul> - <li class="none"> - <a href="examples/custom-pom-installation.html">Installing Artifact with Custom POM</a> - </li> - <li class="none"> - <a href="examples/generic-pom-generation.html">Generating Generic POM</a> - </li> - <li class="none"> - <a href="examples/installing-checksums.html">Creating Checksums</a> - </li> - <li class="none"> - <a href="examples/update-release-info.html">Updating Release Info</a> - </li> - <li class="none"> - <a href="examples/specific-local-repo.html">Installing to a Specific Local Repository Path</a> - </li> - <li class="none"> - <a href="examples/installing-secondary-artifacts.html">Installing Secondary Artifacts</a> - </li> - </ul> - <h5>Project Documentation</h5> - <ul> - <li class="collapsed"> - <a href="project-info.html">Project Information</a> - </li> - <li class="collapsed"> - <a href="project-reports.html">Project Reports</a> - </li> - </ul> - <h5>Maven Projects</h5> - <ul> - <li class="none"> - <a href="../../ant-tasks/index.html">Ant Tasks</a> - </li> - <li class="none"> - <a href="../../archetype/index.html">Archetype</a> - </li> - <li class="none"> - <a href="../../doxia/index.html">Doxia</a> - </li> - <li class="none"> - <a href="../../jxr/index.html">JXR</a> - </li> - <li class="none"> - <a href="../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../index.html">Maven 2 & 3</a> - </li> - <li class="none"> - <a href="../../pom/index.html">Parent POMs</a> - </li> - <li class="none"> - <a href="../index.html">Plugins</a> - </li> - <li class="none"> - <a href="../../plugin-tools/index.html">Plugin Tools</a> - </li> - <li class="none"> - <a href="../../scm/index.html">SCM</a> - </li> - <li class="none"> - <a href="../../shared/index.html">Shared Components</a> - </li> - <li class="none"> - <a href="../../skins/index.html">Skins</a> - </li> - <li class="none"> - <a href="../../surefire/index.html">Surefire</a> - </li> - <li class="none"> - <a href="../../wagon/index.html">Wagon</a> - </li> - </ul> - <h5>ASF</h5> - <ul> - <li class="none"> - <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> - </a> - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - - - <div class="section"> -<h2>install:install<a name="install:install"></a></h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.maven.plugins:maven-install-plugin:2.5.1:install</p> - -<p><b>Description</b>:</p> - -<div>Installs the project's main artifact, and any other artifacts -attached by other plugins in the lifecycle, to the local -repository.</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>Requires a Maven project to be executed.</li> - -<li>The goal is thread-safe and supports parallel builds.</li> - -<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html";>lifecycle phase</a>: <tt>install</tt>.</li> - </ul> - -<div class="section"> -<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - -<table class="bodyTable" border="0"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><b><a href="#createChecksum">createChecksum</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>2.2</tt></td> - -<td>Flag whether to create checksums (MD5, SHA-1) or not.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>createChecksum</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#installAtEnd">installAtEnd</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>2.5</tt></td> - -<td>Whether every project should be deployed during its own -deploy-phase or at the end of the multimodule build. If set to -<tt>true</tt> and the build fails, none of the reactor projects -is deployed<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>installAtEnd</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#skip">skip</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>2.4</tt></td> - -<td>Set this to <tt>true</tt> to bypass artifact installation. Use -this for artifacts that does not need to be installed in the local -repository.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.install.skip</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Whether to update the metadata to make the artifact a release -version.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3>Parameter Details<a name="Parameter_Details"></a></h3> - -<p><b><a name="createChecksum">createChecksum</a>:</b></p> - -<div>Flag whether to create checksums (MD5, SHA-1) or not.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Since</b>: <tt>2.2</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>createChecksum</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="installAtEnd">installAtEnd</a>:</b></p> - -<div>Whether every project should be deployed during its own -deploy-phase or at the end of the multimodule build. If set to -<tt>true</tt> and the build fails, none of the reactor projects -is deployed</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Since</b>: <tt>2.5</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>installAtEnd</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="skip">skip</a>:</b></p> - -<div>Set this to <tt>true</tt> to bypass artifact installation. Use -this for artifacts that does not need to be installed in the local -repository.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Since</b>: <tt>2.4</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>maven.install.skip</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> - -<div>Whether to update the metadata to make the artifact a release -version.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul> - </div> - </div> - - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright"> - © 2004-2013 - The Apache Software Foundation - - - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. - Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- + | Generated by Apache Maven Doxia at 2014-08-27 + | Rendered using Apache Maven Stylus Skin 1.5 +--> +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <title>Apache Maven Install Plugin - + install:install</title> + <style type="text/css" media="all"> + @import url("./css/maven-base.css"); + @import url("./css/maven-theme.css"); + @import url("./css/site.css"); + </style> + <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20140827" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + +<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> + +<script type="text/javascript">_uacct = "UA-140879-1"; + urchinTracker();</script> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../" id="bannerLeft"> + <img src="../../images/apache-maven-project-2.png" alt="" /> + </a> + <span id="bannerRight"> + <img src="../../images/maven-logo-2.gif" alt="" /> + </span> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + <div class="xleft"> + <a href="http://www.apache.org/"; class="externalLink">Apache</a> + > + <a href="../../index.html">Maven</a> + > + <a href="../index.html">Plugins</a> + > + <a href="./">Apache Maven Install Plugin</a> + > + + install:install + </div> + <div class="xright"> + Last Published: 2014-08-27 + | Version: 2.5.2 + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + <h5>Overview</h5> + <ul> + <li class="none"> + <a href="index.html">Introduction</a> + </li> + <li class="none"> + <a href="plugin-info.html">Goals</a> + </li> + <li class="none"> + <a href="usage.html">Usage</a> + </li> + <li class="none"> + <a href="faq.html">FAQ</a> + </li> + <li class="none"> + <a href="http://www.apache.org/licenses/"; class="externalLink">License</a> + </li> + <li class="none"> + <a href="download.html">Download</a> + </li> + </ul> + <h5>Examples</h5> + <ul> + <li class="none"> + <a href="examples/custom-pom-installation.html">Installing Artifact with Custom POM</a> + </li> + <li class="none"> + <a href="examples/generic-pom-generation.html">Generating Generic POM</a> + </li> + <li class="none"> + <a href="examples/installing-checksums.html">Creating Checksums</a> + </li> + <li class="none"> + <a href="examples/update-release-info.html">Updating Release Info</a> + </li> + <li class="none"> + <a href="examples/specific-local-repo.html">Installing to a Specific Local Repository Path</a> + </li> + <li class="none"> + <a href="examples/installing-secondary-artifacts.html">Installing Secondary Artifacts</a> + </li> + </ul> + <h5>Project Documentation</h5> + <ul> + <li class="collapsed"> + <a href="project-info.html">Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html">Project Reports</a> + </li> + </ul> + <h5>Maven Projects</h5> + <ul> + <li class="none"> + <a href="../../ant-tasks/index.html">Ant Tasks</a> + </li> + <li class="none"> + <a href="../../archetype/index.html">Archetype</a> + </li> + <li class="none"> + <a href="../../doxia/index.html">Doxia</a> + </li> + <li class="none"> + <a href="../../jxr/index.html">JXR</a> + </li> + <li class="none"> + <a href="../../maven-1.x/index.html">Maven 1.x</a> + </li> + <li class="none"> + <a href="../../index.html">Maven 2 & 3</a> + </li> + <li class="none"> + <a href="../../pom/index.html">Parent POMs</a> + </li> + <li class="none"> + <a href="../index.html">Plugins</a> + </li> + <li class="none"> + <a href="../../plugin-tools/index.html">Plugin Tools</a> + </li> + <li class="none"> + <a href="../../scm/index.html">SCM</a> + </li> + <li class="none"> + <a href="../../shared/index.html">Shared Components</a> + </li> + <li class="none"> + <a href="../../skins/index.html">Skins</a> + </li> + <li class="none"> + <a href="../../surefire/index.html">Surefire</a> + </li> + <li class="none"> + <a href="../../wagon/index.html">Wagon</a> + </li> + </ul> + <h5>ASF</h5> + <ul> + <li class="none"> + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> + </li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> + </a> + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + <div class="section"> +<h2>install:install<a name="install:install"></a></h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.maven.plugins:maven-install-plugin:2.5.2:install</p> + +<p><b>Description</b>:</p> + +<div>Installs the project's main artifact, and any other artifacts +attached by other plugins in the lifecycle, to the local +repository.</div> + +<p><b>Attributes</b>:</p> + +<ul> + +<li>Requires a Maven project to be executed.</li> + +<li>The goal is thread-safe and supports parallel builds.</li> + +<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html";>lifecycle phase</a>: <tt>install</tt>.</li> + </ul> + +<div class="section"> +<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> + +<table class="bodyTable" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td><b><a href="#createChecksum">createChecksum</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>2.2</tt></td> + +<td>Flag whether to create checksums (MD5, SHA-1) or not.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>createChecksum</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#installAtEnd">installAtEnd</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>2.5</tt></td> + +<td>Whether every project should be installed during its own +install-phase or at the end of the multimodule build. If set to +<tt>true</tt> and the build fails, none of the reactor projects +is installed. <b>(experimental)</b><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>installAtEnd</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#skip">skip</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>2.4</tt></td> + +<td>Set this to <tt>true</tt> to bypass artifact installation. Use +this for artifacts that does not need to be installed in the local +repository.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.install.skip</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>-</tt></td> + +<td>Whether to update the metadata to make the artifact a release +version.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> + </tr> + </table> + </div> + +<div class="section"> +<h3>Parameter Details<a name="Parameter_Details"></a></h3> + +<p><b><a name="createChecksum">createChecksum</a>:</b></p> + +<div>Flag whether to create checksums (MD5, SHA-1) or not.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Since</b>: <tt>2.2</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>createChecksum</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="installAtEnd">installAtEnd</a>:</b></p> + +<div>Whether every project should be installed during its own +install-phase or at the end of the multimodule build. If set to +<tt>true</tt> and the build fails, none of the reactor projects +is installed. <b>(experimental)</b></div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Since</b>: <tt>2.5</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>installAtEnd</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="skip">skip</a>:</b></p> + +<div>Set this to <tt>true</tt> to bypass artifact installation. Use +this for artifacts that does not need to be installed in the local +repository.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Since</b>: <tt>2.4</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>maven.install.skip</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> + +<div>Whether to update the metadata to make the artifact a release +version.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul> + </div> + </div> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + © 2004-2014 + The Apache Software Foundation + + - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. + Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> </html> \ No newline at end of file
