maven-plugins/dist/xdocs/properties.xml
ltheussl 81fd3cb557 PR: MPDIST-20
Submitted by: Phil Steitz
Fix combined javadoc classpath in dist:multiproject-bin.
New properties maven.dist.src.includes and maven.dist.bin.includes.
Removed the maven.dist.src.include property.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@447987 13f79535-47bb-0310-9956-ffa450edef68
2006-09-19 21:49:56 +00:00

134 lines
5.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>Distribution Properties</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name="Distribution Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.dist.assembly.dir</td>
<td>yes - default is ${maven.build.dir}/${maven.final.name}</td>
<td>The base directory for the default assembly properties</td>
</tr>
<tr>
<td>maven.dist.bin.archive.dir</td>
<td>yes - default is ${maven.dist.assembly.dir}/bin</td>
<td>The directory where the binary archive is constructed from</td>
</tr>
<tr>
<td>maven.dist.src.archive.dir</td>
<td>yes - default is ${maven.dist.assembly.dir}/src</td>
<td>The directory where the source archive is constructed from</td>
</tr>
<tr>
<td>maven.dist.bin.assembly.dir</td>
<td>yes - default is ${maven.dist.assembly.dir}/bin/${maven.final.name}</td>
<td>The directory where the binaries are copied to so that it can be archived</td>
</tr>
<tr>
<td>maven.dist.src.assembly.dir</td>
<td>yes - default is ${maven.dist.assembly.dir}/src/${maven.final.name}</td>
<td>The directory where the sources are copied to so that it can be archived</td>
</tr>
<tr>
<td>maven.dist.include.dirs</td>
<td>yes</td>
<td>
Comma separated list of directories (relative to ${basedir}) that will be
included recursively in the distributions.
</td>
</tr>
<tr>
<td>maven.dist.dir</td>
<td>yes - default is ${maven.build.dir}/distributions</td>
<td>The target directory that the final archive is placed in</td>
</tr>
<tr>
<td>maven.dist.bin.artifact</td>
<td>yes - default is <code>${maven.final.name}.jar</code>.</td>
<td>
<strong>DEPRECATED</strong>: this property is not used anymore.
The name of the binary artifact depends on its type
and is given by
<code>${maven.[jar,ear,rar,war,ejb].final.name}</code>.
</td>
</tr>
<tr>
<td>maven.dist.bin.artifact.type</td>
<td>yes - default is <code>jar</code>.</td>
<td>
The type of artifact to be included in the binary distribution.
Possible values are jar, rar, war, ear and ejb.
</td>
</tr>
<tr>
<td>maven.dist.bin.include.site</td>
<td>yes - default is <code>true</code>.</td>
<td>
Whether to run <code>maven site</code> and include the site docs in the binary distribution, or not.
If set to <code>false</code>, only the javadocs will be included.
</td>
</tr>
<tr>
<td>maven.dist.crlf.filter</td>
<td>yes - default is <code>"**/*.txt"</code>.</td>
<td>Filter specifying files to convert to CRLF (Windows style) line endings in zip distributions.</td>
</tr>
<tr>
<td>maven.dist.lf.filter</td>
<td>yes - default is no filter applied (no change to any files).</td>
<td>Filter specifying files to convert to LF line endings in both tar
and zip distributions. This filter is applied before the crlf
filter, so in zip archives, the crlf filter will take precendence
for files that satisfy both filters.</td>
</tr>
<tr>
<td>maven.dist.formats</td>
<td>yes - default is <code>zip,tgz</code>.</td>
<td>
A comma-separated list of distribution formats to build.
Possible values are tgz and zip.
</td>
</tr>
<tr>
<td>maven.dist.bin.includes</td>
<td>yes - default is <code>README*,LICENSE*,NOTICE*</code>.</td>
<td>
A comma-separated list of files to include in the binary distribtion.
</td>
</tr>
<tr>
<td>maven.dist.src.includes</td>
<td>yes - default is <code>README*,LICENSE*,NOTICE*,project.properties,maven.xml,project.xml</code>.</td>
<td>
A comma-separated list of files to include in the source distribtion.
</td>
</tr>
</table>
</section>
</body>
</document>