Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame^] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | |
| 3 | <!-- Generated by Apache Maven Doxia at Jul 5, 2011 --> |
| 4 | |
| 5 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 6 | |
| 7 | <head> |
| 8 | |
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| 10 | |
| 11 | <title>Maven Bundle Plugin - Plugin Documentation</title> |
| 12 | |
| 13 | <style type="text/css" media="all"> |
| 14 | |
| 15 | @import url("./css/maven-base.css"); |
| 16 | |
| 17 | @import url("./css/maven-theme.css"); |
| 18 | |
| 19 | @import url("./css/site.css"); |
| 20 | |
| 21 | </style> |
| 22 | |
| 23 | <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| 24 | |
| 25 | <meta name="Date-Revision-yyyymmdd" content="20110705" /> |
| 26 | |
| 27 | <meta http-equiv="Content-Language" content="en" /> |
| 28 | |
| 29 | |
| 30 | |
| 31 | </head> |
| 32 | |
| 33 | <body class="composite"> |
| 34 | |
| 35 | <div id="banner"> |
| 36 | |
| 37 | <div id="bannerLeft"> |
| 38 | |
| 39 | Maven Bundle Plugin |
| 40 | |
| 41 | </div> |
| 42 | |
| 43 | <div class="clear"> |
| 44 | |
| 45 | <hr/> |
| 46 | |
| 47 | </div> |
| 48 | |
| 49 | </div> |
| 50 | |
| 51 | <div id="breadcrumbs"> |
| 52 | |
| 53 | |
| 54 | |
| 55 | |
| 56 | |
| 57 | <div class="xleft"> |
| 58 | |
| 59 | <span id="publishDate">Last Published: 2011-07-05</span> |
| 60 | |
| 61 | | <span id="projectVersion">Version: 2.3.5</span> |
| 62 | |
| 63 | </div> |
| 64 | |
| 65 | <div class="xright"> |
| 66 | |
| 67 | |
| 68 | |
| 69 | </div> |
| 70 | |
| 71 | <div class="clear"> |
| 72 | |
| 73 | <hr/> |
| 74 | |
| 75 | </div> |
| 76 | |
| 77 | </div> |
| 78 | |
| 79 | <div id="leftColumn"> |
| 80 | |
| 81 | <div id="navcolumn"> |
| 82 | |
| 83 | |
| 84 | |
| 85 | |
| 86 | |
| 87 | <h5>Overview</h5> |
| 88 | |
| 89 | <ul> |
| 90 | |
| 91 | <li class="none"> |
| 92 | |
| 93 | <a href="index.html" title="Introduction">Introduction</a> |
| 94 | |
| 95 | </li> |
| 96 | |
| 97 | <li class="none"> |
| 98 | |
| 99 | <strong>Goals</strong> |
| 100 | |
| 101 | </li> |
| 102 | |
| 103 | <li class="none"> |
| 104 | |
| 105 | <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Maven+Bundle+Plugin+%28BND%29" class="externalLink" title="Wiki">Wiki</a> |
| 106 | |
| 107 | </li> |
| 108 | |
| 109 | <li class="none"> |
| 110 | |
| 111 | <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Bundle+Plugin+FAQ" class="externalLink" title="FAQ">FAQ</a> |
| 112 | |
| 113 | </li> |
| 114 | |
| 115 | <li class="none"> |
| 116 | |
| 117 | <a href="jira-report.html" title="Release Notes">Release Notes</a> |
| 118 | |
| 119 | </li> |
| 120 | |
| 121 | </ul> |
| 122 | |
| 123 | <h5>Project Documentation</h5> |
| 124 | |
| 125 | <ul> |
| 126 | |
| 127 | <li class="collapsed"> |
| 128 | |
| 129 | <a href="project-info.html" title="Project Information">Project Information</a> |
| 130 | |
| 131 | </li> |
| 132 | |
| 133 | <li class="expanded"> |
| 134 | |
| 135 | <a href="project-reports.html" title="Project Reports">Project Reports</a> |
| 136 | |
| 137 | <ul> |
| 138 | |
| 139 | <li class="none"> |
| 140 | |
| 141 | <a href="jira-report.html" title="JIRA Report">JIRA Report</a> |
| 142 | |
| 143 | </li> |
| 144 | |
| 145 | <li class="none"> |
| 146 | |
| 147 | <strong>Plugin Documentation</strong> |
| 148 | |
| 149 | </li> |
| 150 | |
| 151 | <li class="none"> |
| 152 | |
| 153 | <a href="xref/index.html" title="Source Xref">Source Xref</a> |
| 154 | |
| 155 | </li> |
| 156 | |
| 157 | <li class="none"> |
| 158 | |
| 159 | <a href="surefire-report.html" title="Surefire Report">Surefire Report</a> |
| 160 | |
| 161 | </li> |
| 162 | |
| 163 | <li class="none"> |
| 164 | |
| 165 | <a href="xref-test/index.html" title="Test Source Xref">Test Source Xref</a> |
| 166 | |
| 167 | </li> |
| 168 | |
| 169 | </ul> |
| 170 | |
| 171 | </li> |
| 172 | |
| 173 | </ul> |
| 174 | |
| 175 | <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| 176 | |
| 177 | <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
| 178 | |
| 179 | </a> |
| 180 | |
| 181 | |
| 182 | |
| 183 | |
| 184 | |
| 185 | </div> |
| 186 | |
| 187 | </div> |
| 188 | |
| 189 | <div id="bodyColumn"> |
| 190 | |
| 191 | <div id="contentBox"> |
| 192 | |
| 193 | <a name="Plugin_Documentation"></a><div class="section"><h2>Plugin Documentation<a name="Plugin_Documentation"></a></h2><p>Goals available for this plugin:</p><table border="0" class="bodyTable"><tr class="a"><th>Goal</th><th>Description</th></tr><tr class="b"><td><a href="ant-mojo.html">bundle:ant</a></td><td>Generate Ant script to create the bundle (you should run ant:ant |
| 194 | first).</td></tr><tr class="a"><td><a href="bundle-mojo.html">bundle:bundle</a></td><td>Create an OSGi bundle from Maven project</td></tr><tr class="b"><td><a href="bundleall-mojo.html">bundle:bundleall</a></td><td><strong>Deprecated.</strong> The bundleall goal is no longer supported and may be removed in a |
| 195 | future release</td></tr><tr class="a"><td><a href="clean-mojo.html">bundle:clean</a></td><td>Clean an OBR repository by finding and removing missing resources.</td></tr><tr class="b"><td><a href="cleanVersions-mojo.html">bundle:cleanVersions</a></td><td>No description.</td></tr><tr class="a"><td><a href="deploy-mojo.html">bundle:deploy</a></td><td>Deploys bundle details to a remote OBR repository (life-cycle goal)</td></tr><tr class="b"><td><a href="deploy-file-mojo.html">bundle:deploy-file</a></td><td>Deploys bundle details to a remote OBR repository (command-line |
| 196 | goal)</td></tr><tr class="a"><td><a href="index-mojo.html">bundle:index</a></td><td>Index the content of a maven repository using OBR</td></tr><tr class="b"><td><a href="install-mojo.html">bundle:install</a></td><td>Installs bundle details in the local OBR repository (life-cycle |
| 197 | goal)</td></tr><tr class="a"><td><a href="install-file-mojo.html">bundle:install-file</a></td><td>Installs bundle details in the local OBR repository (command-line |
| 198 | goal)</td></tr><tr class="b"><td><a href="instructions-mojo.html">bundle:instructions</a></td><td>Generate BND instructions for this project</td></tr><tr class="a"><td><a href="manifest-mojo.html">bundle:manifest</a></td><td>Generate an OSGi manifest for this project</td></tr><tr class="b"><td><a href="remote-clean-mojo.html">bundle:remote-clean</a></td><td>Clean a remote repository file. It just looks for every resources |
| 199 | and check that pointed file exists.</td></tr><tr class="a"><td><a href="wrap-mojo.html">bundle:wrap</a></td><td><strong>Deprecated.</strong> The wrap goal is no longer supported and may be removed in a future |
| 200 | release</td></tr></table><a name="System_Requirements"></a><div class="section"><h3>System Requirements<a name="System_Requirements"></a></h3><p>The following specifies the minimum requirements to run this Maven plugin:</p><table border="0" class="bodyTable"><tr class="b"><td>Maven</td><td>2.0</td></tr><tr class="a"><td>JDK</td><td>1.5</td></tr><tr class="b"><td>Memory</td><td>No minimum requirement.</td></tr><tr class="a"><td>Disk Space</td><td>No minimum requirement.</td></tr></table></div><a name="Usage"></a><div class="section"><h3>Usage<a name="Usage"></a></h3><p>You should specify the version in your project's plugin configuration:</p><div class="source"><pre><project> |
| 201 | ... |
| 202 | <build> |
| 203 | <!-- To define the plugin version in your parent POM --> |
| 204 | <pluginManagement> |
| 205 | <plugins> |
| 206 | <plugin> |
| 207 | <groupId>org.apache.felix</groupId> |
| 208 | <artifactId>maven-bundle-plugin</artifactId> |
| 209 | <version>2.3.5</version> |
| 210 | </plugin> |
| 211 | ... |
| 212 | </plugins> |
| 213 | </pluginManagement> |
| 214 | <!-- To use the plugin goals in your POM or parent POM --> |
| 215 | <plugins> |
| 216 | <plugin> |
| 217 | <groupId>org.apache.felix</groupId> |
| 218 | <artifactId>maven-bundle-plugin</artifactId> |
| 219 | <version>2.3.5</version> |
| 220 | </plugin> |
| 221 | ... |
| 222 | </plugins> |
| 223 | </build> |
| 224 | ... |
| 225 | </project> |
| 226 | </pre></div><p>For more information, see <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">"Guide to Configuring Plug-ins"</a></p></div></div> |
| 227 | |
| 228 | </div> |
| 229 | |
| 230 | </div> |
| 231 | |
| 232 | <div class="clear"> |
| 233 | |
| 234 | <hr/> |
| 235 | |
| 236 | </div> |
| 237 | |
| 238 | <div id="footer"> |
| 239 | |
| 240 | <div class="xright">Copyright © 2006-2011 |
| 241 | |
| 242 | <a href="http://www.apache.org/">The Apache Software Foundation</a>. |
| 243 | |
| 244 | All Rights Reserved. |
| 245 | |
| 246 | |
| 247 | |
| 248 | </div> |
| 249 | |
| 250 | <div class="clear"> |
| 251 | |
| 252 | <hr/> |
| 253 | |
| 254 | </div> |
| 255 | |
| 256 | </div> |
| 257 | |
| 258 | </body> |
| 259 | |
| 260 | </html> |
| 261 | |