]> granicus.if.org Git - apache/commitdiff
Backporting syntax highlighting and igalic's ssl changes for mod_r|s*.xml
authorDaniel Gruno <humbedooh@apache.org>
Fri, 4 May 2012 15:16:50 +0000 (15:16 +0000)
committerDaniel Gruno <humbedooh@apache.org>
Fri, 4 May 2012 15:16:50 +0000 (15:16 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1334024 13f79535-47bb-0310-9956-ffa450edef68

16 files changed:
docs/manual/mod/mod_ratelimit.xml
docs/manual/mod/mod_reflector.xml
docs/manual/mod/mod_remoteip.xml
docs/manual/mod/mod_reqtimeout.xml
docs/manual/mod/mod_rewrite.xml
docs/manual/mod/mod_sed.xml
docs/manual/mod/mod_session.xml
docs/manual/mod/mod_session_cookie.xml
docs/manual/mod/mod_session_crypto.xml
docs/manual/mod/mod_session_dbd.xml
docs/manual/mod/mod_setenvif.xml
docs/manual/mod/mod_so.xml
docs/manual/mod/mod_ssl.xml
docs/manual/mod/mod_status.xml
docs/manual/mod/mod_substitute.xml
docs/manual/mod/mod_suexec.xml

index 0128def4596c0ec226797c3478b3380d141fc7f0..e386dd581d9d5c60e7aca94b6924f31be2d022d4 100644 (file)
@@ -38,12 +38,12 @@ The connection speed to be simulated is specified, in KiB/s, using the environme
 variable <code>rate-limit</code>.</p>
 
 <example><title>Example Configuration</title>
-&lt;Location /downloads&gt;<br />
-<indent>
-SetOutputFilter RATE_LIMIT<br />
-SetEnv rate-limit 400 <br />
-</indent>
+<highlight language="config">
+&lt;Location /downloads&gt;
+    SetOutputFilter RATE_LIMIT
+    SetEnv rate-limit 400 
 &lt;/Location&gt;
+</highlight>
 </example>
 
 </summary>
index 880170e8b73f903e2fb8965f70f16becec2ca060..17e5d2c813a320a883b12d6e8fa28e2bc84ae416 100644 (file)
     <dd>Pass the request body through the DEFLATE filter to compress the
     body. This request requires a Content-Encoding request header containing
     "gzip" for the filter to return compressed data.
-    <example>
-      &lt;Location /compress&gt;<br/>
-        SetHandler reflector<br/>
-        SetOutputFilter DEFLATE<br/>
-      &lt;/Location&gt;
-    </example>
+    <highlight language="config">
+&lt;Location /compress&gt;
+    SetHandler reflector
+    SetOutputFilter DEFLATE
+&lt;/Location&gt;
+    </highlight>
     </dd>
 
     <dt>Image downsampling service</dt>
     <dd>Pass the request body through an image downsampling filter, and reflect
     the results to the caller.
-    <example>
-      &lt;Location /downsample&gt;<br/>
-        SetHandler reflector<br/>
-        SetOutputFilter DOWNSAMPLE<br/>
-      &lt;/Location&gt;
-    </example>
+    <highlight language="config">
+&lt;Location /downsample&gt;
+    SetHandler reflector
+    SetOutputFilter DOWNSAMPLE
+&lt;/Location&gt;
+    </highlight>
     </dd>
     </dl>
 </section>
index cfe6d2380d15613d07a1b89aa0512f09bc221777..bb764d33eb665b5e4eef90d90bbbcbeee6281cdc 100644 (file)
@@ -118,11 +118,15 @@ via the request headers.
     hosts presenting a <directive>RemoteIPHeader</directive> IP value.</p>
 
     <example><title>Internal (Load Balancer) Example</title>
+    <highlight language="config">
         RemoteIPHeader X-Client-IP
+        </highlight>
     </example>
 
     <example><title>Proxy Example</title>
+    <highlight language="config">
         RemoteIPHeader X-Forwarded-For
+        </highlight>
     </example>
 </usage>
 </directivesynopsis>
@@ -142,9 +146,11 @@ via the request headers.
     trusted when passed from these proxies.</p>
 
     <example><title>Internal (Load Balancer) Example</title>
-        RemoteIPHeader X-Client-IP<br/>
-        RemoteIPTrustedProxy 10.0.2.0/24<br/>
-        RemoteIPTrustedProxy gateway.localdomain
+    <highlight language="config">
+RemoteIPHeader X-Client-IP
+RemoteIPInternalProxy 10.0.2.0/24
+RemoteIPInternalProxy gateway.localdomain
+        </highlight>
     </example>
 </usage>
 </directivesynopsis>
@@ -165,14 +171,18 @@ via the request headers.
     the <directive>RemoteIPInternalProxy</directive> directive.</p>
 
     <example><title>Internal (Load Balancer) Example</title>
-        RemoteIPHeader X-Client-IP<br/>
-        RemoteIPTrustedProxyList conf/trusted-proxies.lst
+        <highlight language="config">
+RemoteIPHeader X-Client-IP
+RemoteIPInternalProxyList conf/trusted-proxies.lst
+        </highlight>
     </example>
 
     <example><title>conf/trusted-proxies.lst contents</title>
-         # Our internally trusted proxies;<br/>
-         10.0.2.0/24         #Everyone in the testing group<br/>
-         gateway.localdomain #The front end balancer
+    <example><pre>
+# Our internally trusted proxies;
+10.0.2.0/24         #Everyone in the testing group
+gateway.localdomain #The front end balancer
+         </pre></example>
     </example>
 </usage>
 </directivesynopsis>
@@ -193,8 +203,10 @@ via the request headers.
     <directive>RemoteIPInternalProxy</directive> addresses are discarded.</p>
 
     <example><title>Example</title>
-        RemoteIPHeader X-Forwarded-For<br/>
-        RemoteIPProxiesHeader X-Forwarded-By
+    <highlight language="config">
+RemoteIPHeader X-Forwarded-For
+RemoteIPProxiesHeader X-Forwarded-By
+    </highlight>
     </example>
 </usage>
 </directivesynopsis>
@@ -216,9 +228,11 @@ via the request headers.
     <directive>RemoteIPHeader</directive> header's value.</p>
 
     <example><title>Trusted (Load Balancer) Example</title>
-        RemoteIPHeader X-Forwarded-For<br/>
-        RemoteIPTrustedProxy 10.0.2.16/28<br/>
-        RemoteIPTrustedProxy proxy.example.com
+        <highlight language="config">
+RemoteIPHeader X-Forwarded-For
+RemoteIPTrustedProxy 10.0.2.16/28
+RemoteIPTrustedProxy proxy.example.com
+        </highlight>
     </example>
 </usage>
 </directivesynopsis>
@@ -235,12 +249,14 @@ via the request headers.
     to trust as presenting a valid RemoteIPHeader value of the useragent IP.</p>
 
     <p>The '<code>#</code>' hash character designates a comment line, otherwise
-    each whitespace or newline seperated entry is processed identically to
+    each whitespace or newline separated entry is processed identically to
     the <directive>RemoteIPTrustedProxy</directive> directive.</p>
 
     <example><title>Trusted (Load Balancer) Example</title>
-        RemoteIPHeader X-Forwarded-For<br/>
-        RemoteIPTrustedProxyList conf/trusted-proxies.lst
+    <highlight language="config">
+RemoteIPHeader X-Forwarded-For
+RemoteIPTrustedProxyList conf/trusted-proxies.lst
+        </highlight>
     </example>
 
     <example><title>conf/trusted-proxies.lst contents</title>
index 3707843081ebba4f48c8dfcbc91f38eff7edf299..cb5d5c89b2ed162606d3422ac77ea2f536d279ba 100644 (file)
         Allow 10 seconds to receive the request including the headers and
         30 seconds for receiving the request body:
 
-        <example>
+        <highlight language="config">
           RequestReadTimeout header=10 body=30
-        </example>
+        </highlight>
       </li>
 
       <li>
         Allow at least 10 seconds to receive the request body.
         If the client sends data, increase the timeout by 1 second for every
-        1000 bytes received, with no upper limit for the timeout (exept for
+        1000 bytes received, with no upper limit for the timeout (except for
         the limit given indirectly by
         <directive module="core">LimitRequestBody</directive>):
 
-        <example>
+        <highlight language="config">
           RequestReadTimeout body=10,MinRate=1000
-        </example>
+        </highlight>
       </li>
 
       <li>
@@ -60,9 +60,9 @@
         500 bytes received. But do not allow more than 30 seconds for the
         request including the headers:
 
-        <example>
+        <highlight language="config">
           RequestReadTimeout header=10-30,MinRate=500
-        </example>
+        </highlight>
       </li>
 
       <li>
@@ -70,9 +70,9 @@
         If a common configuration is used for http and https virtual hosts, the
         timeouts should not be set too low:
 
-        <example>
+        <highlight language="config">
           RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
-        </example>
+        </highlight>
       </li>
 
     </ol>
index 6dc853f500c274d94a369d3857deb1c7e13109ab..7ba1eddd3f598fc38a3341a56f50aa148554d590 100644 (file)
@@ -69,7 +69,9 @@ URLs on the fly</description>
     </note>
 
     <example><title>Example</title>
+    <highlight language="config">
       LogLevel alert rewrite:trace3
+      </highlight>
     </example>
 
     <note><title>RewriteLog</title>
@@ -234,16 +236,16 @@ Apache HTTP Server 2.0.41 and later</compatibility>
       <p>For example, you might define a
       <directive>RewriteMap</directive> as:</p>
 
-      <example>
+      <highlight language="config">
       RewriteMap examplemap txt:/path/to/file/map.txt
-      </example>
+      </highlight>
 
       <p>You would then be able to use this map in a
       <directive>RewriteRule</directive> as follows:</p>
 
-      <example>
+      <highlight language="config">
       RewriteRule ^/ex/(.*) ${examplemap:$1}
-      </example>
+      </highlight>
 
       <p>The following combinations for <em>MapType</em> and
       <em>MapSource</em> can be used:</p>
@@ -293,42 +295,38 @@ Apache HTTP Server 2.0.41 and later</compatibility>
 <override>FileInfo</override>
 
 <usage>
-      <p>The <directive>RewriteBase</directive> directive explicitly
-      sets the base URL-path (not filesystem directory path!)  for per-directory rewrites
-      that result in the substitution of a relative path.
-      When you use a <directive module="mod_rewrite">RewriteRule</directive>
-      in a <code>.htaccess</code> file, <module>mod_rewrite</module> strips off
-      the local directory prefix before processing, then rewrites the rest of
-      the URL. When the rewrite is completed, <module>mod_rewrite</module>
-      automatically adds the local directory prefix (or the
-      <directive>RewriteBase</directive> when set) back on to the substitution
-      before handing it back to the core of the server as if it were the original
-      URL.</p>
-
-      <p>This directive is <em>required</em> for per-directory rewrites whose context
-      is a directory made available via the <directive module="mod_alias">Alias</directive>
-      directive, when the substitution uses a relative path.</p>
-
-      <p>If your URL path does not exist verbatim on the filesystem,
-      or isn't directly under your <directive module="core">DocumentRoot</directive>,
-      you must use <directive>RewriteBase</directive> in every
-      <code>.htaccess</code> file where you want to use <directive
-      module="mod_rewrite">RewriteRule</directive> directives.</p>
-
-      <p>The example below demonstrates how to map
-      http://example.com/myapp/index.html to
-      /home/www/example/newsite.html, in a <code>.htaccess</code> file. This
-      assumes that the content available at
-      http://example.com/ is on disk at /home/www/example/</p>
-<example>
-<pre>
-RewriteEngine On
-# The URL-path used to get to this context, not the filesystem path
-RewriteBase /myapp/
-RewriteRule ^index\.html$  newsite.html
-</pre>
-</example>
+      <p>The <directive>RewriteBase</directive> directive specifies the
+      URL prefix to be used for per-directory (htaccess) 
+      <directive>RewriteRule</directive> directives that substitute a relative
+      path.</p>
+      <p> This directive is <em>required</em> when you use a relative path
+      in a substitution in per-directory (htaccess) context unless either
+      of the following conditions are true:</p>
+      <ul>
+          <li> The original request, and the substitution, are underneath the 
+               <directive module="core">DocumentRoot</directive>
+               (as opposed to reachable by other means, such as 
+               <directive module="mod_alias">Alias</directive>).</li>
+          <li> The <em>filesystem</em> path to the directory containing the
+               <directive>RewriteRule</directive>, suffixed by the relative 
+               substitution is also valid as a URL path on the server 
+               (this is rare).</li>
+      </ul>
 
+<p> In the example below, <directive>RewriteBase</directive> is necessary
+    to avoid rewriting to http://example.com/opt/myapp-1.2.3/welcome.html
+    since the resource was not relative to the document root.  This 
+    misconfiguration would normally cause the server to look for an "opt"
+    directory under the document root.</p>
+<highlight language="config">
+DocumentRoot /var/www/example.com
+Alias /myapp /opt/myapp-1.2.3
+&lt;Directory /opt/myapp-1.2.3&gt;
+    RewriteEngine On
+    RewriteBase /myapp/
+    RewriteRule ^index\.html$  welcome.html 
+&lt;/Directory&gt;
+</highlight>
 </usage>
 
 </directivesynopsis>
@@ -805,10 +803,10 @@ RewriteRule ^index\.html$  newsite.html
             to block unwanted hotlinking.
            </p>
 
-           <example>
+           <highlight language="config">
            RewriteCond expr "! %{HTTP_REFERER} -strmatch '*://%{HTTP_HOST}/*'"<br />
            RewriteRule ^/images - [F]
-           </example>
+           </highlight>
         </li>
 
         <li>You can also set special flags for
@@ -834,14 +832,12 @@ RewriteRule ^index\.html$  newsite.html
           Use this to combine rule conditions with a local OR
           instead of the implicit AND. Typical example:
 
-<example>
-<pre>
+<highlight language="config">
 RewriteCond %{REMOTE_HOST}  ^host1  [OR]
 RewriteCond %{REMOTE_HOST}  ^host2  [OR]
 RewriteCond %{REMOTE_HOST}  ^host3
 RewriteRule ...some special stuff for any of these hosts...
-</pre>
-</example>
+</highlight>
 
           Without this flag you would have to write the condition/rule
           pair three times.
@@ -866,8 +862,7 @@ RewriteRule ...some special stuff for any of these hosts...
         ``<code>User-Agent:</code>'' header of the request, you can
         use the following: </p>
 
-<example>
-<pre>
+<highlight language="config">
 RewriteCond  %{HTTP_USER_AGENT}  ^Mozilla
 RewriteRule  ^/$                 /homepage.max.html  [L]
 
@@ -875,8 +870,7 @@ RewriteCond  %{HTTP_USER_AGENT}  ^Lynx
 RewriteRule  ^/$                 /homepage.min.html  [L]
 
 RewriteRule  ^/$                 /homepage.std.html  [L]
-</pre>
-</example>
+</highlight>
 
         <p>Explanation: If you use a browser which identifies itself
         as 'Mozilla' (including Netscape Navigator, Mozilla etc), then you
@@ -911,10 +905,11 @@ RewriteRule  ^/$                 /homepage.std.html  [L]
 
       <p><a id="patterns" name="patterns"><em>Pattern</em></a> is
       a perl compatible <a id="regexp" name="regexp">regular
-      expression</a>. On the first RewriteRule it is applied to the (%-decoded)
-      <a href="./directive-dict.html#Syntax">URL-path</a> of the request;
-      subsequent patterns are applied to the output of the last matched
-      RewriteRule.</p>
+      expression</a>. On the first RewriteRule, it is matched against
+      the (%-decoded) <a href="./directive-dict.html#Syntax">URL-path</a> (or 
+      <a href="./directive-dict.html#Syntax">file-path</a>, depending 
+      on the context) of the request. Subsequent patterns are matched against the 
+      output of the last matching RewriteRule.</p>
 
 <note><title><a id="what_is_matched" name="what_is_matched">What is matched?</a></title>
       <p>In <directive module="core">VirtualHost</directive> context,
@@ -923,7 +918,7 @@ RewriteRule  ^/$                 /homepage.std.html  [L]
 
       <p>In <directive module="core">Directory</directive> and htaccess context,
       the <em>Pattern</em> will initially be matched against the
-      <em>filesystem</em> path, after removing the prefix that lead the server
+      <em>filesystem</em> path, after removing the prefix that led the server
       to the current <directive>RewriteRule</directive> (e.g. "app1/index.html"
       or "index.html" depending on where the directives are defined).</p>
 
@@ -955,7 +950,7 @@ and automatically <em>added</em> after any relative (not starting with a
 slash or protocol name) substitution encounters the end of a rule set.
 See the <directive module="mod_rewrite">RewriteBase</directive>
 directive for more information regarding what prefix will be added back to
-relative substitions.</li>
+relative substitutions.</li>
 
 <li> If you wish to match against the full URL-path in a per-directory
 (htaccess) RewriteRule, use the <code>%{REQUEST_URI}</code> variable in
@@ -1006,7 +1001,7 @@ cannot use <code>$N</code> in the substitution string!
         to be delivered to the client.  Substitutions are only
         treated as a file-system path when the rule is configured in 
         server (virtualhost) context and the first component of the
-        path in the substitution is exists in the file-system</dd>
+        path in the substitution exists in the file-system</dd>
 
         <dt>URL-path</dt>
 
@@ -1045,7 +1040,7 @@ cannot use <code>$N</code> in the substitution string!
 
       </dl>
 
-      <p>In addition to plain text, the <em>Substition</em> string can include</p>
+      <p>In addition to plain text, the <em>Substitution</em> string can include</p>
 
       <ol>
         <li>back-references (<code>$N</code>) to the RewriteRule
@@ -1073,7 +1068,7 @@ cannot use <code>$N</code> in the substitution string!
 
       <p>Rewrite rules are applied to the results of previous rewrite
       rules, in the order in which they are defined
-      in the config file. The URI or file path (see <a
+      in the config file. The URL-path or file-system path (see <a
       href="#what_is_matched">"What is matched?"</a>, above) is <strong>completely
       replaced</strong> by the <em>Substitution</em> and the
       rewriting process continues until all rules have been applied,
index 1a0c991ec27d0e9c1ca1d60a4bcfb318c3bd15b2..639a909d5e2d82772a07993e8c10be9bdb15f491 100644 (file)
@@ -62,33 +62,29 @@ the author's blog</a>.</p>
 
 <section id="sampleconf"><title>Sample Configuration</title>
     <example><title>Adding an output filter </title>
-         # In the following example, the sed filter will change the string<br />
-         # "monday" to "MON" and the string "sunday" to SUN in html documents<br />
-         # before sending to the client.<br />
-        <indent>
-        &lt;Directory "/var/www/docs/sed"&gt; <br />
-           <indent>
-           AddOutputFilter Sed html <br />
-           OutputSed "s/monday/MON/g" <br />
-           OutputSed "s/sunday/SUN/g" <br />
-           </indent>
-        &lt;/Directory&gt; <br />
-        </indent>
+    <highlight language="config">
+# In the following example, the sed filter will change the string
+# "monday" to "MON" and the string "sunday" to SUN in html documents
+# before sending to the client.
+&lt;Directory "/var/www/docs/sed"&gt; 
+    AddOutputFilter Sed html 
+    OutputSed "s/monday/MON/g" 
+    OutputSed "s/sunday/SUN/g" 
+&lt;/Directory&gt; 
+    </highlight>
     </example>
 
     <example><title>Adding an input filter </title>
-         # In the following example, the sed filter will change the string<br />
-         # "monday" to "MON" and the string "sunday" to SUN in the POST data<br />
-         # sent to PHP.<br />
-        <indent>
-        &lt;Directory "/var/www/docs/sed"&gt; <br />
-           <indent>
-           AddInputFilter Sed php <br />
-           InputSed "s/monday/MON/g" <br />
-           InputSed "s/sunday/SUN/g" <br />
-           </indent>
-        &lt;/Directory&gt; <br />
-        </indent>
+    <highlight language="config">
+# In the following example, the sed filter will change the string
+# "monday" to "MON" and the string "sunday" to SUN in the POST data
+# sent to PHP.
+&lt;Directory "/var/www/docs/sed"&gt; 
+    AddInputFilter Sed php 
+    InputSed "s/monday/MON/g" 
+    InputSed "s/sunday/SUN/g" 
+&lt;/Directory&gt; 
+        </highlight>
     </example>
 </section>
 <section id="sed_commands"><title>Sed Commands</title>
index 32c7c4fae66c1ef3ef5261e20209d4b620dcd50c..963c0f0ccb2abd814c50d930c439fe3c17413c7c 100644 (file)
       stored on the browser, in a cookie called <code>session</code>.</p>
 
       <example><title>Browser based session</title>
-        Session On<br />
-        SessionCookieName session path=/<br />
+      <highlight language="config">
+Session On
+SessionCookieName session path=/
+        </highlight>
       </example>
 
       <p>The session is not useful unless it can be written to or read from. The
       <code>X-Replace-Session</code>.</p>
 
       <example><title>Writing to a session</title>
-        Session On<br />
-        SessionCookieName session path=/<br />
-        SessionHeader X-Replace-Session<br />
+      <highlight language="config">
+Session On
+SessionCookieName session path=/
+SessionHeader X-Replace-Session
+        </highlight>
       </example>
 
       <p>The header should contain name value pairs expressed in the same format
       empty string has the effect of removing that key from the session.</p>
 
       <example><title>CGI to write to a session</title>
-        #!/bin/bash<br />
-        echo "Content-Type: text/plain"<br />
-        echo "X-Replace-Session: key1=foo&amp;key2=&amp;key3=bar"<br />
-        echo<br />
-        env<br />
+      <highlight language="sh">
+#!/bin/bash
+echo "Content-Type: text/plain"
+echo "X-Replace-Session: key1=foo&amp;key2=&amp;key3=bar"
+echo
+env
+        </highlight>
       </example>
 
       <p>If configured, the session can be read back from the HTTP_SESSION
       <directive module="mod_session">SessionEnv</directive> directive.</p>
 
       <example><title>Read from a session</title>
-        Session On<br />
-        SessionEnv On<br />
-        SessionCookieName session path=/<br />
-        SessionHeader X-Replace-Session<br />
+      <highlight language="config">
+Session On
+SessionEnv On
+SessionCookieName session path=/
+SessionHeader X-Replace-Session
+        </highlight>
       </example>
 
       <p>Once read, the CGI variable <code>HTTP_SESSION</code> should contain
       module.</p>
 
       <example><title>Browser based encrypted session</title>
-        Session On<br />
-        SessionCryptoPassphrase secret<br />
-        SessionCookieName session path=/<br />
+      <highlight language="config">
+Session On
+SessionCryptoPassphrase secret
+SessionCookieName session path=/
+        </highlight>
       </example>
 
       <p>The session will be automatically decrypted on load, and encrypted on
       as in the example below.</p>
 
       <example><title>Setting cookie parameters</title>
-        Session On<br />
-        SessionCryptoPassphrase secret<br />
-        SessionCookieName session path=/private;domain=example.com;httponly;secure;<br />
+      <highlight language="config">
+Session On
+SessionCryptoPassphrase secret
+SessionCookieName session path=/private;domain=example.com;httponly;secure;
+        </highlight>
       </example>
 
       <p>In cases where the Apache server forms the frontend for backend origin servers,
       the session.</p>
 
       <example><title>Form based authentication</title>
-        Session On<br />
-        SessionCryptoPassphrase secret<br />
-        SessionCookieName session path=/<br />
-        AuthFormProvider file<br />
-        AuthUserFile conf/passwd<br />
-        AuthType form<br />
-        AuthName realm<br />
-        ...<br />
+      <highlight language="config">
+Session On
+SessionCryptoPassphrase secret
+SessionCookieName session path=/
+AuthFormProvider file
+AuthUserFile conf/passwd
+AuthType form
+AuthName realm
+#...
+        </highlight>
       </example>
 
       <p>See the <module>mod_auth_form</module> module for documentation and complete
index 5eadd4ffdb276d1b4292acca0eaefdd2d9c4b562..39a86b531c75c1b2ead2e819e1086499ab99f95b 100644 (file)
       <var>session</var>, configure the session as follows:</p>
 
       <example><title>Browser based session</title>
-        Session On<br />
-        SessionCookieName session path=/<br />
+      <highlight language="config">
+Session On
+SessionCookieName session path=/
+        </highlight>
       </example>
 
       <p>For more examples on how the session can be configured to be read
     </p>
 
     <example><title>Cookie with attributes</title>
-      Session On<br />
-      SessionCookieName session path=/private;domain=example.com;httponly;secure;version=1;<br />
+    <highlight language="config">
+Session On
+SessionCookieName session path=/private;domain=example.com;httponly;secure;version=1;
+      </highlight>
     </example>
 
 </usage>
     </p>
 
     <example><title>Cookie2 with attributes</title>
-      Session On<br />
-      SessionCookieName2 session path=/private;domain=example.com;httponly;secure;version=1;<br />
+    <highlight language="config">
+Session On
+SessionCookieName2 session path=/private;domain=example.com;httponly;secure;version=1;
+    </highlight>
     </example>
 
 </usage>
index 0edfd96fea9c125e7b3bf446dc591c3aa38002d1..1277dc75548d26bbf50bf0536e1d690985c8b687 100644 (file)
       <var>session</var>, configure the session as follows:</p>
 
       <example><title>Browser based encrypted session</title>
-        Session On<br />
-        SessionCookieName session path=/<br />
-        SessionCryptoPassphrase secret
+      <highlight language="config">
+Session On
+SessionCookieName session path=/
+SessionCryptoPassphrase secret
+    </highlight>
       </example>
 
       <p>The session will be encrypted with the given key. Different servers can
     which are specified as parameters with optional values after the driver name.</p>
 
     <example><title>NSS without a certificate database</title>
+    <highlight language="config">
       SessionCryptoDriver nss
+      </highlight>
     </example>
 
     <example><title>NSS with certificate database</title>
+    <highlight language="config">
       SessionCryptoDriver nss dir=certs
+      </highlight>
     </example>
 
     <example><title>NSS with certificate database and parameters</title>
+    <highlight language="config">
       SessionCryptoDriver nss dir=certs key3=key3.db cert7=cert7.db secmod=secmod
+      </highlight>
     </example>
 
     <example><title>NSS with paths containing spaces</title>
+    <highlight language="config">
       SessionCryptoDriver nss "dir=My Certs" key3=key3.db cert7=cert7.db secmod=secmod
+      </highlight>
     </example>
 
     <p>The <var>NSS</var> crypto driver might have already been configured by another
     To avoid this warning, use the noinit parameter as follows.</p>
 
     <example><title>NSS with certificate database</title>
+    <highlight language="config">
       SessionCryptoDriver nss noinit
+      </highlight>
     </example>
 
     <p>To prevent confusion, ensure that all modules requiring NSS are configured with
     the engine to be used for encryption.</p>
 
     <example><title>OpenSSL with engine support</title>
+    <highlight language="config">
       SessionCryptoDriver openssl engine=name
+      </highlight>
     </example>
 
 </usage>
index b1663ed66abcbf4d70ad34d665e3ccb36f23974c..88cb809f3fd40035c1d2db002d1962e951f02860 100644 (file)
       session. These queries are configured as per the example below.</p>
 
       <example><title>Sample DBD configuration</title>
-        DBDriver pgsql<br />
-        DBDParams "dbname=apachesession user=apache password=xxxxx host=localhost"<br />
-        DBDPrepareSQL "delete from session where key = %s" deletesession<br />
-        DBDPrepareSQL "update session set value = %s, expiry = %lld where key = %s" updatesession<br />
-        DBDPrepareSQL "insert into session (value, expiry, key) values (%s, %lld, %s)" insertsession<br />
-        DBDPrepareSQL "select value from session where key = %s and (expiry = 0 or expiry &gt; %lld)" selectsession<br />
-        DBDPrepareSQL "delete from session where expiry != 0 and expiry &lt; %lld" cleansession<br />
+      <highlight language="config">
+DBDriver pgsql
+DBDParams "dbname=apachesession user=apache password=xxxxx host=localhost"
+DBDPrepareSQL "delete from session where key = %s" deletesession
+DBDPrepareSQL "update session set value = %s, expiry = %lld where key = %s" updatesession
+DBDPrepareSQL "insert into session (value, expiry, key) values (%s, %lld, %s)" insertsession
+DBDPrepareSQL "select value from session where key = %s and (expiry = 0 or expiry &gt; %lld)" selectsession
+DBDPrepareSQL "delete from session where expiry != 0 and expiry &lt; %lld" cleansession
+    </highlight>
       </example>
 
     </section>
       called <var>session</var>, configure the session as follows:</p>
 
       <example><title>SQL based anonymous session</title>
-        Session On<br />
-        SessionDBDCookieName session path=/<br />
+      <highlight language="config">
+Session On
+SessionDBDCookieName session path=/
+        </highlight>
       </example>
 
       <p>For more examples on how the session can be configured to be read
       userid, configure the session as follows:</p>
 
       <example><title>SQL based per user session</title>
-        Session On<br />
-        SessionDBDPerUser On<br />
+      <highlight language="config">
+Session On
+SessionDBDPerUser On
+        </highlight>
       </example>
 
     </section>
     </p>
 
     <example><title>Cookie with attributes</title>
-      Session On<br />
-      SessionDBDCookieName session path=/private;domain=example.com;httponly;secure;version=1;<br />
+    <highlight language="config">
+Session On
+SessionDBDCookieName session path=/private;domain=example.com;httponly;secure;version=1;
+      </highlight>
     </example>
 
 </usage>
     </p>
 
     <example><title>Cookie2 with attributes</title>
-      Session On<br />
-      SessionDBDCookieName2 session path=/private;domain=example.com;httponly;secure;version=1;<br />
+    <highlight language="config">
+Session On
+SessionDBDCookieName2 session path=/private;domain=example.com;httponly;secure;version=1;
+      </highlight>
     </example>
 
 </usage>
index 9ff7ff404e829a93389eb6af53c9d6d473e4190c..a41641794e11eb9777b48e631fad4b93d7bbad1b 100644 (file)
@@ -44,10 +44,10 @@ on characteristics of the request</description>
     such as this example, which sets <code>netscape</code> if the
     browser is mozilla but not MSIE.</p>
 
-<example>
-  BrowserMatch ^Mozilla netscape<br />
-  BrowserMatch MSIE !netscape<br />
-</example>
+<highlight language="config">
+BrowserMatch ^Mozilla netscape
+BrowserMatch MSIE !netscape
+</highlight>
 </summary>
 
 <seealso><a href="../env.html">Environment Variables in Apache HTTP Server</a></seealso>
@@ -69,17 +69,17 @@ on characteristics of the request</description>
   sets environment variables conditional on the
   <code>User-Agent</code> HTTP request header.  The following two
   lines have the same effect:</p>
-<example>
-   BrowserMatchNoCase Robot is_a_robot<br />
-   SetEnvIfNoCase User-Agent Robot is_a_robot<br />
-</example>
+<highlight language="config">
+BrowserMatchNoCase Robot is_a_robot
+SetEnvIfNoCase User-Agent Robot is_a_robot
+</highlight>
 
     <p>Some additional examples:</p>
-<example>
-    BrowserMatch ^Mozilla forms jpeg=yes browser=netscape<br />
-    BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript<br />
-    BrowserMatch MSIE !javascript<br />
-</example>
+<highlight language="config">
+BrowserMatch ^Mozilla forms jpeg=yes browser=netscape
+BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript
+BrowserMatch MSIE !javascript
+</highlight>
 </usage>
 </directivesynopsis>
 
@@ -101,20 +101,20 @@ respect to case</description>
     module="mod_setenvif">BrowserMatch</directive> directive.
     However, it provides for case-insensitive matching. For
     example:</p>
-<example>
-    BrowserMatchNoCase mac platform=macintosh<br />
-    BrowserMatchNoCase win platform=windows<br />
-</example>
+<highlight language="config">
+BrowserMatchNoCase mac platform=macintosh
+BrowserMatchNoCase win platform=windows
+</highlight>
 
     <p>The <directive>BrowserMatch</directive> and
     <directive>BrowserMatchNoCase</directive> directives are special cases of
     the <directive module="mod_setenvif">SetEnvIf</directive> and <directive
     module="mod_setenvif">SetEnvIfNoCase</directive>
     directives. The following two lines have the same effect:</p>
-<example>
-   BrowserMatchNoCase Robot is_a_robot<br />
-   SetEnvIfNoCase User-Agent Robot is_a_robot<br />
-</example>
+<highlight language="config">
+BrowserMatchNoCase Robot is_a_robot
+SetEnvIfNoCase User-Agent Robot is_a_robot
+</highlight>
 </usage>
 </directivesynopsis>
 
@@ -211,18 +211,17 @@ of</p>
     <var>value</var> and replace them by parenthesized subexpressions
     of <var>regex</var>.</p>
 
-<example>
-<title>Example:</title>
-   SetEnvIf Request_URI "\.gif$" object_is_image=gif<br />
-   SetEnvIf Request_URI "\.jpg$" object_is_image=jpg<br />
-   SetEnvIf Request_URI "\.xbm$" object_is_image=xbm<br />
-        :<br />
-   SetEnvIf Referer www\.mydomain\.example\.com intra_site_referral<br />
-        :<br />
-   SetEnvIf object_is_image xbm XBIT_PROCESSING=1<br />
-        :<br />
-   SetEnvIf ^TS  ^[a-z]  HAVE_TS<br />
-</example>
+<highlight language="config">
+SetEnvIf Request_URI "\.gif$" object_is_image=gif
+SetEnvIf Request_URI "\.jpg$" object_is_image=jpg
+SetEnvIf Request_URI "\.xbm$" object_is_image=xbm
+    
+SetEnvIf Referer www\.mydomain\.example\.com intra_site_referral
+    
+SetEnvIf object_is_image xbm XBIT_PROCESSING=1
+    
+SetEnvIf ^TS  ^[a-z]  HAVE_TS
+</highlight>
 
     <p>The first three will set the environment variable
     <code>object_is_image</code> if the request was for an image
@@ -261,9 +260,9 @@ for additional examples.
     and applied <em>env-variable</em> in the same fashion as <directive
     >SetEnvIf</directive>.</p>
 
-<example>
+<highlight language="config">
     SetEnvIfExpr "tolower(req('X-Sendfile')) == 'd:\images\very_big.iso')" iso_delivered
-</example>
+</highlight>
 
     <p>This would set the environment variable <code>iso_delivered</code>
     every time our application attempts to send it via <code>X-Sendfile</code></p>
@@ -271,9 +270,9 @@ for additional examples.
     <p>A more useful example would be to set the variable rfc1918 if the
     remote IP address is a private address according to RFC 1918:</p>
 
-<example>
+<highlight language="config">
     SetEnvIfExpr "-R '10.0.0.0/8' || -R '172.16.0.0/12' || -R '192.168.0.0/16'" rfc1918
-</example>
+</highlight>
 </usage>
 
 <seealso><a href="../expr.html">Expressions in Apache HTTP Server</a>,
@@ -301,9 +300,9 @@ without respect to case</description>
     the <directive module="mod_setenvif">SetEnvIf</directive> directive,
     and differs only in that the regular expression matching is
     performed in a case-insensitive manner. For example:</p>
-<example>
+<highlight language="config">
    SetEnvIfNoCase Host Example\.Org site=example
-</example>
+</highlight>
 
     <p>This will cause the <code>site</code> environment variable
     to be set to "<code>example</code>" if the HTTP request header
index cef79cb8dade65fcdc59264304cefde271e11bf3..045cab339522ccc930fb631661fea789ad40855f 100644 (file)
@@ -144,7 +144,7 @@ Windows</compatibility>
 
     <p>For example:</p>
 
-    <example>LoadFile libexec/libxmlparse.so</example>
+    <highlight language="config">LoadFile libexec/libxmlparse.so</highlight>
 
 </usage>
 </directivesynopsis>
@@ -167,9 +167,9 @@ of active modules</description>
     href="module-dict.html#ModuleIdentifier">Module Identifier</a>
     in the module documentation. Example:</p>
 
-    <example>
+    <highlight language="config">
       LoadModule status_module modules/mod_status.so
-    </example>
+    </highlight>
 
     <p>loads the named module from the modules subdirectory of the
     ServerRoot.</p>
index 21c79382fee70652d8039520b61c3445c81a517f..9a40a4d7c0ccbbd9f7ada59dfebf6429229dc082 100644 (file)
@@ -169,8 +169,9 @@ For backward compatibility there is additionally a special
 provided. Information about this function is provided in the <a
 href="../ssl/ssl_compat.html">Compatibility</a> chapter.</p>
 <example><title>Example</title>
-CustomLog logs/ssl_request_log \
-          "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
+<highlight language="config">
+CustomLog logs/ssl_request_log "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
+</highlight>
 </example>
 </section>
 
@@ -214,9 +215,9 @@ string in <module>mod_log_config</module>.</p>
        encrypted with SSL. This is similar to the
        <directive>SSLRequireSSL</directive> directive.</p>
 
-    <example>
+    <highlight language="config">
       Require ssl
-    </example>
+    </highlight>
 
   </section>
 
@@ -229,10 +230,10 @@ string in <module>mod_log_config</module>.</p>
     <p>The following example grants access if the user is authenticated
        either with a client certificate or by username and password.</p>
 
-    <example>
+    <highlight language="config">
       Require ssl-verify-client<br/>
       Require valid-user
-    </example>
+    </highlight>
 
   </section>
 
@@ -311,7 +312,9 @@ query can be done in two ways which can be configured by
     program is called only once per unique Pass Phrase.</p></li>
 </ul>
 <example><title>Example</title>
+<highlight language="config">
 SSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -365,16 +368,7 @@ The following <em>source</em> variants are available:</p>
     can take a long time). Here using an existing <code>/dev/urandom</code> is
     better, because it never blocks and actually gives the amount of requested
     data. The drawback is just that the quality of the received data may not
-    be the best.</p>
-    <p>
-    On some platforms like FreeBSD one can even control how the entropy is
-    actually generated, i.e. by which system interrupts. More details one can
-    find under <em>rndcontrol(8)</em> on those platforms. Alternatively, when
-    your system lacks such a random device, you can use tool
-    like <a href="http://www.lothar.com/tech/crypto/">EGD</a>
-    (Entropy Gathering Daemon) and run it's client program with the
-    <code>exec:/path/to/program/</code> variant (see below) or use
-    <code>egd:/path/to/egd-socket</code> (see below).</p></li>
+    be the best.</p></li>
 
 <li><code>exec:/path/to/program</code>
     <p>
@@ -400,13 +394,15 @@ The following <em>source</em> variants are available:</p>
     on your platform.</p></li>
 </ul>
 <example><title>Example</title>
-SSLRandomSeed startup builtin<br />
-SSLRandomSeed startup file:/dev/random<br />
-SSLRandomSeed startup file:/dev/urandom 1024<br />
-SSLRandomSeed startup exec:/usr/local/bin/truerand 16<br />
-SSLRandomSeed connect builtin<br />
-SSLRandomSeed connect file:/dev/random<br />
-SSLRandomSeed connect file:/dev/urandom 1024<br />
+<highlight language="config">
+SSLRandomSeed startup builtin
+SSLRandomSeed startup file:/dev/random
+SSLRandomSeed startup file:/dev/urandom 1024
+SSLRandomSeed startup exec:/usr/local/bin/truerand 16
+SSLRandomSeed connect builtin
+SSLRandomSeed connect file:/dev/random
+SSLRandomSeed connect file:/dev/urandom 1024
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -477,8 +473,10 @@ The following five storage <em>type</em>s are currently supported:</p>
 </ul>
 
 <example><title>Examples</title>
-SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data<br />
+<highlight language="config">
+SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data
 SSLSessionCache shmcb:/usr/local/apache/logs/ssl_gcache_data(512000)
+</highlight>
 </example>
 
 <p>The <code>ssl-cache</code> mutex is used to serialize access to
@@ -503,7 +501,9 @@ global/inter-process SSL Session Cache and the OpenSSL internal memory cache.
 It can be set as low as 15 for testing, but should be set to higher
 values like 300 in real life.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLSessionCacheTimeout 600
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -524,10 +524,12 @@ type="section">VirtualHost</directive> section to enable SSL/TLS for a
 that virtual host. By default the SSL/TLS Protocol Engine is
 disabled for both the main server and all configured virtual hosts.</p>
 <example><title>Example</title>
-&lt;VirtualHost _default_:443&gt;<br />
-SSLEngine on<br />
-...<br />
+<highlight language="config">
+&lt;VirtualHost _default_:443&gt;
+SSLEngine on
+#...
 &lt;/VirtualHost&gt;
+</highlight>
 </example>
 <p>In Apache 2.1 and later, <directive>SSLEngine</directive> can be set to
 <code>optional</code>. This enables support for
@@ -608,7 +610,9 @@ The available (case-insensitive) <em>protocol</em>s are:</p>
     ``<code>+SSLv3 +TLSv1 +TLSv1.1 +TLSv1.2</code>, respectively.</p></li>
 </ul>
 <example><title>Example</title>
+<highlight language="config">
 SSLProtocol TLSv1
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -716,28 +720,31 @@ prefixes are:</p>
 -v</code>'' command which provides a nice way to successively create the
 correct <em>cipher-spec</em> string. The default <em>cipher-spec</em> string
 depends on the version of the OpenSSL libraries used. Let's suppose it is
-``<code>ALL:!aNULL:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code>'' which
-means the following: first, remove from consideration any ciphers that do not
-authenticate, i.e. for SSL the Anonymous Diffie-Hellman ciphers. Next,
-use ciphers using RC4 and RSA. Next include the high, medium and then the low
-security ciphers. Finally <em>pull</em> all SSLv2 and export ciphers to the
-end of the list.</p>
+``<code>RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5</code>'' which
+means the following: Put <code>RC4-SHA</code> and <code>AES128-SHA</code> at
+the beginning. We do this, because these ciphers offer a good compromise
+between speed and security. Next, include high and medium security ciphers.
+Finally, remove all ciphers which do not authenticate, i.e. for SSL the
+Anonymous Diffie-Hellman ciphers, as well as all ciphers which use
+<code>MD5</code> as hash algorithm, because it has been proven insufficient.</p>
 <example>
 <pre>
-$ openssl ciphers -v 'ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP'
-NULL-SHA                SSLv3 Kx=RSA      Au=RSA  Enc=None      Mac=SHA1
-NULL-MD5                SSLv3 Kx=RSA      Au=RSA  Enc=None      Mac=MD5
-EDH-RSA-DES-CBC3-SHA    SSLv3 Kx=DH       Au=RSA  Enc=3DES(168) Mac=SHA1
+$ openssl ciphers -v 'RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5'
+RC4-SHA                 SSLv3 Kx=RSA      Au=RSA  Enc=RC4(128)  Mac=SHA1
+AES128-SHA              SSLv3 Kx=RSA      Au=RSA  Enc=AES(128)  Mac=SHA1
+DHE-RSA-AES256-SHA      SSLv3 Kx=DH       Au=RSA  Enc=AES(256)  Mac=SHA1
 ...                     ...               ...     ...           ...
-EXP-RC4-MD5             SSLv3 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
-EXP-RC2-CBC-MD5         SSLv2 Kx=RSA(512) Au=RSA  Enc=RC2(40)   Mac=MD5  export
-EXP-RC4-MD5             SSLv2 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
+SEED-SHA                SSLv3 Kx=RSA      Au=RSA  Enc=SEED(128) Mac=SHA1
+PSK-RC4-SHA             SSLv3 Kx=PSK      Au=PSK  Enc=RC4(128)  Mac=SHA1
+KRB5-RC4-SHA            SSLv3 Kx=KRB5     Au=KRB5 Enc=RC4(128)  Mac=SHA1
 </pre>
 </example>
 <p>The complete list of particular RSA &amp; DH ciphers for SSL is given in <a
 href="#table2">Table 2</a>.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCipherSuite RSA:!EXP:!NULL:+HIGH:+MEDIUM:-LOW
+</highlight>
 </example>
 <table border="1">
 <columnspec><column width=".3"/><column width=".1"/><column width=".13"/>
@@ -795,7 +802,9 @@ Pass Phrase dialog is forced at startup time. This directive can be used up to
 two times (referencing different filenames) when both a RSA and a DSA based
 server certificate is used in parallel.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCertificateFile /usr/local/apache2/conf/ssl.crt/server.crt
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -822,7 +831,9 @@ at startup time. This directive can be used up to two times
 (referencing different filenames) when both a RSA and a DSA based
 private key is used in parallel.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCertificateKeyFile /usr/local/apache2/conf/ssl.key/server.key
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -861,7 +872,9 @@ using a coupled RSA+DSA certificate pair, this will work only if actually both
 certificates use the <em>same</em> certificate chain. Else the browsers will be
 confused in this situation.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCertificateChainFile /usr/local/apache2/conf/ssl.crt/ca.crt
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -886,7 +899,9 @@ there: you also have to create symbolic links named
 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
 contains the appropriate symbolic links.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCACertificatePath /usr/local/apache2/conf/ssl.crt/
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -908,7 +923,9 @@ concatenation of the various PEM-encoded Certificate files, in order of
 preference. This can be used alternatively and/or additionally to
 <directive module="mod_ssl">SSLCACertificatePath</directive>.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-client.crt
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -953,7 +970,9 @@ specify an <em>all-in-one</em> file containing a concatenation of
 PEM-encoded CA certificates.</p>
 
 <example><title>Example</title>
+<highlight language="config">
 SSLCADNRequestFile /usr/local/apache2/conf/ca-names.crt
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -980,7 +999,9 @@ Certificate files there: you also have to create symbolic links named
 <em>hash-value</em><code>.N</code>. And you should always make sure
 this directory contains the appropriate symbolic links.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCADNRequestPath /usr/local/apache2/conf/ca-names.crt/
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1005,7 +1026,9 @@ Additionally you have to create symbolic links named
 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
 contains the appropriate symbolic links.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCARevocationPath /usr/local/apache2/conf/ssl.crl/
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1028,7 +1051,9 @@ the various PEM-encoded CRL files, in order of preference. This can be
 used alternatively and/or additionally to <directive
 module="mod_ssl">SSLCARevocationPath</directive>.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-client.crl
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1065,7 +1090,9 @@ to succeed - otherwise it will fail with an
 </p>
 </note>
 <example><title>Example</title>
+<highlight language="config">
 SSLCARevocationCheck chain
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1109,7 +1136,9 @@ The following levels are available for <em>level</em>:</p>
 <strong>optional_no_ca</strong> is actually against the idea of
 authentication (but can be used to establish SSL test pages, etc.)</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLVerifyClient require
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1144,7 +1173,9 @@ certificate can be self-signed or has to be signed by a CA which is directly
 known to the server (i.e. the CA's certificate is under
 <directive module="mod_ssl">SSLCACertificatePath</directive>), etc.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLVerifyDepth 10
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1250,10 +1281,12 @@ The available <em>option</em>s are:</p>
 </li>
 </ul>
 <example><title>Example</title>
-SSLOptions +FakeBasicAuth -StrictRequire<br />
-&lt;Files ~ "\.(cgi|shtml)$"&gt;<br />
-    SSLOptions +StdEnvVars -ExportCertData<br />
+<highlight language="config">
+SSLOptions +FakeBasicAuth -StrictRequire
+&lt;Files ~ "\.(cgi|shtml)$"&gt;
+    SSLOptions +StdEnvVars -ExportCertData
 &lt;Files&gt;
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1275,7 +1308,9 @@ host or directories for defending against configuration errors that expose
 stuff that should be protected. When this directive is present all requests
 are denied which are not using SSL.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLRequireSSL
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1366,12 +1401,14 @@ both parsed and executed each time the .htaccess file is encountered during
 request processing.</p>
 
 <example><title>Example</title>
-<pre>SSLRequire (    %{SSL_CIPHER} !~ m/^(EXP|NULL)-/                \
+<highlight language="config">
+SSLRequire (    %{SSL_CIPHER} !~ m/^(EXP|NULL)-/                \
             and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd."        \
             and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"}  \
             and %{TIME_WDAY} &gt;= 1 and %{TIME_WDAY} &lt;= 5          \
             and %{TIME_HOUR} &gt;= 8 and %{TIME_HOUR} &lt;= 20       ) \
-           or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/</pre>
+           or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/
+</highlight>
 </example>
 
 <p>The <code>PeerExtList(<em>object-ID</em>)</code> function expects
@@ -1383,7 +1420,9 @@ exactly against the value of an extension identified with this OID.
 extension must match).</p>
 
 <example><title>Example</title>
+<highlight language="config">
 SSLRequire "foobar" in PeerExtList("1.2.3.4.5.6")
+</highlight>
 </example>
 
 <note><title>Notes on the PeerExtList function</title>
@@ -1405,7 +1444,6 @@ the left-hand-side expression.</p></li>
 </ul>
 </note>
 
-
 </usage>
 <seealso><a href="../env.html">Environment Variables in Apache HTTP Server</a>,
 for additional examples.
@@ -1441,7 +1479,9 @@ memory must be considered when changing this configuration setting.
 </p></note>
 
 <example><title>Example</title>
+<highlight language="config">
 SSLRenegBufferSize 262144
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1473,7 +1513,9 @@ version of OpenSSL.
 </p></note>
 
 <example><title>Example</title>
+<highlight language="config">
 SSLStrictSNIVHostCheck on
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1498,7 +1540,9 @@ directory contains the appropriate symbolic links.</p>
 <p>Currently there is no support for encrypted private keys</p>
 </note>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1525,7 +1569,9 @@ or additionally to <code>SSLProxyMachineCertificatePath</code>.
 <p>Currently there is no support for encrypted private keys</p>
 </note>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1555,7 +1601,9 @@ trusted as if they were also in <directive module="mod_ssl">
 SSLProxyCACertificateFile</directive>.</p>
 </note>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyMachineCertificateChainFile /usr/local/apache2/conf/ssl.crt/proxyCA.pem
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1592,7 +1640,9 @@ The following levels are available for <em>level</em>:</p>
 <strong>optional_no_ca</strong> is actually against the idea of
 authentication (but can be used to establish SSL test pages, etc.)</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyVerify require
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1619,7 +1669,9 @@ the remote server certificate can be self-signed or has to be signed by a CA
 which is directly known to the server (i.e. the CA's certificate is under
 <directive module="mod_ssl">SSLProxyCACertificatePath</directive>), etc.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyVerifyDepth 10
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1640,7 +1692,9 @@ is expired or not. If the check fails a 502 status code (Bad Gateway) is
 sent.
 </p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyCheckPeerExpire on
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1661,7 +1715,9 @@ compared against the hostname of the request URL. If both are not equal
 a 502 status code (Bad Gateway) is sent.
 </p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyCheckPeerCN on
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1682,10 +1738,12 @@ type="section">VirtualHost</directive> section to enable SSL/TLS for proxy
 usage in a particular virtual host. By default the SSL/TLS Protocol Engine is
 disabled for proxy image both for the main server and all configured virtual hosts.</p>
 <example><title>Example</title>
-&lt;VirtualHost _default_:443&gt;<br />
-SSLProxyEngine on<br />
-...<br />
+<highlight language="config">
+&lt;VirtualHost _default_:443&gt;
+    SSLProxyEngine on
+    #...
 &lt;/VirtualHost&gt;
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1749,7 +1807,9 @@ there: you also have to create symbolic links named
 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
 contains the appropriate symbolic links.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyCACertificatePath /usr/local/apache2/conf/ssl.crt/
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1771,7 +1831,9 @@ concatenation of the various PEM-encoded Certificate files, in order of
 preference. This can be used alternatively and/or additionally to
 <directive module="mod_ssl">SSLProxyCACertificatePath</directive>.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-remote-server.crt
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1796,7 +1858,9 @@ Additionally you have to create symbolic links named
 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
 contains the appropriate symbolic links.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyCARevocationPath /usr/local/apache2/conf/ssl.crl/
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1819,7 +1883,9 @@ the various PEM-encoded CRL files, in order of preference. This can be
 used alternatively and/or additionally to <directive
 module="mod_ssl">SSLProxyCARevocationPath</directive>.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server.crl
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1857,7 +1923,9 @@ to succeed - otherwise it will fail with an
 </p>
 </note>
 <example><title>Example</title>
+<highlight language="config">
 SSLProxyCARevocationCheck chain
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1885,7 +1953,9 @@ any of the <a href="#envvars">SSL environment variables</a>.</p>
 href="#ssloptions">SSLOptions</a>).</p>
 
 <example><title>Example</title>
