maven-plugins/jar/xdocs/properties.xml
ltheussl 8fa22c2db3 PR: MPJAR-15
Submitted by: Matt Finn
Include Implementation-Vendor-Id attribute for dependencies in manifest.


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@392995 13f79535-47bb-0310-9956-ffa450edef68
2006-04-10 17:31:50 +00:00

243 lines
8.1 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Properties</title>
<author email="smor@apache.org">Stéphane MOR</author>
<author email="dion@multitask.com.au">dIon Gillard</author>
</properties>
<body>
<section name="Jar Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.jar.final.name</td>
<td>Yes</td>
<td>
Name of the generated JAR file.
Defaults to ${maven.final.name}.jar.
</td>
</tr>
<tr>
<td>maven.jar.excludes</td>
<td>Yes</td>
<td>
Specifies a list of patterns to exclude from the jar process.
The default value is <code>**/package.html</code>, and is used
by the <code>jar:jar</code> goal.
</td>
</tr>
<tr>
<td>maven.jar.includes</td>
<td>Yes</td>
<td>
Specifies a list of patterns to include with the jar process.
The default value is <code>null</code>.
</td>
</tr>
<tr>
<td>maven.jar.index</td>
<td>Yes</td>
<td>
Whether to create an index list to speed up classloading.
This is a JDK 1.3+ specific feature. Defaults to false.
</td>
</tr>
<tr>
<td>maven.jar.manifest</td>
<td>Yes</td>
<td>
Specifies the manifest to be used in the creation of a jar.
This file is 'merged' with the default manifest created by
Maven. Any values specified in the file referenced by this
property will override Maven's defaults.
</td>
</tr>
<tr>
<td>maven.jar.manifest.classpath.add</td>
<td>Yes</td>
<td>
Tells Maven to add classpath information to the jar manifest.
This can cause some applications to break, so it has been disabled by default.
Set to <code>true</code> to enable classpath information.
Only the dependency jars that have the property
<code>jar.manifest.classpath</code> set to <code>true</code>
will be added to the classpath information.
</td>
</tr>
<tr>
<td>maven.jar.manifest.extensions.add</td>
<td>Yes</td>
<td>
Tells Maven to add extension information to the jar manifest.
This can cause some applications to break, so it has been disabled by default.
An <code>Implementation-Vendor-Id</code> attribute will be added
for each dependency that has a <code>&lt;vendorId&gt;</code> element
set in its <code>&lt;properties&gt;</code> section.
Set to <code>true</code> to enable extension information.
</td>
</tr>
<tr>
<td>maven.jar.mainclass</td>
<td>Yes</td>
<td>
Specifies the Main-Class attribute for your manifest. If not set,
no Main-Class attribute will be added to the manifest.
</td>
</tr>
<tr>
<td>maven.jar.compress</td>
<td>Yes</td>
<td>Not only store data but also compress them, defaults to <code>true</code>.</td>
</tr>
<tr>
<td>maven.jar.manifest.attributes.list</td>
<td>Yes</td>
<td>
Used by the <code>jar:jar</code> goal to define additional
attributes to add to the manifest in addition to the other
entries already added.
Sample:
<source><![CDATA[
maven.jar.manifest.attributes.list = Foo-Attribute,Bar-Attribute
maven.jar.manifest.attribute.Foo-Attribute = I like bread and butter
maven.jar.manifest.attribute.Bar-Attribute = I like toast and jam
]]></source>
</td>
</tr>
<tr>
<td>maven.jar.manifest.groups.list</td>
<td>Yes</td>
<td>
Used by the <code>jar:jar</code> goal to define sections/groups
for the manifest. You can use this to seal classes
and add custom attributes to particular packages.
Sample:
<source><![CDATA[
maven.jar.manifest.groups.list = MyClass,MyPackage
maven.jar.manifest.MyClass.name = /com/mycompany/MyClass.class
maven.jar.manifest.MyClass.attributes.list = Sealed,Custom
maven.jar.manifest.MyClass.attribute.Sealed = true
maven.jar.manifest.MyClass.attribute.Custom = Anything I want
maven.jar.manifest.MyPackage.name = /com/mycompany/special
maven.jar.manifest.MyPackage.attributes.list = Sealed
maven.jar.manifest.MyPackage.attribute.Sealed = true
]]></source>
</td>
</tr>
</table>
</section>
<section name="Deploy Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.repo.central</td>
<td>Yes</td>
<td>
Central repository for maven artifacts.
</td>
</tr>
<tr>
<td>maven.repo.central.directory</td>
<td>Yes</td>
<td>
Directory to deploy jars into on the remote repository.
</td>
</tr>
<tr>
<td>maven.repo.local</td>
<td>Yes</td>
<td>
The local repository to store maven artifacts, including jar file
dependencies.
</td>
</tr>
<tr>
<td>maven.username</td>
<td>Yes</td>
<td>
This is the user name used to log in to the remote repository.
</td>
</tr>
<tr>
<td>maven.remote.group</td>
<td>Yes</td>
<td>
The name of the Unix group that should own deployed artifacts.
Default to <code>maven</code>.
</td>
</tr>
</table>
</section>
<section name="Other Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.build.dest</td>
<td>Yes</td>
<td>The directory for compiled classes.</td>
</tr>
<tr>
<td>maven.build.dir</td>
<td>Yes</td>
<td>
Used by the <code>jar:jar</code> goal for
<ul>
<li>a temporary manifest file, if one is not specified</li>
<li>the assembled jar file</li>
</ul>
</td>
</tr>
<tr>
<td>maven.dependency.classpath</td>
<td>Yes</td>
<td>
This property holds the Ant <code>path</code> of all the dependent jar
files listed in the <code>dependencies</code> block of your
<a href="http://maven.apache.org/reference/project-descriptor.html">
project descriptor</a>.
</td>
</tr>
<tr>
<td>maven.final.name</td>
<td>Yes</td>
<td>
Usually this property is set to <code>${pom.artifactId}-${pom.currentVersion}</code>
but the snapshot goal overwrites it to be the snapshot signature.
</td>
</tr>
<tr>
<td>user.name</td>
<td>Yes</td>
<td>
Used by the <code>jar:jar</code> goal as the default value of the
<code>Built-By</code> attribute of the manifest if one is not specified.
</td>
</tr>
</table>
</section>
</body>
</document>