Fix GH-2655: add PEM and DER acronyms

appendices/migration56/openssl.xml

@@ -313,8 +313,8 @@ array(8) {
    <function>openssl_spki_verify</function>,
    <function>openssl_spki_export_challenge</function>, and
    <function>openssl_spki_export</function> have been added to create, verify
-   export PEM public key and associated challenge from SPKAC's generated from
-   a <literal>KeyGen</literal> HTML5 element.
+   export <acronym>PEM</acronym> public key and associated challenge from
+   SPKAC's generated from a <literal>KeyGen</literal> HTML5 element.
   </para>
 
   <variablelist>
@@ -404,7 +404,7 @@ challenge string
     <term><parameter>openssl_spki_export</parameter></term>
     <listitem>
      <para>
-      Exports the PEM formatted RSA public key from SPKAC.
+      Exports the <acronym>PEM</acronym> formatted RSA public key from SPKAC.
      </para>
 
      <informalexample>

appendices/migration80/new-features.xml

@@ -357,7 +357,8 @@ class ChildClass extends ParentClass {
      the results to the supplied file.
     </member>
     <member>
-     <function>openssl_cms_read</function> that exports the CMS file to an array of PEM certificates.
+     <function>openssl_cms_read</function> that exports the CMS file to an array
+     of <acronym>PEM</acronym> certificates.
     </member>
     <member>
      <function>openssl_cms_sign</function> that signs the MIME message in the file with a cert and key

language/context/ssl.xml

@@ -108,9 +108,9 @@
      </term>
      <listitem>
       <para>
-       Path to local certificate file on filesystem.  It must be a PEM
-       encoded file which contains your certificate and private key.
-       It can optionally contain the certificate chain of issuers.
+       Path to local certificate file on filesystem.  It must be a
+       <acronym>PEM</acronym> encoded file which contains your certificate and
+       private key. It can optionally contain the certificate chain of issuers.
        The private key also may be contained in a separate file specified
        by <literal>local_pk</literal>.
       </para>

reference/event/eventsslcontext.xml

@@ -159,7 +159,7 @@
      </term>
      <listitem>
       <para>
-       Path to local certificate file on filesystem. It must be a PEM-encoded
+       Path to local certificate file on filesystem. It must be a <acronym>PEM</acronym>-encoded
        file which contains certificate. It can optionally contain the
        certificate chain of issuers.
       </para>

reference/mongodb/mongodb/driver/manager/construct.xml

@@ -1002,7 +1002,7 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][
           <entry><type>string</type></entry>
           <entry>
            <para>
-            Path to a PEM encoded certificate to use for client authentication.
+            Path to a <acronym>PEM</acronym> encoded certificate to use for client authentication.
            </para>
            <para>
             This option is a deprecated alias for the
@@ -1015,7 +1015,7 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][
           <entry><type>string</type></entry>
           <entry>
            <para>
-            Passphrase for the PEM encoded certificate (if applicable).
+            Passphrase for the <acronym>PEM</acronym> encoded certificate (if applicable).
            </para>
            <para>
             This option is a deprecated alias for the

reference/mysqli/mysqli/ssl-set.xml

@@ -70,7 +70,7 @@
      <listitem>
       <para>
        The pathname to a directory that contains trusted SSL CA certificates
-       in PEM format.
+       in <acronym>PEM</acronym> format.
       </para>
      </listitem>
     </varlistentry>

reference/openssl/certparams.xml

@@ -21,12 +21,13 @@
       <listitem>
        <simpara>A string having the format
         <filename>file://path/to/cert.pem</filename>; the named file must
-        contain a PEM encoded certificate
+        contain a <acronym>PEM</acronym> encoded certificate
        </simpara>
       </listitem>
       <listitem>
        <simpara>
-        A string containing the content of a certificate, PEM encoded, may start with -----BEGIN CERTIFICATE-----
+        A string containing the content of a certificate, <acronym>PEM</acronym>
+        encoded, may start with <literal>-----BEGIN CERTIFICATE-----</literal>
        </simpara>
       </listitem>
      </orderedlist>
@@ -47,12 +48,13 @@
       <listitem>
        <simpara>A string having the format
         <filename>file://path/to/csr.pem</filename>; the named file must
-        contain a PEM encoded CSR
+        contain a <acronym>PEM</acronym> encoded <acronym>CSR</acronym>
        </simpara>
       </listitem>
       <listitem>
        <simpara>
-        A string containing the content of a CSR, PEM encoded, may start with -----BEGIN CERTIFICATE REQUEST-----
+        A string containing the content of a <acronym>CSR</acronym>, <acronym>PEM</acronym> encoded,
+        may start with <literal>-----BEGIN CERTIFICATE REQUEST-----</literal>
        </simpara>
       </listitem>
      </orderedlist>
@@ -81,12 +83,14 @@
       <listitem>
        <simpara>A string having the format
         <filename>file://path/to/file.pem</filename> - the named file must
-        contain a PEM encoded certificate/private key (it may contain both)
+        contain a <acronym>PEM</acronym> encoded certificate/private key (it may contain both)
        </simpara>
       </listitem>
       <listitem>
        <simpara>
-        A string containing the content of a certificate/key, PEM encoded, may start with -----BEGIN PUBLIC KEY-----
+        A string containing the content of a certificate/key,
+        <acronym>PEM</acronym> encoded, may start with
+        <literal>-----BEGIN PUBLIC KEY-----</literal>
        </simpara>
       </listitem>
       <listitem>

reference/openssl/constants.xml

@@ -705,7 +705,7 @@
       </term>
       <listitem>
         <simpara>
-         Indicates that encoding is DER (Distinguished Encoding Rules).
+         Indicates that encoding is <acronym>DER</acronym>.
         </simpara>
       </listitem>
     </varlistentry>
@@ -716,7 +716,7 @@
       </term>
       <listitem>
         <simpara>
-         Indicates that encoding is PEM (Privacy-Enhanced Mail).
+         Indicates that encoding is <acronym>PEM</acronym>.
         </simpara>
       </listitem>
     </varlistentry>

reference/openssl/functions/openssl-cms-read.xml

@@ -4,7 +4,7 @@
 <refentry xml:id="function.openssl-cms-read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>openssl_cms_read</refname>
-  <refpurpose>Export the CMS file to an array of PEM certificates</refpurpose>
+  <refpurpose>Export the CMS file to an array of <acronym>PEM</acronym> certificates</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">

reference/openssl/functions/openssl-csr-export-to-file.xml

@@ -17,7 +17,8 @@
   <para>
    <function>openssl_csr_export_to_file</function> takes the Certificate
    Signing Request represented by <parameter>csr</parameter> and saves it
-   in PEM format into the file named by <parameter>output_filename</parameter>.
+   in <acronym>PEM</acronym> format into the file named by
+   <parameter>output_filename</parameter>.
   </para>
  </refsect1>
 

reference/openssl/functions/openssl-csr-export.xml

@@ -16,8 +16,8 @@
   </methodsynopsis>
   <para>
    <function>openssl_csr_export</function> takes the Certificate Signing
-   Request represented by <parameter>csr</parameter> and stores it in 
-   PEM format in <parameter>output</parameter>, which is passed by
+   Request represented by <parameter>csr</parameter> and stores it in
+   <acronym>PEM</acronym> format in <parameter>output</parameter>, which is passed by
    reference.
   </para>
  </refsect1>
@@ -31,7 +31,8 @@
      <term><parameter>output</parameter></term>
      <listitem>
       <para>
-      on success, this string will contain the PEM encoded CSR
+       on success, this string will contain the <acronym>PEM</acronym>
+       encoded CSR
       </para>
      </listitem>
     </varlistentry>

reference/openssl/functions/openssl-csr-sign.xml

@@ -32,7 +32,7 @@
      <listitem>
       <para>
        A CSR previously generated by <function>openssl_csr_new</function>.
-       It can also be the path to a PEM encoded CSR when specified as
+       It can also be the path to a <acronym>PEM</acronym> encoded CSR when specified as
        <filename>file://path/to/csr</filename> or an exported string generated
        by <function>openssl_csr_export</function>.
       </para>

reference/openssl/functions/openssl-pkcs7-read.xml

@@ -3,7 +3,7 @@
 <refentry xml:id="function.openssl-pkcs7-read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>openssl_pkcs7_read</refname>
-  <refpurpose>Export the PKCS7 file to an array of PEM certificates</refpurpose>
+  <refpurpose>Export the PKCS7 file to an array of <acronym>PEM</acronym> certificates</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -36,7 +36,7 @@
     <term><parameter>certificates</parameter></term>
     <listitem>
      <para>
-      The array of PEM certificates from the p7b input data.
+      The array of <acronym>PEM</acronym> certificates from the p7b input data.
      </para>
     </listitem>
    </varlistentry>
@@ -54,7 +54,7 @@
   &reftitle.examples;
   <para>
    <example>
-    <title>Get a PEM array from a P7B file</title>
+    <title>Get a <acronym>PEM</acronym> array from a P7B file</title>
     <programlisting role="php">
 <![CDATA[
 <?php

reference/openssl/functions/openssl-pkcs7-verify.xml

@@ -52,7 +52,7 @@
       <para>
        If the <parameter>signers_certificates_filename</parameter> is specified, it should be a
        string holding the name of a file into which the certificates of the
-       persons that signed the messages will be stored in PEM format.
+       persons that signed the messages will be stored in <acronym>PEM</acronym> format.
       </para>
      </listitem>
     </varlistentry>

reference/openssl/functions/openssl-pkey-export-to-file.xml

@@ -17,7 +17,7 @@
   </methodsynopsis>
   <para>
    <function>openssl_pkey_export_to_file</function> saves an ascii-armoured
-   (PEM encoded) rendition of <parameter>key</parameter> into the file named
+   (<acronym>PEM</acronym> encoded) rendition of <parameter>key</parameter> into the file named
    by <parameter>output_filename</parameter>.  
   </para>
   &note.openssl.cnf;

reference/openssl/functions/openssl-pkey-export.xml

@@ -17,7 +17,7 @@
   </methodsynopsis>
   <para>
    <function>openssl_pkey_export</function> exports
-   <parameter>key</parameter> as a PEM encoded string and stores it into
+   <parameter>key</parameter> as a <acronym>PEM</acronym> encoded string and stores it into
    <parameter>output</parameter> (which is passed by reference).
   </para>
   &note.openssl.cnf;

reference/openssl/functions/openssl-pkey-get-private.xml

@@ -31,10 +31,10 @@
        <orderedlist>
         <listitem><simpara>a string having the format
           <filename>file://path/to/file.pem</filename>. The named file must
-          contain a PEM encoded certificate/private key (it may contain both).
+          contain a <acronym>PEM</acronym> encoded certificate/private key (it may contain both).
          </simpara>
         </listitem>
-        <listitem><simpara>A PEM formatted private key.</simpara></listitem>
+        <listitem><simpara>A <acronym>PEM</acronym> formatted private key.</simpara></listitem>
        </orderedlist>
       </para>
      </listitem>

reference/openssl/functions/openssl-pkey-get-public.xml

@@ -32,10 +32,10 @@
         <listitem><simpara>an <classname>OpenSSLAsymmetricKey</classname> instance</simpara></listitem>
         <listitem><simpara>a string having the format
           <filename>file://path/to/file.pem</filename>. The named file must
-          contain a PEM encoded certificate/public key (it may contain both).
+          contain a <acronym>PEM</acronym> encoded certificate/public key (it may contain both).
          </simpara>
         </listitem>
-        <listitem><simpara>A PEM formatted public key.</simpara></listitem>
+        <listitem><simpara>A <acronym>PEM</acronym> formatted public key.</simpara></listitem>
        </orderedlist>
       </para>
      </listitem>

reference/openssl/functions/openssl-sign.xml

@@ -52,7 +52,7 @@
        <classname>OpenSSLAsymmetricKey</classname> - a key, returned by <function>openssl_get_privatekey</function>
       </para>
       <para>
-       <type>string</type> - a PEM formatted key
+       <type>string</type> - a <acronym>PEM</acronym> formatted key
       </para>
      </listitem>
     </varlistentry>

reference/openssl/functions/openssl-spki-export.xml

@@ -3,7 +3,7 @@
 <refentry xml:id="function.openssl-spki-export" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>openssl_spki_export</refname>
-  <refpurpose>Exports a valid PEM formatted public key signed public key and challenge</refpurpose>
+  <refpurpose>Exports a valid <acronym>PEM</acronym> formatted public key signed public key and challenge</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -13,7 +13,7 @@
    <methodparam><type>string</type><parameter>spki</parameter></methodparam>
   </methodsynopsis>
   <para>
-    Exports PEM formatted public key from encoded signed public key and challenge
+    Exports <acronym>PEM</acronym> formatted public key from encoded signed public key and challenge
   </para>
  </refsect1>
 
@@ -34,7 +34,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns the associated PEM formatted public key or &false; on failure.
+   Returns the associated <acronym>PEM</acronym> formatted public key or &false; on failure.
   </para>
  </refsect1>
 
@@ -51,7 +51,7 @@
   <example xml:id="openssl_spki_export.example.basic">
    <title><function>openssl_spki_export</function> example</title>
    <para>
-      Extracts the associated PEM formatted public key or NULL on failure.
+      Extracts the associated <acronym>PEM</acronym> formatted public key or &null; on failure.
    </para>
    <programlisting role="php">
 <![CDATA[
@@ -70,7 +70,7 @@ if ($pubKey) {
   <example xml:id="openssl_spki_export.example.keygen">
    <title><function>openssl_spki_export</function> example from &lt;keygen&gt;</title>
    <para>
-      Extracts the associated PEM formatted public key issued from the &lt;keygen&gt; element
+      Extracts the associated <acronym>PEM</acronym> formatted public key issued from the &lt;keygen&gt; element
    </para>
    <programlisting role="php">
 <![CDATA[

reference/openssl/functions/openssl-verify.xml

@@ -51,8 +51,8 @@
        <classname>OpenSSLAsymmetricKey</classname> - a key, returned by <function>openssl_get_publickey</function>
       </para>
       <para>
-       <type>string</type> - a PEM formatted key, example, "-----BEGIN PUBLIC KEY-----
-MIIBCgK..."
+       <type>string</type> - a <acronym>PEM</acronym> formatted key (e.g. <literal>-----BEGIN PUBLIC KEY-----
+MIIBCgK...</literal>)
       </para>     
      </listitem>
     </varlistentry>

reference/openssl/functions/openssl-x509-checkpurpose.xml

@@ -99,7 +99,7 @@
      <term><parameter>untrusted_certificates_file</parameter></term>
      <listitem>
       <para>
-       If specified, this should be the name of a PEM encoded file holding
+       If specified, this should be the name of a <acronym>PEM</acronym> encoded file holding
        certificates that can be used to help verify the certificate, although
        no trust is placed in the certificates that come from that file.
       </para>

reference/openssl/functions/openssl-x509-export-to-file.xml

@@ -17,7 +17,7 @@
   <para>
    <function>openssl_x509_export_to_file</function> stores
    <parameter>certificate</parameter> into a file named by
-   <parameter>output_filename</parameter> in a PEM encoded format.
+   <parameter>output_filename</parameter> in a <acronym>PEM</acronym> encoded format.
   </para>
  </refsect1>
 

reference/openssl/functions/openssl-x509-export.xml

@@ -17,7 +17,7 @@
   <para>
    <function>openssl_x509_export</function> stores
    <parameter>certificate</parameter> into a string named by
-   <parameter>output</parameter> in a PEM encoded format.
+   <parameter>output</parameter> in a <acronym>PEM</acronym> encoded format.
   </para>
  </refsect1>
 
@@ -30,7 +30,7 @@
      <term><parameter>output</parameter></term>
      <listitem>
       <para>
-       On success, this will hold the PEM.
+       On success, this will hold the <acronym>PEM</acronym>.
       </para>
      </listitem>
     </varlistentry>

reference/openssl/functions/openssl-x509-verify.xml

@@ -32,8 +32,8 @@
        <classname>OpenSSLAsymmetricKey</classname> - a key, returned by <function>openssl_get_publickey</function>
       </para>
       <para>
-       <type>string</type> - a PEM formatted key, example, "-----BEGIN PUBLIC KEY-----
-MIIBCgK..."
+       <type>string</type> - a <acronym>PEM</acronym> formatted key (e.g. <literal>-----BEGIN PUBLIC KEY-----
+MIIBCgK...</literal>)
       </para>     
      </listitem>
     </varlistentry>

reference/pdo_mysql/constants.xml

@@ -190,7 +190,7 @@ foreach ($unbufferedResult as $row) {
    <listitem>
     <para>
      The file path to the directory that contains the trusted SSL
-     CA certificates, which are stored in PEM format.
+     CA certificates, which are stored in <acronym>PEM</acronym> format.
     </para>
    </listitem>
   </varlistentry>