+<highlight language="config">
 SSLUserName SSL_CLIENT_S_DN_CN
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1903,7 +1973,9 @@ SSLUserName SSL_CLIENT_S_DN_CN
 the client's preference is used.  If this directive is enabled, the
 server's preference will be used instead.</p>
 <example><title>Example</title>
+<highlight language="config">
 SSLHonorCipherOrder on
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1927,8 +1999,10 @@ separate "-engine" releases of OpenSSL 0.9.6 must be used.</p>
 &quot;<code>openssl engine</code>&quot;.</p>
 
 <example><title>Example</title>
-# For a Broadcom accelerator:<br />
+<highlight language="config">
+# For a Broadcom accelerator:
 SSLCryptoDevice ubsec
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -1954,10 +2028,12 @@ itself, or derived by configuration; see the
 directives.</p>
 
 <example><title>Example</title>
-SSLVerifyClient on<br/>
-SSLOCSPEnable on<br/>
-SSLOCSPDefaultResponder http://responder.example.com:8888/responder<br/>
+<highlight language="config">
+SSLVerifyClient on
+SSLOCSPEnable on
+SSLOCSPDefaultResponder http://responder.example.com:8888/responder
 SSLOCSPOverrideResponder on
+</highlight>
 </example>
 </usage>
 </directivesynopsis>
