Author: dennisl
Date: Sat Apr 17 12:58:30 2010
New Revision: 935170
URL: http://svn.apache.org/viewvc?rev=935170&view=rev
Log:
Improve documentation.
Add missing <property environment="env"/> in ant task example.
Modified:
commons/sandbox/openpgp/trunk/src/site/apt/signer.apt
commons/sandbox/openpgp/trunk/src/site/apt/usage.apt
Modified: commons/sandbox/openpgp/trunk/src/site/apt/signer.apt
URL:
http://svn.apache.org/viewvc/commons/sandbox/openpgp/trunk/src/site/apt/signer.apt?rev=935170&r1=935169&r2=935170&view=diff
==============================================================================
--- commons/sandbox/openpgp/trunk/src/site/apt/signer.apt (original)
+++ commons/sandbox/openpgp/trunk/src/site/apt/signer.apt Sat Apr 17 12:58:30
2010
@@ -8,17 +8,16 @@
Signer Ant Task
- This task will be packaged in the commons-openpgp.jar.
- It will use the bouncy castle jars at runtime. It has been tested with
bcpg-jdk12-134.jar and bcprov-jdk12-134.jar.
- The generated signatures can be verified with gpg.
+ This task will be packaged in the <<<commons-openpgp.jar>>>.
+ It will use the BouncyCastle JARs at runtime. It has been tested with
<<<bcpg-jdk12-134.jar>>> and <<<bcprov-jdk12-134.jar>>>.
+ The generated signatures can be verified with GPG.
- <<<signer>>> can sign one or several files at once.
-
-* <<<attributes>>>
+ The <<<signer>>> task can sign one or more files at once.
+* Attributes
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
-| Attribute | Description
| Required |
+|| Attribute || Description
|| Required |
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
| <<<secring>>> | Secret key ring file.
| Yes |
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
@@ -28,32 +27,33 @@ Signer Ant Task
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
| <<<keyid>>> | Id of the key used to sign.
| Yes |
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
-| <<<asciiarmor>>> | Boolean, defaults to true.
| No |
+| <<<asciiarmor>>> | Whether to use ASCII armor. Boolean, defaults to
<<<true>>>. | No |
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
-| <<<artefact>>> | The file that you want to sign.
| No, if fileset nested element present. |
+| <<<artefact>>> | The file that you want to sign.
| No, if a fileset nested element is present. |
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
- The task must also take either one or several nested <<<fileset>>> element,
or an <<<artefact>>> attribute.
+ The task must also take either one or more nested <<<fileset>>> elements, or
an <<<artefact>>> attribute.
** <<<fileset>>> nested element
- The task can take one or several fileset nested elements.
- See the {{{http://ant.apache.org/manual/CoreTypes/fileset.html} ant manual}}
for an explanation.
+ The task can take one or more <<<fileset>>> nested elements.
+ See the {{{http://ant.apache.org/manual/CoreTypes/fileset.html} Ant manual}}
for an explanation.
If you want to sign just one file, the <<<artefact>>> attribute can be used
instead.
** <<<mapper>>> nested element
The task may take a {{{http://ant.apache.org/manual/CoreTypes/mapper.html}
mapper}} nested element.
- This nested element tells the task how the signature files should be called.
+ This nested element tells the task how the signature files should be named.
If you do not supply this element, the signature files will be located in
the same directory as the files that
- you sign. An ending of <<<.asc>>> will be appended to the file name for
ascii armored output (the default).
+ you sign. An ending of <<<.asc>>> will be appended to the file name for
ASCII armored output (the default).
If you set <<<asciiarmor>>> to false, the ending will be <<<.sig>>>
-* example
+* Example
-----
<project name="test1" xmlns:openpgp="antlib:org.apache.commons.openpgp.ant">
+ <property environment="env"/>
<taskdef resource="org/apache/commons/openpgp/ant/antlib.xml"
uri="antlib:org.apache.commons.openpgp.ant"/>
<openpgp:signer secring="${env.USERPROFILE}\Application
Data\gnupg\secring.gpg"
pubring="${env.USERPROFILE}\Application Data\gnupg\pubring.gpg"
Modified: commons/sandbox/openpgp/trunk/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/commons/sandbox/openpgp/trunk/src/site/apt/usage.apt?rev=935170&r1=935169&r2=935170&view=diff
==============================================================================
--- commons/sandbox/openpgp/trunk/src/site/apt/usage.apt (original)
+++ commons/sandbox/openpgp/trunk/src/site/apt/usage.apt Sat Apr 17 12:58:30
2010
@@ -38,7 +38,7 @@ signer.detachedSign(
signature, // outputstream for the
signature
keyId, // key ID
keyRing,
- true ); // ascii armor
+ true ); // ascii armor?
-----
Verifying the signature is similar.
@@ -50,7 +50,7 @@ verifier.verifyDetachedSignature(
getClass().getResourceAsStream( "/test-input" ), // binary input file
signature, // inputstream for the
signature
keyRing,
- true ); // ascii armor
+ true ); // ascii armor?
-----
* Streaming Mode
@@ -59,7 +59,7 @@ verifier.verifyDetachedSignature(
To sign data in streaming mode, create an instance of
<<<OpenPgpStreamingSigner>>>.
- The <<<update()>>> method is called on blocks of data to update the
signautre. Finally, <<<finish()>>> is called
+ The <<<update()>>> method is called on blocks of data to update the
signature. Finally, <<<finish()>>> is called
to receive the detached signature as a byte array.
-----
@@ -83,7 +83,7 @@ while ( len >= 0 );
byte[] signature = signer.finish();
-----
- To verify a signature in streaming mode is similar.
+ Verifying a signature in streaming mode is similar.
-----
verifier = new BouncyCastleOpenPgpStreamingSignatureVerifier(
