maven-plugins/site/xdocs/properties.xml

100 lines
3.4 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>Site Properties</title>
<author email="smor@apache.org">Stéphane MOR</author>
<author email="alef@jteam.nl">Alef Arendsen</author>
</properties>
<body>
<section name="Site Properties">
<table>
<tr>
<td>maven.scp.executable</td>
<td>Yes</td>
<td>
Specifies the name (and possibly location) of the remote secure
copy executable to use (SCP). This is used by the
"site:deploy" goal.
The default value is <code>scp</code> (i.e. an executable
named <code>scp</code> must be in your path).
</td>
</tr>
<tr>
<td>maven.scp.args</td>
<td>Yes</td>
<td>
Specifies optional parameters that are passed to the scp executable.
</td>
</tr>
<tr>
<td>maven.ssh.executable</td>
<td>Yes</td>
<td>
Specifies the name (and possibly location) of the remote secure
shell executable to use (SSH). This is used by the "site:deploy" goal.
The default value is <code>ssh</code> (i.e. an executable
named <code>ssh</code> must be in your path).
</td>
</tr>
<tr>
<td>maven.ssh.args</td>
<td>Yes</td>
<td>
Specifies optional parameters that are passed to the ssh executable.
</td>
</tr>
<tr>
<td>maven.site.deploy.method</td>
<td>Yes</td>
<td>
Specifies the method to use when deploying the site. Possible values are:
<code>fs</code> and <code>ssh</code>. The ssh method is the good old
method which has always been used within Maven. When you specify
<code>fs</code> the site will be deployed on a local file system.
The <code>siteDirectory</code> property will be used to copy the site to.
</td>
</tr>
<tr>
<td>maven.site.tar.executable</td>
<td>Yes</td>
<td>
Specifies the executable to use for 'tar' when deploying the site.
Defaults to <code>tar</code>. Override this property if your
system has a default version of tar that is failing.
</td>
</tr>
<tr>
<td>maven.site.gunzip.executable</td>
<td>Yes</td>
<td>
Specifies the executable to use for 'gunzip' when deploying the site.
Defaults to <code>gunzip</code>. Override this property if your
system has a default version of gunzip that is failing.
</td>
</tr>
</table>
</section>
</body>
</document>