@@ -2072,7 +2148,9 @@ in <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-200
 </note>
 
 <example><title>Example</title>
+<highlight language="config">
 SSLInsecureRenegotiation on
+</highlight>
 </example>
 
 <p>The <code>SSL_SECURE_RENEG</code> environment variable can be used
index 20c7cc904995e0aa4e1e441c2600f02bfb17ec56..12e94927b149e8879589a2073b109030f0a7d99d 100644 (file)
@@ -77,15 +77,12 @@ performance</description>
     <p>To enable status reports only for browsers from the example.com
     domain add this code to your <code>httpd.conf</code>
     configuration file</p>
-<example>
-    &lt;Location /server-status&gt;<br />
-    <indent>
-    SetHandler server-status<br />
-<br />
-    Require host example.com<br />
-    </indent>
-    &lt;/Location&gt;
-</example>
+<highlight language="config">
+&lt;Location /server-status&gt;
+    SetHandler server-status
+    Require host example.com
+&lt;/Location&gt;
+</highlight>
 
     <p>You can now access server statistics by using a Web browser
     to access the page
index 0e0ab41e48e44bad3ad3bfec520ea73095dc9c62..3c275decad598cced30adfa75bd590db7915dacb 100644 (file)
     </dl>
 
     <example><title>Example</title>
