cvs: phpdoc /en/reference/gnupg reference.xml /en/reference/gnupg/functions gnupg-decryptverify.xml gnupg-encrypt.xml gnupg-encryptsign.xml
gnupg-export.xml gnupg-import.xml gnupg-keyinfo.xml gnupg-setarmor.xml gnupg-setsignmode.xml gnupg-sign.xml gnupg-verify.xml

jsgoupil Sat Oct 29 14:51:50 2005 EDT Modified files: /phpdoc/en/reference/gnupg reference.xml /phpdoc/en/reference/gnupg/functions gnupg-decryptverify.xml gnupg-encrypt.xml gnupg-encryptsign.xml gnupg-export.xml gnupg-import.xml gnupg-keyinfo.xml gnupg-setarmor.xml gnupg-setsignmode.xml gnupg-sign.xml gnupg-verify.xml Log: fix typo and parameter

http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/reference.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/reference.xml diff -u phpdoc/en/reference/gnupg/reference.xml:1.1 phpdoc/en/reference/gnupg/reference.xml:1.2 --- phpdoc/en/reference/gnupg/reference.xml:1.1 Sat Oct 29 12:08:06 2005 +++ phpdoc/en/reference/gnupg/reference.xml Sat Oct 29 14:51:46 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Purpose: utilspec.nontext --> <!-- Membership: pecl --> <!-- State: beta --> @@ -40,7 +40,7 @@ This extension makes use of the keyring of the current user. This keyring is normaly located in ~./.gnupg/. To specify a custom location, store the path to the keyring in the - enviroment variable GNUPGHOME. See <link + environment variable GNUPGHOME. See <link linkend='function.putenv'>putenv</link> for more information how to do this. </para> @@ -82,7 +82,7 @@ <?php // init gnupg $res = gnupg_init(); -// not really needed: Clearsign is default +// not really needed. Clearsign is default gnupg_setsignmode($res,GNUPG_SIG_MODE_CLEAR); // add key with passphrase 'test' for signing gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-decryptverify"> <refnamediv> <refname>gnupg_decryptverify</refname> @@ -15,17 +15,17 @@ role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - Decrypts and verifies a given text and returns informations about the + Decrypts and verifies a given text and returns information about the signature. - The parameter <literal>plaintext</literal> gets filled with the decrypted + The parameter <parameter>plaintext</parameter> gets filled with the decrypted text. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns informations about the signature and - fills plaintext with the decrypted text. + On success, this function returns information about the signature and + fills the <parameter>plaintext</parameter> parameter with the decrypted text. On failure, this function returns &false;. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-encrypt"> <refnamediv> <refname>gnupg_encrypt</refname> @@ -13,7 +13,8 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - Encrypts the given plaintext with the keys, which were set with <link + Encrypts the given <parameter>plaintext</parameter> with the keys, which + were set with <link linkend='function.gnupg-addencryptkey'>gnupg_addencryptkey</link> before and returns the encrypted text. </para> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-encryptsign"> <refnamediv> <refname>gnupg_encryptsign</refname> @@ -13,7 +13,8 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - Encrypts and signs the given plaintext with the keys, which were set with + Encrypts and signs the given <parameter>plaintext</parameter> with the + keys, which were set with <link linkend='function.gnupg-addsignkey'>gnupg_addsignkey</link> and <link linkend='function.gnupg-addencryptkey'>gnupg_addencryptkey</link> before and returns the encrypted and signed text. http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-export.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-export.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-export.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-export"> <refnamediv> <refname>gnupg_export</refname> @@ -13,7 +13,7 @@ <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> <para> - Exports the key <literal>fingerprint</literal> + Exports the key <parameter>fingerprint</parameter>. </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-import.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-import.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-import.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-import"> <refnamediv> <refname>gnupg_import</refname> @@ -13,8 +13,8 @@ <methodparam><type>string</type><parameter>keydata</parameter></methodparam> </methodsynopsis> <para> - Iports the key <literal>keydata</literal> and returns an array with - informations about the importprocess. + Imports the key <parameter>keydata</parameter> and returns an array with + information about the importprocess. </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml Sat Oct 29 14:51:50 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-keyinfo"> <refnamediv> <refname>gnupg_keyinfo</refname> - <refpurpose>returns an array with informations about all keys that matches + <refpurpose>returns an array with information about all keys that matches the given pattern</refpurpose> </refnamediv> <refsect1 role="description"> @@ -17,7 +17,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - returns an array with informations about all keys that matches the given + Returns an array with information about all keys that matches the given pattern or &false;, if an error has occured. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-setarmor"> <refnamediv> <refname>gnupg_setarmor</refname> @@ -34,7 +34,7 @@ <![CDATA[ <?php $res = gnupg_init(); -gnupg_setarmor($res,1); // enable armored output +gnupg_setarmor($res,1); // enable armored output; gnupg_setarmor($res,0); // disable armored output; ?> ]]> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-setsignmode"> <refnamediv> <refname>gnupg_setsignmode</refname> @@ -13,7 +13,7 @@ <methodparam><type>int</type><parameter>signmode</parameter></methodparam> </methodsynopsis> <para> - <literal>signmode</literal> is a constant indicating what type of + <parameter>signmode</parameter> takes a constant indicating what type of signature should be produced. The possible values are GNUPG_SIG_MODE_NORMAL, GNUPG_SIG_MODE_DETACH and GNUPG_SIG_MODE_CLEAR. By default GNUPG_SIG_MODE_CLEAR is used. http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-sign.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-sign.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-sign.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-sign"> <refnamediv> <refname>gnupg_sign</refname> @@ -13,16 +13,17 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - Signs the given plaintext with the keys, which were set with <link + Signs the given <parameter>plaintext</parameter> with the keys, which were + set with <link linkend='function.gnupg-addsignkey'>gnupg_addsignkey</link> before and returns the signed text or the signature, depending on what was set with - <link linkend='function.gnupg-setsignmode'>gnupg_setsignmode</link> + <link linkend='function.gnupg-setsignmode'>gnupg_setsignmode</link>. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the signed text/ the signature. + On success, this function returns the signed text or the signature. On failure, this function returns &false;. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-verify.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-verify.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-verify.xml Sat Oct 29 14:51:50 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-verify"> <refnamediv> <refname>gnupg_verify</refname> @@ -16,11 +16,11 @@ choice="opt" role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - Verifies the given signed_text and returns informations about the + Verifies the given <parameter>signed_text</parameter> and returns information about the signature. To verify a clearsigned text, set signature to &false;. - If the optional parameter <literal>plaintext</literal> is passed, it is - filled with the plaintext. + If the optional parameter <parameter>plaintext</parameter> is passed, it is + filled with the <parameter>plaintext</parameter>. </para> </refsect1> <refsect1 role="returnvalues">