Document SSLCryptoDevice and fix some example titles.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@103838 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 31 insertions, 13 deletions

diff --git a/docs/manual/mod/mod_ssl.xml b/docs/manual/mod/mod_ssl.xml
index 80f87b4186..99bcc8e25c 100644
--- a/docs/manual/mod/mod_ssl.xml
+++ b/docs/manual/mod/mod_ssl.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
-<!-- $Revision: 1.26 $ -->
+<!-- $Revision: 1.27 $ -->
 
 <!--
  Copyright 2002-2004 The Apache Software Foundation
@@ -118,9 +118,7 @@ For backward compatibility there is additionally a special
 ``<code>%{</code><em>name</em><code>}c</code>'' cryptography format function
 provided. Information about this function is provided in the <a
 href="../ssl/ssl_compat.html">Compatibility</a> chapter.</p>
-<p>
-Example:</p>
-<example>
+<example><title>Example</title>
 CustomLog logs/ssl_request_log \
           "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
 </example>
@@ -187,9 +185,7 @@ query can be done in two ways which can be configured by
     The reuse-algorithm above is used here, too. In other words: The external
     program is called only once per unique Pass Phrase.</p></li>
 </ul>
-<p>
-Example:</p>
-<example>
+<example><title>Example</title>
 SSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter
 </example>
 </usage>
@@ -1221,9 +1217,7 @@ comes with mod_ssl to accomplish this task.
 <note type="warning">
 <p>Currently there is no support for encrypted private keys</p>
 </note>
-<p>
-Example:</p>
-<example>
+<example><title>Example</title>
 SSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/
 </example> 
 </usage> 
@@ -1250,9 +1244,7 @@ or additionally to <code>SSLProxyMachineCertificatePath</code>.
 <note type="warning">
 <p>Currently there is no support for encrypted private keys</p>
 </note>
-<p>
-Example:</p>
-<example>
+<example><title>Example</title>
 SSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem
 </example>
 </usage>
@@ -1538,4 +1530,30 @@ SSLHonorCipherOrder on
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>SSLCryptoDevice</name>
+<description>Enable use of a cryptographic hardware accelerator</description>
+<syntax>SSLCryptoDevice <em>engine</em></syntax>
+<contextlist><context>server config</context></contextlist>
+<compatibility>Available if mod_ssl is built using <code>-DSSL_ENGINE_EXPERIMENTAL</code></compatibility>
+<default>SSLCryptoDevice builtin</default>
+
+<usage>
+<p>
+This directive enables use of a cryptographic hardware accelerator
+board to offload some of the SSL processing overhead.  This directive
+can only be used if the SSL toolkit is built with "engine" support;
+OpenSSL 0.9.7 and later releases have "engine" support by default, the
+separate "-engine" releases of OpenSSL 0.9.6 must be used.</p>
+
+<p>To discover which engine names are supported, run the command
+&quot;<code>openssl engine</code>&quot;.</p>
+
+<example><title>Example</title>
+# For a Broadcom accelerator:<br />
+SSLCryptoDevice ubsec
+</example>
+</usage>
+</directivesynopsis>
+
 </modulesynopsis>