-        &lt;Location /&gt;
-        <indent>
-            AddOutputFilterByType SUBSTITUTE text/html<br />
-            Substitute s/foo/bar/ni<br />
-        </indent>
-        &lt;/Location&gt;
+    <highlight language="config">
+&lt;Location /&gt;
+    AddOutputFilterByType SUBSTITUTE text/html
+    Substitute s/foo/bar/ni
+&lt;/Location&gt;
+        </highlight>
     </example>
 
     <p>If either the pattern or the substitution contain a slash
     character then an alternative delimiter should be used:</p>
 
     <example><title>Example of using an alternate delimiter</title>
-        &lt;Location /&gt;
-        <indent>
-            AddOutputFilterByType SUBSTITUTE text/html<br />
-            Substitute "s|&lt;BR */?&gt;|&lt;br /&gt;|i"
-        </indent>
-        &lt;/Location&gt;
+    <highlight language="config">
+&lt;Location /&gt;
+    AddOutputFilterByType SUBSTITUTE text/html
+    Substitute "s|&lt;BR */?&gt;|&lt;br /&gt;|i"
+&lt;/Location&gt;
+        </highlight>
     </example>
 
     <p>Backreferences can be used in the comparison and in the substitution,
     when regular expressions are used, as illustrated in the following example: </p>
     <example><title>Example of using backreferences and captures</title>
