cvs: phpdoc /en/reference/gnupg constants.xml reference.xml /en/reference/gnupg/functions gnupg-adddecryptkey.xml gnupg-addencryptkey.xml
gnupg-addsignkey.xml gnupg-cleardecryptkeys.xml gnupg-clearencryptkeys.xml gnupg-clearsignkeys.xml gnupg-decrypt.xml gnupg-decryptverify.xml
gnupg-encrypt.xml gnupg-encryptsign.xml gnupg-export.xml gnupg-geterror.xml gnupg-getprotocol.xml gnupg-import.xml gnupg-keyinfo.xml
gnupg-setarmor.xml gnupg-setsignmode.xml gnupg-sign.xml gnupg-verify.xml
| From: | Jean-S�bastien Goupil | Date: | Sun, 30 Oct 2005 06:34:39 +0000 |
| Subject: | cvs: phpdoc /en/reference/gnupg constants.xml reference.xml /en/reference/gnupg/functions gnupg-adddecryptkey.xml gnupg-addencryptkey.xml gnupg-addsignkey.xml gnupg-cleardecryptkeys.xml gnupg-clearencryptkeys.xml gnupg-clearsignkeys.xml gnupg-decrypt.xml gnupg-decryptverify.xml gnupg-encrypt.xml gnupg-encryptsign.xml gnupg-export.xml gnupg-geterror.xml gnupg-getprotocol.xml gnupg-import.xml gnupg-keyinfo.xml gnupg-setarmor.xml gnupg-setsignmode.xml gnupg-sign.xml gnupg-verify.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969370705@lists.php.net to get a copy of this message | ||
jsgoupil Sun Oct 30 01:34:39 2005 EDT
Modified files:
/phpdoc/en/reference/gnupg constants.xml reference.xml
/phpdoc/en/reference/gnupg/functions gnupg-adddecryptkey.xml
gnupg-addencryptkey.xml
gnupg-addsignkey.xml
gnupg-cleardecryptkeys.xml
gnupg-clearencryptkeys.xml
gnupg-clearsignkeys.xml
gnupg-decrypt.xml
gnupg-decryptverify.xml
gnupg-encrypt.xml
gnupg-encryptsign.xml
gnupg-export.xml
gnupg-geterror.xml
gnupg-getprotocol.xml
gnupg-import.xml
gnupg-keyinfo.xml
gnupg-setarmor.xml
gnupg-setsignmode.xml
gnupg-sign.xml
gnupg-verify.xml
Log:
fix uppercase + constant + WS indentation
http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/constants.xml diff -u phpdoc/en/reference/gnupg/constants.xml:1.1 phpdoc/en/reference/gnupg/constants.xml:1.2 --- phpdoc/en/reference/gnupg/constants.xml:1.1 Sat Oct 29 12:08:06 2005 +++ phpdoc/en/reference/gnupg/constants.xml Sun Oct 30 01:34:36 2005 @@ -1,276 +1,251 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <section id='gnupg.constants'> &reftitle.constants; -<variablelist> - <varlistentry> - <term> - <constant>GNUPG_SIG_MODE_NORMAL</constant> - (<type>integer</type>) - </term> - <listitem> + <variablelist> + <varlistentry> + <term> + <constant>GNUPG_SIG_MODE_NORMAL</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIG_MODE_DETACH</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIG_MODE_DETACH</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIG_MODE_CLEAR</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIG_MODE_CLEAR</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_UNKNOWN</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_UNKNOWN</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_UNDEFINED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_UNDEFINED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_NEVER</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_NEVER</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_MARGINAL</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_MARGINAL</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_FULL</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_FULL</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_ULTIMATE</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_ULTIMATE</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_PROTOCOL_OpenPGP</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_PROTOCOL_OpenPGP</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_PROTOCOL_CMS</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_PROTOCOL_CMS</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_VALID</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_VALID</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_GREEN</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_GREEN</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_RED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_RED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_KEY_REVOKED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_KEY_REVOKED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_KEY_EXPIRED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_KEY_EXPIRED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_KEY_MISSING</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_KEY_MISSING</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_SIG_EXPIRED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_SIG_EXPIRED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_CRL_MISSING</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_CRL_MISSING</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_CRL_TOO_OLD</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_CRL_TOO_OLD</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_BAD_POLICY</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_BAD_POLICY</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_SYS_ERROR</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_SYS_ERROR</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> -</variablelist> + </varlistentry> + </variablelist> </section> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/reference.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/reference.xml diff -u phpdoc/en/reference/gnupg/reference.xml:1.2 phpdoc/en/reference/gnupg/reference.xml:1.3 --- phpdoc/en/reference/gnupg/reference.xml:1.2 Sat Oct 29 14:51:46 2005 +++ phpdoc/en/reference/gnupg/reference.xml Sun Oct 30 01:34:36 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Purpose: utilspec.nontext --> <!-- Membership: pecl --> <!-- State: beta --> @@ -11,22 +11,22 @@ <section id="gnupg.intro"> &reftitle.intro; <para> - This module allows you to interact with <ulink - url="http://www.gnupg.org/">gnupg</ulink>. - &warn.experimental; + This module allows you to interact with <ulink + url="http://www.gnupg.org/">gnupg</ulink>. + &warn.experimental; </para> </section> <section id="gnupg.requirements"> &reftitle.required; <para> - The gnupg extension requires PHP 4.3. - To use this extension in an OO style, PHP 5 is required. + The gnupg extension requires PHP 4.3. + To use this extension in an OO style, PHP 5 is required. </para> <para> - This extension requires the <ulink - url="http://www.gnupg.org/(en)/download/index.html#gpgme">gpgme - library</ulink> + This extension requires the <ulink + url="http://www.gnupg.org/(en)/download/index.html#gpgme">gpgme + library</ulink> </para> </section> @@ -46,18 +46,18 @@ </para> <para> Some functions require the specification of a key. This specification can - be anything that refers to an unique key (userid, key-id, fingerprint + be anything that refers to an unique key (userid, key-id, fingerprint, ...). This documentation uses the fingerprint in all examples. </para> </section> <section id="gnupg.keylistiterator"> - <title>keylistiterator</title> - <para> - This extension also comes with an Iterator for your keyring. - <programlisting role="php"> - <![CDATA[ + <title>keylistiterator</title> + <para> + This extension also comes with an Iterator for your keyring. + <programlisting role="php"> +<![CDATA[ <?php // create a new iterator for listing all public keys that matches 'example' $iterator = new gnupg_keylistiterator("example"); @@ -65,9 +65,9 @@ echo $fingerprint." -> ".$userid."\n"; } ?> - ]]> - </programlisting> - </para> +]]> + </programlisting> + </para> </section> <section id="gnupg.examples"> @@ -94,9 +94,9 @@ </programlisting> </example> <example> - <title>gnupg clearsign example (OO)</title> - <programlisting role="php"> - <![CDATA[ + <title>gnupg clearsign example (OO)</title> + <programlisting role="php"> +<![CDATA[ <?php // new class $gnupg = new gnupg(); @@ -108,8 +108,8 @@ $signed = $gnupg->sign("just a test"); echo $signed; ?> - ]]> - </programlisting> +]]> + </programlisting> </example> </section> </partintro> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml:1.1 Sat Oct 29 12:08:08 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-adddecryptkey"> <refnamediv> <refname>gnupg_adddecryptkey</refname> - <refpurpose>add a key for decryption</refpurpose> + <refpurpose>Add a key for decryption</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -14,18 +15,19 @@ <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_adddecryptkey</function> example</title> + <title>Procedural <function>gnupg_adddecryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,15 +38,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_adddecryptkey</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_adddecryptkey</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-addencryptkey"> <refnamediv> <refname>gnupg_addencryptkey</refname> - <refpurpose>add a key for encryption</refpurpose> + <refpurpose>Add a key for encryption</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,18 +14,19 @@ <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.succes; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_addencryptkey</function> example</title> + <title>Procedural <function>gnupg_addencryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -35,15 +37,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_addencryptkey</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_addencryptkey</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-addsignkey"> <refnamediv> <refname>gnupg_addsignkey</refname> - <refpurpose>add a key for signing</refpurpose> + <refpurpose>Add a key for signing</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -14,18 +15,19 @@ <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_addsignkey</function> example</title> + <title>Procedural <function>gnupg_addsignkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,15 +38,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_addsignkey</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_addsignkey</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-cleardecryptkeys"> <refnamediv> <refname>gnupg_cleardecryptkeys</refname> - <refpurpose>removes all keys which were set for decryption before</refpurpose> + <refpurpose>Removes all keys which were set for decryption before</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_cleardecryptkeys</function> example</title> + <title>Procedural <function>gnupg_cleardecryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_cleardecryptkeys</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_cleardecryptkeys</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> cleardecryptkeys(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-clearencryptkeys"> <refnamediv> <refname>gnupg_clearencryptkeys</refname> - <refpurpose>removes all keys which were set for encryption before</refpurpose> + <refpurpose>Removes all keys which were set for encryption before</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_clearencryptkeys</function> example</title> + <title>Procedural <function>gnupg_clearencryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_clearencryptkeys</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_clearencryptkeys</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearencryptkeys(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-clearsignkeys"> <refnamediv> <refname>gnupg_clearsignkeys</refname> - <refpurpose>removes all keys which were set for signing before</refpurpose> + <refpurpose>Removes all keys which were set for signing before</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_clearsignkeys</function> example</title> + <title>Procedural <function>gnupg_clearsignkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_clearsignkeys</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_clearsignkeys</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearsignkeys(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-decrypt"> <refnamediv> <refname>gnupg_decrypt</refname> - <refpurpose>decrypts a given text</refpurpose> + <refpurpose>Decrypts a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,22 +14,24 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - Decrypts the given text with the keys, which were set with <link - linkend='function.gnupg-adddecryptkey'>gnupg_adddecryptkey</link> before. + Decrypts the given text with the keys, which were set with <link + linkend='function.gnupg-adddecryptkey'>gnupg_adddecryptkey</link> before. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the decrypted text. - On failure, this function returns &false;. + On success, this function returns the decrypted text. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_decrypt</function> example</title> + <title>Procedural <function>gnupg_decrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -41,8 +44,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_encrypt</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_encrypt</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -51,7 +54,7 @@ echo $plain; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-decryptverify"> <refnamediv> <refname>gnupg_decryptverify</refname> - <refpurpose>decrypts and verifies a given text</refpurpose> + <refpurpose>Decrypts and verifies a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -15,25 +16,27 @@ role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - Decrypts and verifies a given text and returns information about the - signature. - The parameter <parameter>plaintext</parameter> gets filled with the decrypted - text. + Decrypts and verifies a given text and returns information about the + signature. + The parameter <parameter>plaintext</parameter> gets filled with the decrypted + text. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - 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;. + 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> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_decryptverify</function> example</title> + <title>Procedural <function>gnupg_decryptverify</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -47,8 +50,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_decryptverify</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_decryptverify</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; @@ -58,7 +61,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-encrypt"> <refnamediv> <refname>gnupg_encrypt</refname> - <refpurpose>encrypts a given text</refpurpose> + <refpurpose>Encrypts a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,12 +14,13 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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. + 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> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -26,11 +28,12 @@ On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_encrypt</function> example</title> + <title>Procedural <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -43,8 +46,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_encrypt</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_encrypt</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -53,7 +56,7 @@ echo $enc; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-encryptsign"> <refnamediv> <refname>gnupg_encryptsign</refname> - <refpurpose>encrypts and signs a given text</refpurpose> + <refpurpose>Encrypts and signs a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,25 +14,27 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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. + 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. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the encrypted and signed text. - On failure, this function returns &false;. + On success, this function returns the encrypted and signed text. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_encryptsign</function> example</title> + <title>Procedural <function>gnupg_encryptsign</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -45,8 +48,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_encryptsign</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_encryptsign</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -56,7 +59,7 @@ echo $enc; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-export.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-export.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-export.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-export"> <refnamediv> <refname>gnupg_export</refname> <refpurpose>Exports a key</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,21 +14,23 @@ <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> <para> - Exports the key <parameter>fingerprint</parameter>. + Exports the key <parameter>fingerprint</parameter>. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the keydata. - On failure, this function returns &false;. + On success, this function returns the keydata. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_export</function> example</title> + <title>Procedural <function>gnupg_export</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -39,15 +42,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_export</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_export</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $export = $gpg -> export("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-geterror"> <refnamediv> <refname>gnupg_geterror</refname> - <refpurpose>returns the errortext, if a function fails</refpurpose> + <refpurpose>Returns the errortext, if a function fails</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,17 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - returns an errortext, if an error has occured, otherwise &false;. + Returns an errortext, if an error has occured, otherwise &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_geterror</function> example</title> + <title>Procedural <function>gnupg_geterror</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -33,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_geterror</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_geterror</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> geterror(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-getprotocol"> <refnamediv> <refname>gnupg_getprotocol</refname> - <refpurpose>returns the currently active protocol for all operations</refpurpose> + <refpurpose>Returns the currently active protocol for all operations</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,21 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - returns the currently active protocol, which can be one of - GNUPG_PROTOCOL_OpenPGP or GNUPG_PROTOCOL_CMS. + Returns the currently active protocol, which can be one of + <constant>GNUPG_PROTOCOL_OpenPGP</constant> or + <constant>GNUPG_PROTOCOL_CMS</constant>. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_getprotocol</function> example</title> + <title>Procedural <function>gnupg_getprotocol</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +38,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_getprotocol</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_getprotocol</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> getprotocol(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-import.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-import.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-import.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-import"> <refnamediv> <refname>gnupg_import</refname> <refpurpose>Imports a key</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,22 +14,24 @@ <methodparam><type>string</type><parameter>keydata</parameter></methodparam> </methodsynopsis> <para> - Imports the key <parameter>keydata</parameter> and returns an array with - information about the importprocess. + Imports the key <parameter>keydata</parameter> and returns an array with + information about the importprocess. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns and info-array about the importprocess. - On failure, this function returns &false;. + On success, this function returns and info-array about the importprocess. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_import</function> example</title> + <title>Procedural <function>gnupg_import</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -40,8 +43,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_import</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_import</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -49,7 +52,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml Sun Oct 30 01:34:39 2005 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-keyinfo"> <refnamediv> <refname>gnupg_keyinfo</refname> - <refpurpose>returns an array with information about all keys that matches - the given pattern</refpurpose> + <refpurpose>Returns an array with information about all keys that matches the given pattern</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -14,18 +14,20 @@ <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an array with information about all keys that matches the given - pattern or &false;, if an error has occured. + Returns an array with information about all keys that matches the given + pattern or &false;, if an error has occured. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_keyinfo</function> example</title> + <title>Procedural <function>gnupg_keyinfo</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -37,8 +39,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_keyinfo</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_keyinfo</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -46,7 +48,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-setarmor"> <refnamediv> <refname>gnupg_setarmor</refname> <refpurpose>Toggle armored output</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,23 +14,24 @@ <methodparam><type>int</type><parameter>armor</parameter></methodparam> </methodsynopsis> <para> - Pass a non-zero interger-value to this function to enable armored-output - (default). - Pass 0 to disable armored output. + Pass a non-zero interger-value to this function to enable armored-output + (default). + Pass 0 to disable armored output. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_setarmor</function> example</title> + <title>Procedural <function>gnupg_setarmor</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -41,8 +43,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_setarmor</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_setarmor</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -50,7 +52,7 @@ $gpg -> setarmor(0); // disable armored output; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-setsignmode"> <refnamediv> <refname>gnupg_setsignmode</refname> - <refpurpose>sets the mode for signing</refpurpose> + <refpurpose>Sets the mode for signing</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,24 +14,26 @@ <methodparam><type>int</type><parameter>signmode</parameter></methodparam> </methodsynopsis> <para> - <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. + <parameter>signmode</parameter> takes a constant indicating what type of + signature should be produced. The possible values are + <constant>GNUPG_SIG_MODE_NORMAL</constant>, + <constant>GNUPG_SIG_MODE_DETACH</constant> and + <constant>GNUPG_SIG_MODE_CLEAR</constant>. + By default <constant>GNUPG_SIG_MODE_CLEAR</constant> is used. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_setsignmode</function> example</title> + <title>Procedural <function>gnupg_setsignmode</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -41,15 +44,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_setsignmode</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_setsignmode</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setsignmode(gnupg::SIG_MODE_DETACH); // produce a detached signature ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-sign.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-sign.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-sign.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-sign"> <refnamediv> <refname>gnupg_sign</refname> - <refpurpose>signs a given text</refpurpose> + <refpurpose>Signs a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,25 +14,27 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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>. + 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>. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the signed text or the signature. - On failure, this function returns &false;. + On success, this function returns the signed text or the signature. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_sign</function> example</title> + <title>Procedural <function>gnupg_sign</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -44,8 +47,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_sign</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_sign</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -54,7 +57,7 @@ echo $signed; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-verify.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-verify.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-verify.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-verify"> <refnamediv> <refname>gnupg_verify</refname> - <refpurpose>verifies a signed text</refpurpose> + <refpurpose>Verifies a signed text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -16,25 +17,27 @@ choice="opt" role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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 <parameter>plaintext</parameter> is passed, it is - filled with the <parameter>plaintext</parameter>. + 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 <parameter>plaintext</parameter> is passed, it is + filled with the <parameter>plaintext</parameter>. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns informations about the signature. - On failure, this function returns &false;. + On success, this function returns informations about the signature. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_verify</function> example</title> + <title>Procedural <function>gnupg_verify</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -51,8 +54,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_verify</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_verify</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; @@ -65,7 +68,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1>
http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/constants.xml diff -u phpdoc/en/reference/gnupg/constants.xml:1.1 phpdoc/en/reference/gnupg/constants.xml:1.2 --- phpdoc/en/reference/gnupg/constants.xml:1.1 Sat Oct 29 12:08:06 2005 +++ phpdoc/en/reference/gnupg/constants.xml Sun Oct 30 01:34:36 2005 @@ -1,276 +1,251 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <section id='gnupg.constants'> &reftitle.constants; -<variablelist> - <varlistentry> - <term> - <constant>GNUPG_SIG_MODE_NORMAL</constant> - (<type>integer</type>) - </term> - <listitem> + <variablelist> + <varlistentry> + <term> + <constant>GNUPG_SIG_MODE_NORMAL</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIG_MODE_DETACH</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIG_MODE_DETACH</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIG_MODE_CLEAR</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIG_MODE_CLEAR</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_UNKNOWN</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_UNKNOWN</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_UNDEFINED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_UNDEFINED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_NEVER</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_NEVER</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_MARGINAL</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_MARGINAL</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_FULL</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_FULL</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_VALIDITY_ULTIMATE</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_VALIDITY_ULTIMATE</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_PROTOCOL_OpenPGP</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_PROTOCOL_OpenPGP</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_PROTOCOL_CMS</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_PROTOCOL_CMS</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_VALID</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_VALID</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_GREEN</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_GREEN</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_RED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_RED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_KEY_REVOKED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_KEY_REVOKED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_KEY_EXPIRED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_KEY_EXPIRED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_KEY_MISSING</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_KEY_MISSING</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_SIG_EXPIRED</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_SIG_EXPIRED</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_CRL_MISSING</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_CRL_MISSING</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_CRL_TOO_OLD</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_CRL_TOO_OLD</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_BAD_POLICY</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_BAD_POLICY</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> - <varlistentry> - <term> - <constant>GNUPG_SIGSUM_SYS_ERROR</constant> - (<type>integer</type>) - </term> -<listitem> + </varlistentry> + <varlistentry> + <term> + <constant>GNUPG_SIGSUM_SYS_ERROR</constant> + (<type>integer</type>) + </term> + <listitem> <simpara> </simpara> </listitem> - - </varlistentry> -</variablelist> + </varlistentry> + </variablelist> </section> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/reference.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/reference.xml diff -u phpdoc/en/reference/gnupg/reference.xml:1.2 phpdoc/en/reference/gnupg/reference.xml:1.3 --- phpdoc/en/reference/gnupg/reference.xml:1.2 Sat Oct 29 14:51:46 2005 +++ phpdoc/en/reference/gnupg/reference.xml Sun Oct 30 01:34:36 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Purpose: utilspec.nontext --> <!-- Membership: pecl --> <!-- State: beta --> @@ -11,22 +11,22 @@ <section id="gnupg.intro"> &reftitle.intro; <para> - This module allows you to interact with <ulink - url="http://www.gnupg.org/">gnupg</ulink>. - &warn.experimental; + This module allows you to interact with <ulink + url="http://www.gnupg.org/">gnupg</ulink>. + &warn.experimental; </para> </section> <section id="gnupg.requirements"> &reftitle.required; <para> - The gnupg extension requires PHP 4.3. - To use this extension in an OO style, PHP 5 is required. + The gnupg extension requires PHP 4.3. + To use this extension in an OO style, PHP 5 is required. </para> <para> - This extension requires the <ulink - url="http://www.gnupg.org/(en)/download/index.html#gpgme">gpgme - library</ulink> + This extension requires the <ulink + url="http://www.gnupg.org/(en)/download/index.html#gpgme">gpgme + library</ulink> </para> </section> @@ -46,18 +46,18 @@ </para> <para> Some functions require the specification of a key. This specification can - be anything that refers to an unique key (userid, key-id, fingerprint + be anything that refers to an unique key (userid, key-id, fingerprint, ...). This documentation uses the fingerprint in all examples. </para> </section> <section id="gnupg.keylistiterator"> - <title>keylistiterator</title> - <para> - This extension also comes with an Iterator for your keyring. - <programlisting role="php"> - <![CDATA[ + <title>keylistiterator</title> + <para> + This extension also comes with an Iterator for your keyring. + <programlisting role="php"> +<![CDATA[ <?php // create a new iterator for listing all public keys that matches 'example' $iterator = new gnupg_keylistiterator("example"); @@ -65,9 +65,9 @@ echo $fingerprint." -> ".$userid."\n"; } ?> - ]]> - </programlisting> - </para> +]]> + </programlisting> + </para> </section> <section id="gnupg.examples"> @@ -94,9 +94,9 @@ </programlisting> </example> <example> - <title>gnupg clearsign example (OO)</title> - <programlisting role="php"> - <![CDATA[ + <title>gnupg clearsign example (OO)</title> + <programlisting role="php"> +<![CDATA[ <?php // new class $gnupg = new gnupg(); @@ -108,8 +108,8 @@ $signed = $gnupg->sign("just a test"); echo $signed; ?> - ]]> - </programlisting> +]]> + </programlisting> </example> </section> </partintro> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml:1.1 Sat Oct 29 12:08:08 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-adddecryptkey"> <refnamediv> <refname>gnupg_adddecryptkey</refname> - <refpurpose>add a key for decryption</refpurpose> + <refpurpose>Add a key for decryption</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -14,18 +15,19 @@ <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_adddecryptkey</function> example</title> + <title>Procedural <function>gnupg_adddecryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,15 +38,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_adddecryptkey</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_adddecryptkey</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-addencryptkey"> <refnamediv> <refname>gnupg_addencryptkey</refname> - <refpurpose>add a key for encryption</refpurpose> + <refpurpose>Add a key for encryption</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,18 +14,19 @@ <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.succes; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_addencryptkey</function> example</title> + <title>Procedural <function>gnupg_addencryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -35,15 +37,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_addencryptkey</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_addencryptkey</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-addsignkey"> <refnamediv> <refname>gnupg_addsignkey</refname> - <refpurpose>add a key for signing</refpurpose> + <refpurpose>Add a key for signing</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -14,18 +15,19 @@ <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_addsignkey</function> example</title> + <title>Procedural <function>gnupg_addsignkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,15 +38,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_addsignkey</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_addsignkey</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-cleardecryptkeys"> <refnamediv> <refname>gnupg_cleardecryptkeys</refname> - <refpurpose>removes all keys which were set for decryption before</refpurpose> + <refpurpose>Removes all keys which were set for decryption before</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_cleardecryptkeys</function> example</title> + <title>Procedural <function>gnupg_cleardecryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_cleardecryptkeys</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_cleardecryptkeys</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> cleardecryptkeys(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-clearencryptkeys"> <refnamediv> <refname>gnupg_clearencryptkeys</refname> - <refpurpose>removes all keys which were set for encryption before</refpurpose> + <refpurpose>Removes all keys which were set for encryption before</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_clearencryptkeys</function> example</title> + <title>Procedural <function>gnupg_clearencryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_clearencryptkeys</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_clearencryptkeys</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearencryptkeys(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-clearsignkeys"> <refnamediv> <refname>gnupg_clearsignkeys</refname> - <refpurpose>removes all keys which were set for signing before</refpurpose> + <refpurpose>Removes all keys which were set for signing before</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_clearsignkeys</function> example</title> + <title>Procedural <function>gnupg_clearsignkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_clearsignkeys</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_clearsignkeys</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearsignkeys(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-decrypt"> <refnamediv> <refname>gnupg_decrypt</refname> - <refpurpose>decrypts a given text</refpurpose> + <refpurpose>Decrypts a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,22 +14,24 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - Decrypts the given text with the keys, which were set with <link - linkend='function.gnupg-adddecryptkey'>gnupg_adddecryptkey</link> before. + Decrypts the given text with the keys, which were set with <link + linkend='function.gnupg-adddecryptkey'>gnupg_adddecryptkey</link> before. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the decrypted text. - On failure, this function returns &false;. + On success, this function returns the decrypted text. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_decrypt</function> example</title> + <title>Procedural <function>gnupg_decrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -41,8 +44,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_encrypt</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_encrypt</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -51,7 +54,7 @@ echo $plain; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-decryptverify"> <refnamediv> <refname>gnupg_decryptverify</refname> - <refpurpose>decrypts and verifies a given text</refpurpose> + <refpurpose>Decrypts and verifies a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -15,25 +16,27 @@ role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - Decrypts and verifies a given text and returns information about the - signature. - The parameter <parameter>plaintext</parameter> gets filled with the decrypted - text. + Decrypts and verifies a given text and returns information about the + signature. + The parameter <parameter>plaintext</parameter> gets filled with the decrypted + text. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - 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;. + 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> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_decryptverify</function> example</title> + <title>Procedural <function>gnupg_decryptverify</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -47,8 +50,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_decryptverify</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_decryptverify</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; @@ -58,7 +61,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-encrypt"> <refnamediv> <refname>gnupg_encrypt</refname> - <refpurpose>encrypts a given text</refpurpose> + <refpurpose>Encrypts a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,12 +14,13 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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. + 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> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -26,11 +28,12 @@ On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_encrypt</function> example</title> + <title>Procedural <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -43,8 +46,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_encrypt</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_encrypt</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -53,7 +56,7 @@ echo $enc; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-encryptsign"> <refnamediv> <refname>gnupg_encryptsign</refname> - <refpurpose>encrypts and signs a given text</refpurpose> + <refpurpose>Encrypts and signs a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,25 +14,27 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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. + 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. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the encrypted and signed text. - On failure, this function returns &false;. + On success, this function returns the encrypted and signed text. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_encryptsign</function> example</title> + <title>Procedural <function>gnupg_encryptsign</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -45,8 +48,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_encryptsign</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_encryptsign</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -56,7 +59,7 @@ echo $enc; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-export.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-export.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-export.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-export.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-export"> <refnamediv> <refname>gnupg_export</refname> <refpurpose>Exports a key</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,21 +14,23 @@ <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> <para> - Exports the key <parameter>fingerprint</parameter>. + Exports the key <parameter>fingerprint</parameter>. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the keydata. - On failure, this function returns &false;. + On success, this function returns the keydata. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_export</function> example</title> + <title>Procedural <function>gnupg_export</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -39,15 +42,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_export</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_export</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $export = $gpg -> export("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-geterror"> <refnamediv> <refname>gnupg_geterror</refname> - <refpurpose>returns the errortext, if a function fails</refpurpose> + <refpurpose>Returns the errortext, if a function fails</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,17 +13,19 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - returns an errortext, if an error has occured, otherwise &false;. + Returns an errortext, if an error has occured, otherwise &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_geterror</function> example</title> + <title>Procedural <function>gnupg_geterror</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -33,15 +36,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_geterror</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_geterror</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> geterror(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml:1.1 phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml:1.2 --- phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml:1.1 Sat Oct 29 12:08:09 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.gnupg-getprotocol"> <refnamediv> <refname>gnupg_getprotocol</refname> - <refpurpose>returns the currently active protocol for all operations</refpurpose> + <refpurpose>Returns the currently active protocol for all operations</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,18 +13,21 @@ <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - returns the currently active protocol, which can be one of - GNUPG_PROTOCOL_OpenPGP or GNUPG_PROTOCOL_CMS. + Returns the currently active protocol, which can be one of + <constant>GNUPG_PROTOCOL_OpenPGP</constant> or + <constant>GNUPG_PROTOCOL_CMS</constant>. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_getprotocol</function> example</title> + <title>Procedural <function>gnupg_getprotocol</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,15 +38,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_getprotocol</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_getprotocol</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> getprotocol(); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-import.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-import.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-import.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-import.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-import"> <refnamediv> <refname>gnupg_import</refname> <refpurpose>Imports a key</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,22 +14,24 @@ <methodparam><type>string</type><parameter>keydata</parameter></methodparam> </methodsynopsis> <para> - Imports the key <parameter>keydata</parameter> and returns an array with - information about the importprocess. + Imports the key <parameter>keydata</parameter> and returns an array with + information about the importprocess. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns and info-array about the importprocess. - On failure, this function returns &false;. + On success, this function returns and info-array about the importprocess. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_import</function> example</title> + <title>Procedural <function>gnupg_import</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -40,8 +43,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_import</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_import</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -49,7 +52,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml Sun Oct 30 01:34:39 2005 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-keyinfo"> <refnamediv> <refname>gnupg_keyinfo</refname> - <refpurpose>returns an array with information about all keys that matches - the given pattern</refpurpose> + <refpurpose>Returns an array with information about all keys that matches the given pattern</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -14,18 +14,20 @@ <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an array with information about all keys that matches the given - pattern or &false;, if an error has occured. + Returns an array with information about all keys that matches the given + pattern or &false;, if an error has occured. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_keyinfo</function> example</title> + <title>Procedural <function>gnupg_keyinfo</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -37,8 +39,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_keyinfo</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_keyinfo</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -46,7 +48,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-setarmor"> <refnamediv> <refname>gnupg_setarmor</refname> <refpurpose>Toggle armored output</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,23 +14,24 @@ <methodparam><type>int</type><parameter>armor</parameter></methodparam> </methodsynopsis> <para> - Pass a non-zero interger-value to this function to enable armored-output - (default). - Pass 0 to disable armored output. + Pass a non-zero interger-value to this function to enable armored-output + (default). + Pass 0 to disable armored output. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_setarmor</function> example</title> + <title>Procedural <function>gnupg_setarmor</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -41,8 +43,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_setarmor</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_setarmor</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -50,7 +52,7 @@ $gpg -> setarmor(0); // disable armored output; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-setsignmode"> <refnamediv> <refname>gnupg_setsignmode</refname> - <refpurpose>sets the mode for signing</refpurpose> + <refpurpose>Sets the mode for signing</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,24 +14,26 @@ <methodparam><type>int</type><parameter>signmode</parameter></methodparam> </methodsynopsis> <para> - <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. + <parameter>signmode</parameter> takes a constant indicating what type of + signature should be produced. The possible values are + <constant>GNUPG_SIG_MODE_NORMAL</constant>, + <constant>GNUPG_SIG_MODE_DETACH</constant> and + <constant>GNUPG_SIG_MODE_CLEAR</constant>. + By default <constant>GNUPG_SIG_MODE_CLEAR</constant> is used. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns &true;. - On failure, this function returns &false;. + &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_setsignmode</function> example</title> + <title>Procedural <function>gnupg_setsignmode</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -41,15 +44,15 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_setsignmode</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_setsignmode</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setsignmode(gnupg::SIG_MODE_DETACH); // produce a detached signature ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-sign.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-sign.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-sign.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-sign.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-sign"> <refnamediv> <refname>gnupg_sign</refname> - <refpurpose>signs a given text</refpurpose> + <refpurpose>Signs a given text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,25 +14,27 @@ <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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>. + 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>. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns the signed text or the signature. - On failure, this function returns &false;. + On success, this function returns the signed text or the signature. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_sign</function> example</title> + <title>Procedural <function>gnupg_sign</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -44,8 +47,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_sign</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_sign</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); @@ -54,7 +57,7 @@ echo $signed; ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions/gnupg-verify.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/gnupg/functions/gnupg-verify.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.2 phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.3 --- phpdoc/en/reference/gnupg/functions/gnupg-verify.xml:1.2 Sat Oct 29 14:51:50 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-verify.xml Sun Oct 30 01:34:39 2005 @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.gnupg-verify"> <refnamediv> <refname>gnupg_verify</refname> - <refpurpose>verifies a signed text</refpurpose> + <refpurpose>Verifies a signed text</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -16,25 +17,27 @@ choice="opt" role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> - 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 <parameter>plaintext</parameter> is passed, it is - filled with the <parameter>plaintext</parameter>. + 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 <parameter>plaintext</parameter> is passed, it is + filled with the <parameter>plaintext</parameter>. </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - On success, this function returns informations about the signature. - On failure, this function returns &false;. + On success, this function returns informations about the signature. + On failure, this function returns &false;. </para> </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>procedural <function>gnupg_verify</function> example</title> + <title>Procedural <function>gnupg_verify</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -51,8 +54,8 @@ </programlisting> </example> <example> - <title>OO <function>gnupg_verify</function> example</title> - <programlisting role="php"> + <title>OO <function>gnupg_verify</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; @@ -65,7 +68,7 @@ print_r($info); ?> ]]> - </programlisting> + </programlisting> </example> </para> </refsect1>