Doc improvement

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@529070 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier 2007-04-15 20:57:54 +00:00
parent ae35447558
commit 370f5275e5

View File

@ -183,12 +183,17 @@
</table> </table>
</subsection> </subsection>
</section> </section>
<section name="Sign Artifacts - GPG Settings"> <section name="Generate a code signing key (OpenPGP Compatible Signature)">
<p> <p>
The artifact plugin allows to automatically sign your artifacts with GPG when you deploy a release. You'll find The artifact plugin allows to automatically sign your artifacts with GPG when you deploy a release. You'll find
more informations about signing releases here : more informations about signing releases here :
<a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a> <a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a>
</p> </p>
<p>
You have to install
<a href="http://www.gnupg.org/" #>GNU Privacy Guard</a>
for your your platform and add it in your PATH.
</p>
<table> <table>
<tr> <tr>
<th>Property name</th> <th>Property name</th>
@ -197,22 +202,40 @@
</tr> </tr>
<tr> <tr>
<td>maven.artifact.gpg.skip</td> <td>maven.artifact.gpg.skip</td>
<td>Do you want to skip the signing step? Default : true. Before to enable it you have to correctly setup GPG. You need to have a key and <code>gpg</code> must be in your PATH.</td> <td>
Do you want to skip the signing step? Default : true. Before to enable it you have to correctly setup GPG.
You need to have a key and
<code>gpg</code>
must be in your PATH.
</td>
<td>Yes</td> <td>Yes</td>
</tr> </tr>
<tr> <tr>
<td>maven.artifact.gpg.passphrase</td> <td>maven.artifact.gpg.passphrase</td>
<td>The passphrase to use when signing. Default : not defined. If not defined and signing activated, the plugin will prompt for the passphrase.</td> <td>
The passphrase to use when signing. Default : not defined. If not defined and signing activated, the plugin
will prompt for the passphrase.
</td>
<td>Yes</td> <td>Yes</td>
</tr> </tr>
<tr> <tr>
<td>maven.artifact.gpg.keyname</td> <td>maven.artifact.gpg.keyname</td>
<td>The "name" of the key to sign with. Passed to gpg as <code>--local-user</code>. Default : not defined. The default key is used.</td> <td>
The "name" of the key to sign with. Passed to gpg as
<code>--local-user</code>
. Default : not defined. The default key is used.
</td>
<td>Yes</td> <td>Yes</td>
</tr> </tr>
<tr> <tr>
<td>maven.artifact.gpg.useagent</td> <td>maven.artifact.gpg.useagent</td>
<td>Passes <code>--use-agent</code> or <code>--no-use-agent</code> to gpg. If using an agent, the password is optional as the agent will provide it. Default : false.</td> <td>
Passes
<code>--use-agent</code>
or
<code>--no-use-agent</code>
to gpg. If using an agent, the password is optional as the agent will provide it. Default : false.
</td>
<td>Yes</td> <td>Yes</td>
</tr> </tr>
</table> </table>