-        &lt;Location /&gt;
-        <indent>
-            AddOutputFilterByType SUBSTITUTE text/html<br />
-            # "foo=k,bar=k" -> "foo/bar=k" <br />
-            Substitute "s|foo=(\w+),bar=\1|foo/bar=$1"
-        </indent>
-        &lt;/Location&gt;
+    <highlight language="config">
+&lt;Location /&gt;
+    AddOutputFilterByType SUBSTITUTE text/html
+    # "foo=k,bar=k" -> "foo/bar=k" 
+    Substitute "s|foo=(\w+),bar=\1|foo/bar=$1"
+&lt;/Location&gt;
+    </highlight>
     </example>
 
     <p>A common use scenario for <code>mod_substitute</code> is the
     those URLs into something that will work from the front end:</p>
 
     <example><title>Rewriting URLs embedded in proxied content</title>
-    ProxyPass /blog/ http://internal.blog.example.com<br />
-    ProxyPassReverse /blog/ http://internal.blog.example.com/<br />
-    <br />
-    Substitute "s|http://internal.blog.example.com/|http://www.example.com/blog/|i"
+    <highlight language="config">
+ProxyPass /blog/ http://internal.blog.example.com
+ProxyPassReverse /blog/ http://internal.blog.example.com/
+
+Substitute "s|http://internal.blog.example.com/|http://www.example.com/blog/|i"
+    </highlight>
     </example>
 
     <p><directive module="mod_proxy">ProxyPassReverse</directive>
index f2d3ce0d788fa25922ae43d3c80d84cd135fc651..2a8232b25cdbb6db382fc6fb4e13056c85fb1b67 100644 (file)
@@ -57,7 +57,9 @@ later.</compatibility>
 
     <example>
     <title>Example</title>
+    <highlight language="config">
     SuexecUserGroup nobody nogroup
+    </highlight>
     </example>
 
     <p>In Apache httpd 2.3.9 and later, startup will fail if this