Files
maven-plugins/jar/xdocs/properties.xml
T
2003-04-12 02:08:02 +00:00

356 lines
11 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<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="Compile Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.compile.aspects</td>
<td>Yes</td>
<td>
Specifies that Aspects are included during compilation.
Used by the "java:compile" goal.
The default value is <code>false</code>. Please
refer to the <a href="http://www.aspectj.org/">AspectJ</a>
web site for more information on Aspect-Oriented
Programming.
</td>
</tr>
<tr>
<td>maven.compile.compilerargs</td>
<td>Yes</td>
<td>
<p>
Provides arguments to a compiler when <code>maven.compile.fork</code>
is set to true
</p>
<p>
Corresponds to the nested <code>compilerarg</code> element for the ant
<a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
task.
</p>
</td>
</tr>
<tr>
<td>maven.compile.debug</td>
<td>Yes</td>
<td>
Specifies wether to include debugging information in the compiled
class files; the default value is <code>on</code>.
Used by the "java:compile" goal.
</td>
</tr>
<tr>
<td>maven.compile.deprecation</td>
<td>Yes</td>
<td>
Specifies wether source should be compiled with deprecation
information; the default value is <code>off</code>.
Used by the "java:compile" goal.
</td>
</tr>
<tr>
<td>maven.compile.encoding</td>
<td>Yes</td>
<td>
<p>
Sets the encoding of the .java files being compiled
</p>
<p>
Corresponds to the <code>encoding</code> attribute for the ant
<a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
task.
</p>
</td>
</tr>
<tr>
<td>maven.compile.executable</td>
<td>Yes</td>
<td>
<p>
Names the program to be invoked as the java compiler
</p>
<p>
Corresponds to the <code>executable</code> attribute for the ant
<a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
task.
</p>
</td>
</tr>
<tr>
<td>maven.compile.fork</td>
<td>Yes</td>
<td>
<p>
Runs the compiler in a separate process
</p>
<p>
Corresponds to the <code>fork</code> attribute for the ant
<a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
task.
</p>
</td>
</tr>
<tr>
<td>maven.compile.optimize</td>
<td>Yes</td>
<td>
Specifies whether source should be compiled with optimization; the
default value is <code>off</code>.
Used by the "java:compile" goal.
</td>
</tr>
<tr>
<td>maven.compile.source</td>
<td>Yes</td>
<td>
<p>
Provide source compatibility with a specific release
</p>
<p>
Corresponds to the <code>source</code> attribute for the ant
<a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
task.
</p>
</td>
</tr>
<tr>
<td>maven.compile.src.set</td>
<td>Yes</td>
<td>
The source directories maven uses to compile java code.
</td>
</tr>
<tr>
<td>maven.compile.target</td>
<td>Yes</td>
<td>
<p>
Generate class files for a specific JVM version
</p>
<p>
Corresponds to the <code>target</code> attribute for the ant
<a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
task.
</p>
</td>
</tr>
<tr>
<td>maven.compile.verbose</td>
<td>Yes</td>
<td>
<p>
Asks the compiler for verbose output
</p>
<p>
Corresponds to the <code>verbose</code> attribute for the ant
<a href="http://ant.apache.org/manual/CoreTasks/javac.html">javac</a>
task.
</p>
</td>
</tr>
<tr>
<td>pom.build.sourceModifications</td>
<td>Yes</td>
<td>
This property is the list of the
<source><![CDATA[
<build>
<sourceModification>
<sourceModification>
<className></className>
<excludes>
<exclude></exclude>
</excludes>
</sourceModification>
</sourceModification>
</build>
]]></source>
source modifications in your
<a href="http://maven.apache.org/reference/project-descriptor.html">
project descriptor</a>. This property is used during compilation to exclude or
include classes from compilation depending on whether a named class is available
</td>
</tr>
</table>
</section>
<section name="Jar Settings">
<table>
<tr>
<td>maven.has.jar.resource.patterns</td>
<td>Yes</td>
<td>
This is a calculated property based on the value of the
<source><![CDATA[
<build>
<resources>
</resources>
</build>
]]></source>
section of your
<a href="http://maven.apache.org/reference/project-descriptor.html">
project descriptor</a>. If there are <code>includes</code> or <code>excludes</code>
elements, this property will be set to true
</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 "java:jar" goal.
</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.extensions.add</td>
<td>Yes</td>
<td>
Tells maven to add extension information the the jar manifest.
This can cause some applications to break, so it has been disabled by default.
Set to 'true' 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 MainClass attribute will be added to the manifest.
</td>
</tr>
<tr>
<td>maven.jarResources.basedir</td>
<td>Yes</td>
<td>
The base directory from which resources to be included in a jar can be found.
Defaults to the base directory of the project.
</td>
</tr>
<tr>
<td>maven.jar.resources.set</td>
<td>Yes</td>
<td>
This is the Ant <code>patternset</code> of all the <code>include</code>s and
<code>exclude</code>s from the
<source><![CDATA[
<build>
<resources>
</resources>
</build>
]]></source>
section of your
<a href="http://maven.apache.org/reference/project-descriptor.html">
project descriptor</a>
</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 maven
</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>java: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>${project.id}-${project.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>java: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>