You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by hu...@apache.org on 2012/04/26 20:16:48 UTC
svn commit: r1331006 - in /httpd/httpd/trunk/docs/manual/mod:
mod_headers.xml mod_heartbeat.xml mod_heartmonitor.xml mod_imagemap.xml
mod_include.xml mod_info.xml mod_isapi.xml
Author: humbedooh
Date: Thu Apr 26 18:16:48 2012
New Revision: 1331006
URL: http://svn.apache.org/viewvc?rev=1331006&view=rev
Log:
Syntax updates for mod_h*.xml, mod_i*.xml
Modified:
httpd/httpd/trunk/docs/manual/mod/mod_headers.xml
httpd/httpd/trunk/docs/manual/mod/mod_heartbeat.xml
httpd/httpd/trunk/docs/manual/mod/mod_heartmonitor.xml
httpd/httpd/trunk/docs/manual/mod/mod_imagemap.xml
httpd/httpd/trunk/docs/manual/mod/mod_include.xml
httpd/httpd/trunk/docs/manual/mod/mod_info.xml
httpd/httpd/trunk/docs/manual/mod/mod_isapi.xml
Modified: httpd/httpd/trunk/docs/manual/mod/mod_headers.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_headers.xml?rev=1331006&r1=1331005&r2=1331006&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_headers.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_headers.xml Thu Apr 26 18:16:48 2012
@@ -47,10 +47,10 @@ headers</description>
href="../sections.html#mergin">configuration sections</a>. These
two directives have a different effect if reversed:</p>
- <example>
- RequestHeader append MirrorID "mirror 12"<br />
- RequestHeader unset MirrorID
- </example>
+ <highlight language="config">
+RequestHeader append MirrorID "mirror 12"
+RequestHeader unset MirrorID
+ </highlight>
<p>This way round, the <code>MirrorID</code> header is not set. If
reversed, the MirrorID header is set to "mirror 12".</p>
@@ -84,9 +84,9 @@ headers</description>
Copy all request headers that begin with "TS" to the
response headers:
- <example>
+ <highlight language="config">
Header echo ^TS
- </example>
+ </highlight>
</li>
<li>
@@ -96,9 +96,9 @@ headers</description>
the client to intuit load on the server or in isolating
bottlenecks between the client and the server.
- <example>
+ <highlight language="config">
Header set MyHeader "%D %t"
- </example>
+ </highlight>
<p>results in this header being added to the response:</p>
@@ -110,10 +110,9 @@ headers</description>
<li>
Say hello to Joe
- <example>
- Header set MyHeader "Hello Joe. It took %D microseconds \<br />
- for Apache to serve this request."
- </example>
+ <highlight language="config">
+Header set MyHeader "Hello Joe. It took %D microseconds for Apache to serve this request."
+ </highlight>
<p>results in this header being added to the response:</p>
@@ -130,10 +129,10 @@ headers</description>
stimulus. Note that this example requires the services of the
<module>mod_setenvif</module> module.
- <example>
- SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader<br />
- Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader
- </example>
+ <highlight language="config">
+SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader
+Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader
+ </highlight>
<p>If the header <code>MyRequestHeader: myvalue</code> is present on
the HTTP request, the response will contain the following header:</p>
@@ -149,9 +148,9 @@ headers</description>
description</a>) by replacing <var>https:</var> with
<var>http:</var> in the <var>Destination</var> header:
- <example>
+ <highlight language="config">
RequestHeader edit Destination ^https: http: early
- </example>
+ </highlight>
</li>
<li>
@@ -162,11 +161,11 @@ headers</description>
<code>NO_STORE</code> environment variables all existed for the
request):
- <example>
- Header merge Cache-Control no-cache env=CGI<br />
- Header merge Cache-Control no-cache env=NO_CACHE<br />
- Header merge Cache-Control no-store env=NO_STORE
- </example>
+ <highlight language="config">
+Header merge Cache-Control no-cache env=CGI
+Header merge Cache-Control no-cache env=NO_CACHE
+Header merge Cache-Control no-store env=NO_STORE
+ </highlight>
<p>then the response would contain the following header:</p>
@@ -183,9 +182,9 @@ headers</description>
</li>
<li>
Set a test cookie if and only if the client didn't send us a cookie
- <example>
+ <highlight language="config">
Header set Set-Cookie testcookie "expr=-z %{req:Cookie}"
- </example>
+ </highlight>
</li>
</ol>
</section>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_heartbeat.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_heartbeat.xml?rev=1331006&r1=1331005&r2=1331006&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_heartbeat.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_heartbeat.xml Thu Apr 26 18:16:48 2012
@@ -82,9 +82,9 @@ multicast address to which <module>mod_h
status information. This address will usually correspond to a configured
<directive module="mod_heartmonitor">HeartbeatListen</directive> on a
frontend proxy system.</p>
-<example>
+<highlight language="config">
HeartbeatAddress 239.0.0.1:27999
-</example>
+</highlight>
</usage>
</directivesynopsis>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_heartmonitor.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_heartmonitor.xml?rev=1331006&r1=1331005&r2=1331006&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_heartmonitor.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_heartmonitor.xml Thu Apr 26 18:16:48 2012
@@ -66,9 +66,9 @@ use <module>mod_slotmem_shm</module>.</p
module="mod_heartbeat">HeartbeatAddress</directive> on an origin server.
</p>
- <example>
+ <highlight language="config">
HeartbeatListen 239.0.0.1:27999
- </example>
+ </highlight>
<p> This module is inactive until this directive is used.</p>
</usage>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_imagemap.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_imagemap.xml?rev=1331006&r1=1331005&r2=1331006&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_imagemap.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_imagemap.xml Thu Apr 26 18:16:48 2012
@@ -40,11 +40,11 @@
<p>The following directive will activate files ending with
<code>.map</code> as imagemap files:</p>
- <example>AddHandler imap-file map</example>
+ <highlight language="config">AddHandler imap-file map</highlight>
<p>Note that the following is still supported:</p>
- <example>AddType application/x-httpd-imap map</example>
+ <highlight language="config">AddType application/x-httpd-imap map</highlight>
<p>However, we are trying to phase out "magic MIME types" so we
are deprecating this method.</p>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_include.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_include.xml?rev=1331006&r1=1331005&r2=1331006&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_include.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_include.xml Thu Apr 26 18:16:48 2012
@@ -53,10 +53,10 @@
parse them and assign the resulting document the mime type of
<code>text/html</code>:</p>
- <example>
- AddType text/html .shtml<br />
- AddOutputFilter INCLUDES .shtml
- </example>
+ <highlight language="config">
+AddType text/html .shtml
+AddOutputFilter INCLUDES .shtml
+ </highlight>
<p>The following directive must be given for the directories
containing the shtml files (typically in a
@@ -65,9 +65,9 @@
<directive module="core">AllowOverride</directive> <code>Options</code>
is set):</p>
- <example>
+ <highlight language="config">
Options +Includes
- </example>
+ </highlight>
<p>For backwards compatibility, the <code>server-parsed</code>
<a href="../handler.html">handler</a> also activates the
@@ -764,9 +764,9 @@
<p>This directive changes the string that <module>mod_include</module>
looks for to mark the end of an include element.</p>
- <example><title>Example</title>
+ <highlight language="config">
SSIEndTag "%>"
- </example>
+ </highlight>
</usage>
<seealso><directive module="mod_include">SSIStartTag</directive></seealso>
@@ -786,9 +786,9 @@
<p>This directive changes the string that <module>mod_include</module>
displays when a variable is not set and "echoed".</p>
- <example><title>Example</title>
+ <highlight language="config">
SSIUndefinedEcho "<!-- undef -->"
- </example>
+ </highlight>
</usage>
</directivesynopsis>
@@ -814,9 +814,9 @@ directive]"</default>
<p>This directive has the same effect as the <code><!--#config
errmsg=<var>message</var> --></code> element.</p>
- <example><title>Example</title>
+ <highlight language="config">
SSIErrorMsg "<!-- Error -->"
- </example>
+ </highlight>
</usage>
</directivesynopsis>
@@ -837,10 +837,10 @@ directive]"</default>
output of a file each processing different commands (possibly at
different times).</p>
- <example><title>Example</title>
+ <highlight language="config">
SSIStartTag "<%"<br />
SSIEndTag "%>"
- </example>
+ </highlight>
<p>The example given above, which also specifies a matching
<directive module="mod_include">SSIEndTag</directive>, will
@@ -875,9 +875,9 @@ displayed</description>
<p>This directive has the same effect as the <code><!--#config
timefmt=<var>formatstring</var> --></code> element.</p>
- <example><title>Example</title>
+ <highlight language="config">
SSITimeFormat "%R, %B %d, %Y"
- </example>
+ </highlight>
<p>The above directive would cause times to be displayed in the
format "22:26, June 14, 2002".</p>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_info.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_info.xml?rev=1331006&r1=1331005&r2=1331006&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_info.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_info.xml Thu Apr 26 18:16:48 2012
@@ -33,27 +33,23 @@ configuration</description>
<p>To configure <module>mod_info</module>, add the following to your
<code>httpd.conf</code> file.</p>
- <example>
- <Location /server-info><br />
- <indent>
- SetHandler server-info<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+<Location /server-info>
+ SetHandler server-info
+</Location>
+ </highlight>
<p>You may wish to use <module>mod_access</module> inside the
<directive type="section" module="core">Location</directive>
directive to limit access to your server configuration
information:</p>
- <example>
- <Location /server-info><br />
- <indent>
- SetHandler server-info<br />
- Require host example.com<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+<Location /server-info>
+ SetHandler server-info
+ Require host example.com
+</Location>
+ </highlight>
<p>Once configured, the server information is obtained by
accessing <code>http://your.host.example.com/server-info</code></p>
@@ -76,16 +72,16 @@ configuration</description>
to limit access to your server configuration information.</p>
<example><title>Access control</title>
- <Location /server-info><br />
- <indent>
- SetHandler server-info<br />
- Order allow,deny<br />
- # Allow access from server itself<br />
- Allow from 127.0.0.1<br />
- # Additionally, allow access from local workstation<br />
- Allow from 192.168.1.17<br />
- </indent>
- </Location>
+ <highlight language="config">
+<Location /server-info>
+ SetHandler server-info
+ Order allow,deny
+ # Allow access from server itself
+ Allow from 127.0.0.1
+ # Additionally, allow access from local workstation
+ Allow from 192.168.1.17
+</Location>
+ </highlight>
</example>
</section>
@@ -165,13 +161,11 @@ information displayed by the server-info
HTML interpreted, <strong>Additional Information</strong> for
the module <var>module-name</var>. Example:</p>
- <example>
- AddModuleInfo mod_deflate.c 'See <a \<br />
- <indent>
- href="http://www.apache.org/docs/&httpd.docs;/mod/mod_deflate.html">\<br />
- http://www.apache.org/docs/&httpd.docs;/mod/mod_deflate.html</a>'
- </indent>
- </example>
+ <highlight language="config">
+AddModuleInfo mod_deflate.c 'See <a \
+ href="http://www.apache.org/docs/&httpd.docs;/mod/mod_deflate.html">\
+ http://www.apache.org/docs/&httpd.docs;/mod/mod_deflate.html</a>'
+ </highlight>
</usage>
</directivesynopsis>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_isapi.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_isapi.xml?rev=1331006&r1=1331005&r2=1331006&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_isapi.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_isapi.xml Thu Apr 26 18:16:48 2012
@@ -51,9 +51,9 @@
it to them with their file extensions. To enable any .dll file to be
processed as an ISAPI extension, edit the httpd.conf file and add the
following line:</p>
- <example>
+ <highlight language="config">
AddHandler isapi-handler .dll
- </example>
+ </highlight>
<note>In older versions of the Apache server,
<code>isapi-isa</code> was the proper handler name, rather than
@@ -66,9 +66,9 @@
requested module loaded. However, you may preload and keep a
specific module loaded by using the following syntax in your
httpd.conf:</p>
- <example>
+ <highlight language="config">
ISAPICacheFile c:/WebWork/Scripts/ISAPI/mytest.dll
- </example>
+ </highlight>
<p>Whether or not you have preloaded an ISAPI extension, all
ISAPI extensions are governed by the same permissions and