bad86c1bca
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@374800 13f79535-47bb-0310-9956-ffa450edef68
124 lines
3.9 KiB
XML
124 lines
3.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
<!--
|
|
/*
|
|
* 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>LinkCheck Plugin Properties</title>
|
|
</properties>
|
|
<body>
|
|
<section name="LinkCheck Plugin Properties">
|
|
<table>
|
|
<tr>
|
|
<th>Property</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.cache</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Determines where the cache for the linkchecking is stored.
|
|
Default value is
|
|
<code>${maven.build.dir}/linkcheck/linkcheck.cache</code>.
|
|
This means that a clean build deletes the cache. If you have
|
|
an extremely large document tree this can have a negative effect
|
|
on performance.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.failonerror</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Determines whether the build should fail on broken links or not.
|
|
Defaults to <code>false</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.exclude</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
List of urls to exclude from check, delimited by comma, space or tab.
|
|
Those urls in files that start with one of the excluded urls will be ignored.
|
|
Defaults to <code>pom.repository.url</code>.
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td>maven.linkcheck.proxy.host</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The IP or address of your proxy.
|
|
Defaults to <code>maven.proxy.host</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.proxy.port</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The port number of your proxy.
|
|
Defaults to <code>maven.proxy.port</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.proxy.username</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
User name if your proxy requires authentication.
|
|
Defaults to <code>maven.proxy.username</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.proxy.password</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Password if your proxy requires authentication.
|
|
Defaults to <code>maven.proxy.password</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.proxy.ntlm.host</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The host to use if you are using NTLM authentication.
|
|
Defaults to <code>maven.proxy.ntlm.host</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.proxy.ntlm.domain</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The NT domain to use if you are using NTLM authentication.
|
|
Defaults to <code>maven.proxy.ntlm.domain</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.linkcheck.method</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The method to use to test pages. The value should be 'head' or 'get'.
|
|
In some cases (particularly with some proxies) the head method doesn't work witl all servers.
|
|
The get method is slower but safe. Defaults to <code>head</code>.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document> |