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/05/04 17:07:49 UTC
svn commit: r1334018 - in /httpd/httpd/branches/2.4.x/docs/manual/mod:
mod_imagemap.xml mod_include.xml mod_info.xml mod_isapi.xml mod_ldap.xml
mod_log_config.xml mod_log_debug.xml mod_lua.xml mod_mime.xml
mod_mime_magic.xml mod_negotiation.xml
Author: humbedooh
Date: Fri May 4 15:07:48 2012
New Revision: 1334018
URL: http://svn.apache.org/viewvc?rev=1334018&view=rev
Log:
Backporting syntax highlighting for mod_i|l|m|n*.xml
Modified:
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_imagemap.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_include.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_info.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_isapi.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ldap.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_config.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_debug.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_lua.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime_magic.xml
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_negotiation.xml
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_imagemap.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_imagemap.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_imagemap.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_imagemap.xml Fri May 4 15:07: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/branches/2.4.x/docs/manual/mod/mod_include.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_include.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_include.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_include.xml Fri May 4 15:07: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/branches/2.4.x/docs/manual/mod/mod_info.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_info.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_info.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_info.xml Fri May 4 15:07: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/branches/2.4.x/docs/manual/mod/mod_isapi.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_isapi.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_isapi.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_isapi.xml Fri May 4 15:07: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
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ldap.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ldap.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ldap.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ldap.xml Fri May 4 15:07:48 2012
@@ -60,34 +60,32 @@ by other LDAP modules</description>
<module>mod_ldap</module> to increase the performance of HTTP Basic
authentication provided by <module>mod_authnz_ldap</module>.</p>
- <example>
- # Enable the LDAP connection pool and shared<br />
- # memory cache. Enable the LDAP cache status<br />
- # handler. Requires that mod_ldap and mod_authnz_ldap<br />
- # be loaded. Change the "yourdomain.example.com" to<br />
- # match your domain.<br />
- <br />
- LDAPSharedCacheSize 500000<br />
- LDAPCacheEntries 1024<br />
- LDAPCacheTTL 600<br />
- LDAPOpCacheEntries 1024<br />
- LDAPOpCacheTTL 600<br />
- <br />
- <Location /ldap-status><br />
- <indent>
- SetHandler ldap-status<br />
-
- Require host yourdomain.example.com<br />
-
- Satisfy any<br />
- AuthType Basic<br />
- AuthName "LDAP Protected"<br />
- AuthBasicProvider ldap<br />
- AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one<br />
- Require valid-user<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+# Enable the LDAP connection pool and shared
+# memory cache. Enable the LDAP cache status
+# handler. Requires that mod_ldap and mod_authnz_ldap
+# be loaded. Change the "yourdomain.example.com" to
+# match your domain.
+
+LDAPSharedCacheSize 500000
+LDAPCacheEntries 1024
+LDAPCacheTTL 600
+LDAPOpCacheEntries 1024
+LDAPOpCacheTTL 600
+
+<Location /ldap-status>
+ SetHandler ldap-status
+
+ Require host yourdomain.example.com
+
+ Satisfy any
+ AuthType Basic
+ AuthName "LDAP Protected"
+ AuthBasicProvider ldap
+ AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one
+ Require valid-user
+</Location>
+ </highlight>
</section>
<section id="pool"><title>LDAP Connection Pool</title>
@@ -183,13 +181,11 @@ by other LDAP modules</description>
following directives could be used to access the
<module>mod_ldap</module> cache information:</p>
- <example>
- <Location /server/cache-info><br />
- <indent>
- SetHandler ldap-status<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+<Location /server/cache-info>
+ SetHandler ldap-status
+</Location>
+ </highlight>
<p>By fetching the URL <code>http://servername/cache-info</code>,
the administrator can get a status report of every cache that is used
@@ -211,51 +207,47 @@ by other LDAP modules</description>
optional client certificates to be used, as well as the type of
encryption to be used on the connection (none, SSL or TLS/STARTTLS).</p>
- <example>
- # Establish an SSL LDAP connection on port 636. Requires that <br />
- # mod_ldap and mod_authnz_ldap be loaded. Change the <br />
- # "yourdomain.example.com" to match your domain.<br />
- <br />
- LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
- <br />
- <Location /ldap-status><br />
- <indent>
- SetHandler ldap-status<br />
-
- Require host yourdomain.example.com<br />
-
- Satisfy any<br />
- AuthType Basic<br />
- AuthName "LDAP Protected"<br />
- AuthBasicProvider ldap<br />
- AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
- Require valid-user<br />
- </indent>
- </Location>
- </example>
-
- <example>
- # Establish a TLS LDAP connection on port 389. Requires that <br />
- # mod_ldap and mod_authnz_ldap be loaded. Change the <br />
- # "yourdomain.example.com" to match your domain.<br />
- <br />
- LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
- <br />
- <Location /ldap-status><br />
- <indent>
- SetHandler ldap-status<br />
-
- Require host yourdomain.example.com<br />
-
- Satisfy any<br />
- AuthType Basic<br />
- AuthName "LDAP Protected"<br />
- AuthBasicProvider ldap<br />
- AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one TLS<br />
- Require valid-user<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+# Establish an SSL LDAP connection on port 636. Requires that
+# mod_ldap and mod_authnz_ldap be loaded. Change the
+# "yourdomain.example.com" to match your domain.
+
+LDAPTrustedGlobalCert CA_DER /certs/certfile.der
+
+<Location /ldap-status>
+ SetHandler ldap-status
+
+ Require host yourdomain.example.com
+
+ Satisfy any
+ AuthType Basic
+ AuthName "LDAP Protected"
+ AuthBasicProvider ldap
+ AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one
+ Require valid-user
+</Location>
+ </highlight>
+
+ <highlight language="config">
+# Establish a TLS LDAP connection on port 389. Requires that
+# mod_ldap and mod_authnz_ldap be loaded. Change the
+# "yourdomain.example.com" to match your domain.
+
+LDAPTrustedGlobalCert CA_DER /certs/certfile.der
+
+<Location /ldap-status>
+ SetHandler ldap-status
+
+ Require host yourdomain.example.com
+
+ Satisfy any
+ AuthType Basic
+ AuthName "LDAP Protected"
+ AuthBasicProvider ldap
+ AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one TLS
+ Require valid-user
+</Location>
+ </highlight>
</section>
@@ -288,29 +280,27 @@ by other LDAP modules</description>
an error when an attempt is made to contact the LDAP server at
runtime.</p>
- <example>
- # Specify a Netscape CA certificate file<br />
- LDAPTrustedGlobalCert CA_CERT7_DB /certs/cert7.db<br />
- # Specify an optional key3.db file for client certificate support<br />
- LDAPTrustedGlobalCert CERT_KEY3_DB /certs/key3.db<br />
- # Specify the secmod file if required<br />
- LDAPTrustedGlobalCert CA_SECMOD /certs/secmod<br />
- <Location /ldap-status><br />
- <indent>
- SetHandler ldap-status<br />
-
- Require host yourdomain.example.com<br />
-
- Satisfy any<br />
- AuthType Basic<br />
- AuthName "LDAP Protected"<br />
- AuthBasicProvider ldap<br />
- LDAPTrustedClientCert CERT_NICKNAME <nickname> [password]<br />
- AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
- Require valid-user<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+# Specify a Netscape CA certificate file
+LDAPTrustedGlobalCert CA_CERT7_DB /certs/cert7.db
+# Specify an optional key3.db file for client certificate support
+LDAPTrustedGlobalCert CERT_KEY3_DB /certs/key3.db
+# Specify the secmod file if required
+LDAPTrustedGlobalCert CA_SECMOD /certs/secmod
+<Location /ldap-status>
+ SetHandler ldap-status
+
+ Require host yourdomain.example.com
+
+ Satisfy any
+ AuthType Basic
+ AuthName "LDAP Protected"
+ AuthBasicProvider ldap
+ LDAPTrustedClientCert CERT_NICKNAME <nickname> [password]
+ AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one
+ Require valid-user
+</Location>
+ </highlight>
</section>
@@ -330,16 +320,16 @@ by other LDAP modules</description>
LDAPTrustedMode parameter. If an ldaps:// URL is specified,
SSL mode is forced, override this directive.</p>
- <example>
- # Specify two CA certificate files<br />
- LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
- LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
- # Specify a client certificate file and key<br />
- LDAPTrustedGlobalCert CERT_BASE64 /certs/cert1.pem<br />
- LDAPTrustedGlobalCert KEY_BASE64 /certs/key1.pem [password]<br />
- # Do not use this directive, as it will throw an error<br />
- #LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
- </example>
+ <highlight language="config">
+# Specify two CA certificate files
+LDAPTrustedGlobalCert CA_DER /certs/cacert1.der
+LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem
+# Specify a client certificate file and key
+LDAPTrustedGlobalCert CERT_BASE64 /certs/cert1.pem
+LDAPTrustedGlobalCert KEY_BASE64 /certs/key1.pem [password]
+# Do not use this directive, as it will throw an error
+#LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem
+ </highlight>
</section>
@@ -362,30 +352,28 @@ by other LDAP modules</description>
(ldaps://) support has been deprecated to be replaced with TLS,
although the SSL functionality still works.</p>
- <example>
- # Specify two CA certificate files<br />
- LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
- LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
- <Location /ldap-status><br />
- <indent>
- SetHandler ldap-status<br />
-
- Require host yourdomain.example.com<br />
-
- LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
- LDAPTrustedClientCert KEY_BASE64 /certs/key1.pem<br />
- # CA certs respecified due to per-directory client certs<br />
- LDAPTrustedClientCert CA_DER /certs/cacert1.der<br />
- LDAPTrustedClientCert CA_BASE64 /certs/cacert2.pem<br />
- Satisfy any<br />
- AuthType Basic<br />
- AuthName "LDAP Protected"<br />
- AuthBasicProvider ldap<br />
- AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
- Require valid-user<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+# Specify two CA certificate files
+LDAPTrustedGlobalCert CA_DER /certs/cacert1.der
+LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem
+<Location /ldap-status>
+ SetHandler ldap-status
+
+ Require host yourdomain.example.com
+
+ LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem
+ LDAPTrustedClientCert KEY_BASE64 /certs/key1.pem
+ # CA certs respecified due to per-directory client certs
+ LDAPTrustedClientCert CA_DER /certs/cacert1.der
+ LDAPTrustedClientCert CA_BASE64 /certs/cacert2.pem
+ Satisfy any
+ AuthType Basic
+ AuthName "LDAP Protected"
+ AuthBasicProvider ldap
+ AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one
+ Require valid-user
+</Location>
+ </highlight>
</section>
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_config.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_config.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_config.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_config.xml Fri May 4 15:07:48 2012
@@ -445,14 +445,14 @@ expr=<var>expression</var>]</syntax>
<p>For example, the following two sets of directives have
exactly the same effect:</p>
- <example>
- # CustomLog with format nickname<br />
- LogFormat "%h %l %u %t \"%r\" %>s %b" common<br />
- CustomLog logs/access_log common<br />
- <br />
- # CustomLog with explicit format string<br />
- CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"
- </example>
+ <highlight language="config">
+# CustomLog with format nickname
+LogFormat "%h %l %u %t \"%r\" %>s %b" common
+CustomLog logs/access_log common
+
+# CustomLog with explicit format string
+CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"
+ </highlight>
<p>The third argument is optional and controls whether or
not to log a particular request. The condition can be the
@@ -470,19 +470,19 @@ expr=<var>expression</var>]</syntax>
images on your server in a separate logfile but not in your main
log, you can use:</p>
- <example>
- SetEnvIf Request_URI \.gif$ gif-image<br />
- CustomLog gif-requests.log common env=gif-image<br />
- CustomLog nongif-requests.log common env=!gif-image
- </example>
+ <highlight language="config">
+SetEnvIf Request_URI \.gif$ gif-image
+CustomLog gif-requests.log common env=gif-image
+CustomLog nongif-requests.log common env=!gif-image
+ </highlight>
<p>Or, to reproduce the behavior of the old RefererIgnore
directive, you might use the following:</p>
- <example>
- SetEnvIf Referer example\.com localreferer<br />
- CustomLog referer.log referer env=!localreferer
- </example>
+ <highlight language="config">
+SetEnvIf Referer example\.com localreferer
+CustomLog referer.log referer env=!localreferer
+ </highlight>
</usage>
</directivesynopsis>
@@ -526,8 +526,11 @@ expr=<var>expression</var>]</syntax>
percent signs (<code>%</code>).</p>
<example><title>Example</title>
+ <highlight language="config">
LogFormat "%v %h %l %u %t \"%r\" %>s %b" vhost_common
+ </highlight>
</example>
+
</usage>
</directivesynopsis>
@@ -549,8 +552,10 @@ expr=<var>expression</var>]</syntax>
other format has been specified.</p>
<example><title>Example</title>
- LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""<br />
- TransferLog logs/access_log
+ <highlight language="config">
+LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
+TransferLog logs/access_log
+ </highlight>
</example>
</usage>
</directivesynopsis>
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_debug.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_debug.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_debug.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_log_debug.xml Fri May 4 15:07:48 2012
@@ -35,20 +35,20 @@
<li>
Log message after request to /foo/* is processed:
- <example>
- <Location /foo/><br/>
- LogMessage "/foo/ has been requested"<br/>
- </Location><br/>
- </example>
+ <highlight language="config">
+<Location /foo/>
+ LogMessage "/foo/ has been requested"
+</Location>
+ </highlight>
</li>
<li>
Log message if request to /foo/* is processed in a sub-request:
- <example>
- <Location /foo/><br/>
- LogMessage "subrequest to /foo/" hook=type_checker expr=%{IS_SUBREQ}<br/>
- </Location><br/>
- </example>
+ <highlight language="config">
+<Location /foo/>
+ LogMessage "subrequest to /foo/" hook=type_checker expr=%{IS_SUBREQ}
+</Location>
+ </highlight>
The default log_transaction hook is not executed for sub-requests,
therefore we have to use a different hook.
@@ -57,21 +57,20 @@
<li>
Log message if an IPv6 client causes a request timeout:
- <example>
- LogMessage "IPv6 timeout from %{REMOTE_ADDR}"
- "expr=-T %{IPV6} && %{REQUEST_STATUS} = 408"
- </example>
+ <highlight language="config">
+ LogMessage "IPv6 timeout from %{REMOTE_ADDR}" "expr=-T %{IPV6} && %{REQUEST_STATUS} = 408"
+ </highlight>
Note the placing of the double quotes for the <code>expr=</code> argument.
</li>
<li>
Log the value of the "X-Foo" request environment variable in each
stage of the request:
- <example>
- <Location /><br/>
- LogMessage "%{reqenv:X-Foo}" hook=all<br/>
- </Location><br/>
- </example>
+ <highlight language="config">
+<Location />
+ LogMessage "%{reqenv:X-Foo}" hook=all
+</Location>
+ </highlight>
Together with microsecond time stamps in the error log,
<code>hook=all</code> also allows to determine the times spent
in the different parts of the request processing.
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_lua.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_lua.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_lua.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_lua.xml Fri May 4 15:07:48 2012
@@ -53,17 +53,17 @@ Be sure to check the CHANGES file before
<p>The basic module loading directive is</p>
-<example>
+<highlight language="config">
LoadModule lua_module modules/mod_lua.so
-</example>
+</highlight>
<p>
<code>mod_lua</code> provides a handler named <code>lua-script</code>,
which can be used with an <code>AddHandler</code> directive:</p>
-<example>
+<highlight language="config">
AddHandler lua-script .lua
-</example>
+</highlight>
<p>
This will cause <code>mod_lua</code> to handle requests for files
@@ -86,7 +86,9 @@ and <module>mod_status</module>.</p>
just evaluating a script body CGI style. A handler function looks
something like this:</p>
-<example><title>example.lua</title><pre>
+
+<highlight language="lua">
+<strong>example.lua</strong>
-- example handler
require "string"
@@ -112,7 +114,7 @@ function handle(r)
r:puts("unknown HTTP method " .. r.method)
end
end
-</pre></example>
+</highlight>
<p>
This handler function just prints out the uri or form encoded
@@ -140,7 +142,8 @@ they'll return OK, DONE, or DECLINED, wh
<code>apache2.OK</code>, <code>apache2.DONE</code>, or
<code>apache2.DECLINED</code>, or else an HTTP status code.</p>
-<example><title>translate_name.lua</title><pre>
+<highlight language="lua">
+<strong>translate_name.lua</strong>
-- example hook that rewrites the URI to a filesystem path.
require 'apache2'
@@ -153,9 +156,10 @@ function translate_name(r)
-- we don't care about this URL, give another module a chance
return apache2.DECLINED
end
-</pre></example>
+</highlight>
-<example><title>translate_name2.lua</title><pre>
+<highlight language="lua">
+<strong>translate_name2.lua</strong>
--[[ example hook that rewrites one URI to another URI. It returns a
apache2.DECLINED to give other URL mappers a chance to work on the
substitution, including the core translate_name hook which maps based
@@ -174,7 +178,7 @@ function translate_name(r)
end
return apache2.DECLINED
end
-</pre></example>
+</highlight>
</section>
<section id="datastructures"><title>Data Structures</title>
@@ -328,27 +332,25 @@ end
<p>The request_rec has (at least) the following methods:</p>
- <example>
+ <highlight language="lua">
r:addoutputfilter(name|function) -- add an output filter
- </example>
+ </highlight>
+
+ <highlight language="lua">
+ r:parseargs() -- returns a lua table containing the request's query string arguments
+ </highlight>
- <example>
- r:parseargs() -- returns a lua table containing the request's
- query string arguments
- </example>
-
- <example>
- r:parsebody() -- parse the request body as a POST and return
- a lua table
- </example>
+ <highlight language="lua">
+ r:parsebody() -- parse the request body as a POST and return a lua table
+ </highlight>
- <example>
+ <highlight language="lua">
r:puts("hello", " world", "!") -- print to response body
- </example>
+ </highlight>
- <example>
+ <highlight language="lua">
r:write("a single string") -- print to response body
- </example>
+ </highlight>
</dd>
</dl>
@@ -356,7 +358,7 @@ end
<section id="logging"><title>Logging Functions</title>
-<example>
+<highlight language="lua">
-- examples of logging messages<br />
r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />
r:debug("This is a debug log message")<br />
@@ -367,7 +369,7 @@ end
r:alert("This is an alert log message")<br />
r:crit("This is an crit log message")<br />
r:emerg("This is an emerg log message")<br />
-</example>
+</highlight>
</section>
@@ -458,16 +460,18 @@ end
be careful writing your regular expressions to avoid security
issues.</p>
<example><title>Examples:</title>
- LuaMapHandler /(\w+)/(/w+) /scripts/$1.lua handle_$2
+ <highlight language="config">
+ LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
+ </highlight>
</example>
<p>This would match uri's such as /photos/show?id=9
to the file /scripts/photos.lua and invoke the
handler function handle_show on the lua vm after
loading that file.</p>
-<example>
+<highlight language="config">
LuaMapHandler /bingo /scripts/wombat.lua
-</example>
+</highlight>
<p>This would invoke the "handle" function, which
is the default if no specific function name is
provided.</p>
@@ -487,8 +491,10 @@ end
lua vms.</p>
<example><title>Examples:</title>
- LuaPackagePath /scripts/lib/?.lua<br />
- LuaPackagePath /scripts/lib/?/init.lua
+ <highlight language="config">
+LuaPackagePath /scripts/lib/?.lua
+LuaPackagePath /scripts/lib/?/init.lua
+ </highlight>
</example>
</usage>
</directivesynopsis>
@@ -533,9 +539,11 @@ end
for development.</p>
<example><title>Examples:</title>
- LuaCodeCache stat<br />
- LuaCodeCache forever<br />
- LuaCodeCache never<br />
+ <highlight language="config">
+LuaCodeCache stat
+LuaCodeCache forever
+LuaCodeCache never
+ </highlight>
</example>
</usage>
@@ -567,10 +575,12 @@ end
<p>Example:</p>
-<example><pre>
+<highlight language="config">
# httpd.conf
LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
+</highlight>
+<highlight language="lua">
-- /scripts/conf/hooks.lua --
require "apache2"
function silly_mapper(r)
@@ -581,7 +591,7 @@ function silly_mapper(r)
return apache2.DECLINED
end
end
-</pre></example>
+</highlight>
<note><title>Context</title><p>This directive is not valid in <directive
type="section" module="core">Directory</directive>, <directive
@@ -661,7 +671,7 @@ processing</description>
a request. This can be used to implement arbitrary authentication
and authorization checking. A very simple example:
</p>
-<example><pre>
+<highlight language="lua">
require 'apache2'
-- fake authcheck hook
@@ -692,7 +702,7 @@ function authcheck_hook(r)
end
return apache2.OK
end
-</pre></example>
+</highlight>
<note><title>Ordering</title><p>The optional arguments "early" or "late"
control when this script runs relative to other modules.</p></note>
</usage>
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime.xml Fri May 4 15:07:48 2012
@@ -143,11 +143,11 @@ module="mod_mime_magic">MimeMagicFile</d
of using <code>AddHandler cgi-script .cgi</code>, use</p>
<example><title>Configure handler based on final extension only</title>
- <FilesMatch \.cgi$>
- <indent>
- SetHandler cgi-script
- </indent>
- </FilesMatch>
+ <highlight language="config">
+<FilesMatch \.cgi$>
+ SetHandler cgi-script
+</FilesMatch>
+ </highlight>
</example>
</section>
@@ -192,7 +192,7 @@ module="mod_mime_magic">MimeMagicFile</d
resource, in order to tell the client browser about the
encoding method.</p>
- <example>Content-encoding: pkzip</example>
+ <highlight language="config">Content-encoding: pkzip</highlight>
</section>
<section id="charset-lang"><title>Character sets and languages</title>
@@ -232,8 +232,8 @@ module="mod_mime_magic">MimeMagicFile</d
render the information.</p>
<example>
- Content-Language: en, fr<br />
- Content-Type: text/plain; charset=ISO-8859-1
+Content-Language: en, fr
+Content-Type: text/plain; charset=ISO-8859-1
</example>
<p>The language specification is the two-letter abbreviation
@@ -263,10 +263,12 @@ charset</description>
<var>extension</var>.</p>
<example><title>Example</title>
- AddLanguage ja .ja<br />
- AddCharset EUC-JP .euc<br />
- AddCharset ISO-2022-JP .jis<br />
- AddCharset SHIFT_JIS .sjis
+ <highlight language="config">
+AddLanguage ja .ja
+AddCharset EUC-JP .euc
+AddCharset ISO-2022-JP .jis
+AddCharset SHIFT_JIS .sjis
+ </highlight>
</example>
<p>Then the document <code>xxxx.ja.jis</code> will be treated
@@ -310,8 +312,10 @@ type</description>
<var>extension</var>.</p>
<example><title>Example</title>
- AddEncoding x-gzip .gz<br />
- AddEncoding x-compress .Z
+ <highlight language="config">
+AddEncoding x-gzip .gz
+AddEncoding x-compress .Z
+ </highlight>
</example>
<p>This will cause filenames containing the <code>.gz</code> extension
@@ -359,9 +363,9 @@ handler</description>
activate CGI scripts with the file extension <code>.cgi</code>, you
might use:</p>
- <example>
+ <highlight language="config">
AddHandler cgi-script .cgi
- </example>
+ </highlight>
<p>Once that has been put into your httpd.conf file, any file containing
the <code>.cgi</code> extension will be treated as a CGI program.</p>
@@ -431,9 +435,11 @@ language</description>
<var>extension</var>.</p>
<example><title>Example</title>
- AddEncoding x-compress .Z<br />
- AddLanguage en .en<br />
- AddLanguage fr .fr
+ <highlight language="config">
+AddEncoding x-compress .Z
+AddLanguage en .en
+AddLanguage fr .fr
+ </highlight>
</example>
<p>Then the document <code>xxxx.en.Z</code> will be treated as
@@ -449,11 +455,11 @@ language</description>
extension, the last one encountered is the one that is used.
That is, for the case of:</p>
- <example>
- AddLanguage en .en<br />
- AddLanguage en-gb .en<br />
- AddLanguage en-us .en
- </example>
+ <highlight language="config">
+AddLanguage en .en
+AddLanguage en-gb .en
+AddLanguage en-us .en
+ </highlight>
<p>documents with the extension <code>.en</code> would be treated as
being <code>en-us</code>.</p>
@@ -494,9 +500,9 @@ later.</compatibility>
<code>.shtml</code> files for server-side includes and will then
compress the output using <module>mod_deflate</module>.</p>
- <example>
+ <highlight language="config">
AddOutputFilter INCLUDES;DEFLATE shtml
- </example>
+ </highlight>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
@@ -514,34 +520,26 @@ later.</compatibility>
the <directive module="mod_mime">AddOutputFilter</directive>
directive.</p>
- <example>
- # Effective filter "DEFLATE"<br />
- AddOutputFilter DEFLATE shtml<br />
- <Location /foo><br />
- <indent>
- # Effective filter "INCLUDES", replacing "DEFLATE"<br />
- AddOutputFilter INCLUDES shtml<br />
- </indent>
- </Location><br />
- <Location /bar><br />
- <indent>
- # Effective filter "INCLUDES;DEFLATE", replacing "DEFLATE"<br />
- AddOutputFilter INCLUDES;DEFLATE shtml<br />
- </indent>
- </Location><br />
- <Location /bar/baz><br />
- <indent>
- # Effective filter "BUFFER", replacing "INCLUDES;DEFLATE"<br />
- AddOutputFilter BUFFER shtml<br />
- </indent>
- </Location><br />
- <Location /bar/baz/buz><br />
- <indent>
- # No effective filter, replacing "BUFFER"<br />
- RemoveOutputFilter shtml<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+# Effective filter "DEFLATE"
+AddOutputFilter DEFLATE shtml
+<Location /foo>
+ # Effective filter "INCLUDES", replacing "DEFLATE"
+ AddOutputFilter INCLUDES shtml
+</Location>
+<Location /bar>
+ # Effective filter "INCLUDES;DEFLATE", replacing "DEFLATE"
+ AddOutputFilter INCLUDES;DEFLATE shtml
+</Location>
+<Location /bar/baz>
+ # Effective filter "BUFFER", replacing "INCLUDES;DEFLATE"
+ AddOutputFilter BUFFER shtml
+</Location>
+<Location /bar/baz/buz>
+ # No effective filter, replacing "BUFFER"
+ RemoveOutputFilter shtml
+</Location>
+ </highlight>
</usage>
<seealso><directive module="mod_mime">RemoveOutputFilter</directive></seealso>
<seealso><directive module="core">SetOutputFilter</directive></seealso>
@@ -573,13 +571,17 @@ type</description>
</note>
<example><title>Example</title>
+ <highlight language="config">
AddType image/gif .gif
+ </highlight>
</example>
<p>Or, to specify multiple file extensions in one directive:</p>
<example><title>Example</title>
+ <highlight language="config">
AddType image/jpeg jpeg jpg jpe
+ </highlight>
</example>
<p>The <var>extension</var> argument is case-insensitive and can
@@ -594,7 +596,9 @@ type</description>
<code>qs</code>:</p>
<example><title>Example</title>
- Addtype application/rss+xml;qs=0.8 .xml
+ <highlight language="config">
+ AddType application/rss+xml;qs=0.8 .xml
+ </highlight>
</example>
<p>This is useful in situations, <em>e.g.</em> when a client
@@ -658,9 +662,9 @@ a matching file with MultiViews</descrip
and filters to participate in Multviews, but will exclude unknown
files:</p>
- <example>
+ <highlight language="config">
MultiviewsMatch Handlers Filters
- </example>
+ </highlight>
<p><directive>MultiviewsMatch</directive> is not allowed in a
<directive type="section" module="core">Location</directive> or <directive
@@ -700,7 +704,9 @@ assigned a language-tag by some other me
Content-Language header field will be generated.</p>
<example><title>Example</title>
+ <highlight language="config">
DefaultLanguage en
+ </highlight>
</example>
</usage>
<seealso><module>mod_negotiation</module></seealso>
@@ -725,7 +731,9 @@ components as part of the filename</desc
<p>This directive is recommended when you have a virtual filesystem.</p>
<example><title>Example</title>
+ <highlight language="config">
ModMimeUsePathInfo On
+ </highlight>
</example>
<p>If you have a request for <code>/index.php/foo.shtml</code>
@@ -764,7 +772,9 @@ later.</compatibility>
be specified with or without a leading dot.</p>
<example><title>Example</title>
+ <highlight language="config">
RemoveCharset .html .shtml
+ </highlight>
</example>
</usage>
</directivesynopsis>
@@ -787,13 +797,13 @@ extensions</description>
server config files. An example of its use might be:</p>
<example><title>/foo/.htaccess:</title>
- AddEncoding x-gzip .gz<br />
- AddType text/plain .asc<br />
- <Files *.gz.asc><br />
- <indent>
- RemoveEncoding .gz<br />
- </indent>
- </Files>
+ <highlight language="config">
+AddEncoding x-gzip .gz
+AddType text/plain .asc
+<Files *.gz.asc>
+ RemoveEncoding .gz
+</Files>
+ </highlight>
</example>
<p>This will cause <code>foo.gz</code> to be marked as being
@@ -830,11 +840,15 @@ extensions</description>
config files. An example of its use might be:</p>
<example><title>/foo/.htaccess:</title>
+ <highlight language="config">
AddHandler server-parsed .html
+ </highlight>
</example>
<example><title>/foo/bar/.htaccess:</title>
+ <highlight language="config">
RemoveHandler .html
+ </highlight>
</example>
<p>This has the effect of returning <code>.html</code> files in
@@ -922,7 +936,9 @@ later.</compatibility>
be specified with or without a leading dot.</p>
<example><title>Example</title>
+ <highlight language="config">
RemoveOutputFilter shtml
+ </highlight>
</example>
</usage>
<seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
@@ -947,7 +963,9 @@ extensions</description>
might be:</p>
<example><title>/foo/.htaccess:</title>
+ <highlight language="config">
RemoveType .cgi
+ </highlight>
</example>
<p>This will remove any special handling of <code>.cgi</code>
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime_magic.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime_magic.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime_magic.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_mime_magic.xml Fri May 4 15:07:48 2012
@@ -264,7 +264,9 @@ using the specified magic file</descript
server's file.</p>
<example><title>Example</title>
+ <highlight language="config">
MimeMagicFile conf/magic
+ </highlight>
</example>
</usage>
</directivesynopsis>
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_negotiation.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_negotiation.xml?rev=1334018&r1=1334017&r2=1334018&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_negotiation.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_negotiation.xml Fri May 4 15:07:48 2012
@@ -177,9 +177,9 @@ Negotiation</a></seealso>
<code>type-map</code> handler with an <directive
module="mod_mime">AddHandler</directive> directive:</p>
- <example>
+ <highlight language="config">
AddHandler type-map .var
- </example>
+ </highlight>
<p>A request for <code>document.html</code> in this directory will
result in <code>document.html.var</code> being consulted, and the
@@ -257,10 +257,10 @@ found</description>
(equally acceptable) then the first matching variant, <code>en</code>,
will be served.</p>
- <example>
- LanguagePriority en fr de<br />
- ForceLanguagePriority Prefer
- </example>
+ <highlight language="config">
+LanguagePriority en fr de
+ForceLanguagePriority Prefer
+ </highlight>
<p><code>ForceLanguagePriority Fallback</code> uses
<directive module="mod_negotiation">LanguagePriority</directive> to
@@ -271,10 +271,10 @@ found</description>
variant from the <directive module="mod_negotiation"
>LanguagePriority</directive> list below will be served.</p>
- <example>
- LanguagePriority en fr de<br />
- ForceLanguagePriority Fallback
- </example>
+ <highlight language="config">
+LanguagePriority en fr de
+ForceLanguagePriority Fallback
+ </highlight>
<p>Both options, <code>Prefer</code> and <code>Fallback</code>, may be
specified, so either the first matching variant from <directive
@@ -302,9 +302,9 @@ the client does not express a preference
express a preference, when handling a Multiviews request. The list
of <var>MIME-lang</var> are in order of decreasing preference.</p>
- <example><title>Example:</title>
+ <highlight language="config">
LanguagePriority en fr de
- </example>
+ </highlight>
<p>For a request for <code>foo.html</code>, where
<code>foo.html.fr</code> and <code>foo.html.de</code> both