generated from source

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@170040 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Leslie Porter 2005-05-13 15:37:20 +00:00
parent 5debf213f1
commit 2953fbb8c5
2 changed files with 0 additions and 1558 deletions

File diff suppressed because it is too large Load Diff

View File

@ -1,277 +0,0 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Settings</title>
</properties>
<body>
<section name="Settings">
<p>
User-specific configuration for maven. Includes things that should not
be distributed with the pom.xml file, such as developer identity, along with
local settings, like proxy information.</p>
<source>
&lt;<a href="#class_Settings">settings</a>&gt;
&lt;proxies&gt;
&lt;<a href="#class_Proxy">proxy</a>&gt;
&lt;active/&gt;
&lt;protocol/&gt;
&lt;username/&gt;
&lt;password/&gt;
&lt;port/&gt;
&lt;host/&gt;
&lt;nonProxyHosts/&gt;
&lt;/proxy&gt;
&lt;/proxies&gt;
&lt;servers&gt;
&lt;<a href="#class_Server">server</a>&gt;
&lt;id/&gt;
&lt;username/&gt;
&lt;password/&gt;
&lt;privateKey/&gt;
&lt;passphrase/&gt;
&lt;/server&gt;
&lt;/servers&gt;
&lt;mirrors&gt;
&lt;<a href="#class_Mirror">mirror</a>&gt;
&lt;id/&gt;
&lt;mirrorOf/&gt;
&lt;name/&gt;
&lt;url/&gt;
&lt;/mirror&gt;
&lt;/mirrors&gt;
&lt;profiles&gt;
&lt;<a href="#class_Profile">profile</a>&gt;
&lt;active/&gt;
&lt;localRepository/&gt;
&lt;offline/&gt;
&lt;/profile&gt;
&lt;/profiles&gt;
&lt;/settings&gt;
</source>
<a name="class_Settings"/>
<subsection name="settings">
<p>Root element of the user configuration file.</p>
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>proxies</code>
</td>
<td>
Configuration for different proxy profiles. Multiple proxy profiles
might come in handy for anyone working from a notebook or other
mobile platform, to enable easy switching of entire proxy
configurations by simply specifying the profile id, again either from
the command line or from the defaults section below.
</td>
</tr>
<tr>
<td>
<code>servers</code>
</td>
<td>
Configuration of server-specific settings, mainly authentication
method. This allows configuration of authentication on a per-server
basis.
</td>
</tr>
<tr>
<td>
<code>mirrors</code>
</td>
<td>
Configuration of download mirrors for repositories.
</td>
</tr>
<tr>
<td>
<code>profiles</code>
</td>
<td>
Configuration for different runtime profiles for maven itself. For
example, this will allow plugin developers to switch from a "work"
local repository to a "testing" local repository. It may also allow
configuration of such things as password keystore, etc. Once again,
the active profile will be switchable via either the defaults section
or the command line (read: system properties).
</td>
</tr>
</table>
</subsection>
<a name="class_Proxy"/>
<subsection name="proxy">
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>active</code>
</td>
<td>Whether this proxy configuration is the active one.</td>
</tr>
<tr>
<td>
<code>protocol</code>
</td>
<td>The proxy protocol.</td>
</tr>
<tr>
<td>
<code>username</code>
</td>
<td>The proxy user.</td>
</tr>
<tr>
<td>
<code>password</code>
</td>
<td>The proxy password.</td>
</tr>
<tr>
<td>
<code>port</code>
</td>
<td>The proxy port.</td>
</tr>
<tr>
<td>
<code>host</code>
</td>
<td>The proxy host.</td>
</tr>
<tr>
<td>
<code>nonProxyHosts</code>
</td>
<td>
The list of non-proxied hosts (usually
comma-delimited).
</td>
</tr>
</table>
</subsection>
<a name="class_Server"/>
<subsection name="server">
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>id</code>
</td>
<td>
The ID of this configuration for indicating the default or "active"
profile.
</td>
</tr>
<tr>
<td>
<code>username</code>
</td>
<td>The username used to authenticate.</td>
</tr>
<tr>
<td>
<code>password</code>
</td>
<td>
The password used in conjunction with the username to authenticate.
</td>
</tr>
<tr>
<td>
<code>privateKey</code>
</td>
<td>The private key location used to authenticate.</td>
</tr>
<tr>
<td>
<code>passphrase</code>
</td>
<td>
The passphrase used in conjunction with the privateKey to authenticate.
</td>
</tr>
</table>
</subsection>
<a name="class_Mirror"/>
<subsection name="mirror">
<p>
A download mirror for a given repository.
</p>
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>id</code>
</td>
<td>
The server ID of this mirror. This must -not- be the same as that of the repository you are mirroring.
</td>
</tr>
<tr>
<td>
<code>mirrorOf</code>
</td>
<td>
The server ID of the repository being mirrored, eg "central".
</td>
</tr>
<tr>
<td>
<code>name</code>
</td>
<td>
The optional name that describes the mirror.
</td>
</tr>
<tr>
<td>
<code>url</code>
</td>
<td>
The URL of the mirror repository.
</td>
</tr>
</table>
</subsection>
<a name="class_Profile"/>
<subsection name="profile">
<table>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>active</code>
</td>
<td>Whether this is the active maven profile.</td>
</tr>
<tr>
<td>
<code>localRepository</code>
</td>
<td>The local repository.</td>
</tr>
<tr>
<td>
<code>offline</code>
</td>
<td>Indicate whether maven should operate in offline mode full-time.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>