humbedooh at apache
Apr 26, 2012, 10:23 AM
Post #1 of 1
(28 views)
Permalink
|
|
svn commit: r1330980 - in /httpd/httpd/trunk/docs/manual/mod: mod_data.xml mod_dav.xml mod_dav_fs.xml mod_dav_lock.xml mod_deflate.xml mod_dialup.xml mod_dir.xml mod_dumpio.xml
|
|
Author: humbedooh
Date: Thu Apr 26 17:23:00 2012
New Revision: 1330980
URL: http://svn.apache.org/viewvc?rev=1330980&view=rev
Log:
Syntax updates for mod_d*.xml
Modified:
httpd/httpd/trunk/docs/manual/mod/mod_data.xml
httpd/httpd/trunk/docs/manual/mod/mod_dav.xml
httpd/httpd/trunk/docs/manual/mod/mod_dav_fs.xml
httpd/httpd/trunk/docs/manual/mod/mod_dav_lock.xml
httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml
httpd/httpd/trunk/docs/manual/mod/mod_dialup.xml
httpd/httpd/trunk/docs/manual/mod/mod_dir.xml
httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml
Modified: httpd/httpd/trunk/docs/manual/mod/mod_data.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_data.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_data.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_data.xml Thu Apr 26 17:23:00 2012
@@ -56,11 +56,11 @@
module.</p>
<example><title>Configuring the filter</title>
- <Location /data/images><br />
- <indent>
- SetOutputFilter DATA
- </indent>
- </Location><br />
+ <highlight language="config">
+<Location /data/images>
+ SetOutputFilter DATA
+</Location>
+ </highlight>
</example>
</summary>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_dav.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dav.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dav.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dav.xml Thu Apr 26 17:23:00 2012
@@ -45,7 +45,7 @@
<p>To enable <module>mod_dav</module>, add the following to a
container in your <code>httpd.conf</code> file:</p>
- <example>Dav On</example>
+ <highlight language="config">Dav On</highlight>
<p>This enables the DAV file system provider, which is implemented
by the <module>mod_dav_fs</module> module. Therefore, that module
@@ -57,9 +57,9 @@
file using the <directive module="mod_dav_fs">DavLockDB</directive>
directive:</p>
- <example>
+ <highlight language="config">
DavLockDB /usr/local/apache2/var/DavLock
- </example>
+ </highlight>
<p>The directory containing the lock database file must be
writable by the <directive module="mod_unixd">User</directive>
@@ -77,24 +77,22 @@
requests.</p>
<example><title>Full Example</title>
- DavLockDB /usr/local/apache2/var/DavLock<br />
- <br />
- <Directory /usr/local/apache2/htdocs/foo><br />
- <indent>
- Require all granted<br />
- Dav On<br />
- <br />
- AuthType Basic<br />
- AuthName DAV<br />
- AuthUserFile user.passwd<br />
- <br />
- <LimitExcept GET POST OPTIONS><br />
- <indent>
- Require user admin<br />
- </indent>
- </LimitExcept><br />
- </indent>
- </Directory><br />
+ <highlight language="config">
+DavLockDB /usr/local/apache2/var/DavLock
+
+<Directory /usr/local/apache2/htdocs/foo>
+ Require all granted
+ Dav On
+
+ AuthType Basic
+ AuthName DAV
+ AuthUserFile user.passwd
+
+ <LimitExcept GET POST OPTIONS>
+ Require user admin
+ </LimitExcept>
+</Directory>
+ </highlight>
</example>
</section>
@@ -150,16 +148,14 @@
will run the script, and one of which will allow it to be
downloaded and manipulated with DAV.</p>
-<example>
-Alias /phparea /home/gstein/php_files<br />
-Alias /php-source /home/gstein/php_files<br />
+<highlight language="config">
+Alias /phparea /home/gstein/php_files
+Alias /php-source /home/gstein/php_files
<Location /php-source>
-<indent>
- DAV On<br />
- ForceType text/plain<br />
-</indent>
+ DAV On
+ ForceType text/plain
</Location>
-</example>
+</highlight>
<p>With this setup, <code>http://example.com/phparea</code> can be
used to access the output of the PHP scripts, and
@@ -178,13 +174,11 @@ Alias /php-source /home/gstein/php_files
<p>Use the <directive>Dav</directive> directive to enable the
WebDAV HTTP methods for the given container:</p>
- <example>
- <Location /foo><br />
- <indent>
- Dav On<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+<Location /foo>
+ Dav On
+</Location>
+ </highlight>
<p>The value <code>On</code> is actually an alias for the default
provider <code>filesystem</code> which is served by the <module
@@ -223,11 +217,11 @@ a DAV resource</description>
the lock due to network latency.</p>
<example><title>Example</title>
- <Location /MSWord><br />
- <indent>
- DavMinTimeout 600<br />
- </indent>
- </Location>
+ <highlight language="config">
+<Location /MSWord>
+ DavMinTimeout 600
+</Location>
+ </highlight>
</example>
</usage>
</directivesynopsis>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_dav_fs.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dav_fs.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dav_fs.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dav_fs.xml Thu Apr 26 17:23:00 2012
@@ -38,7 +38,9 @@
directive:</p>
<example><title>Example</title>
+ <highlight language="config">
Dav filesystem
+ </highlight>
</example>
<p>Since <code>filesystem</code> is the default provider for
@@ -67,7 +69,9 @@
the server to display all locks in a lock database.</p> -->
<example><title>Example</title>
+ <highlight language="config">
DavLockDB var/DavLock
+ </highlight>
</example>
<p>The directory containing the lock database file must be
Modified: httpd/httpd/trunk/docs/manual/mod/mod_dav_lock.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dav_lock.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dav_lock.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dav_lock.xml Thu Apr 26 17:23:00 2012
@@ -72,7 +72,9 @@
locks.</p>
<example><title>Example</title>
+ <highlight language="config">
DavGenericLockDB var/DavLock
+ </highlight>
</example>
<p>The directory containing the lock database file must be
Modified: httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml Thu Apr 26 17:23:00 2012
@@ -41,7 +41,9 @@ client</description>
<p>This is a simple sample configuration for the impatient.</p>
<example><title>Compress only a few types</title>
+ <highlight language="config">
AddOutputFilterByType DEFLATE text/html text/plain text/xml
+ </highlight>
</example>
<p>The following configuration, while resulting in more compressed content,
@@ -49,29 +51,26 @@ client</description>
all the configuration details.</p>
<example><title>Compress everything except images</title>
- <Location /><br />
- <indent>
- # Insert filter<br />
- SetOutputFilter DEFLATE<br />
- <br />
- # Netscape 4.x has some problems...<br />
- BrowserMatch ^Mozilla/4 gzip-only-text/html<br />
- <br />
- # Netscape 4.06-4.08 have some more problems<br />
- BrowserMatch ^Mozilla/4\.0[678] no-gzip<br />
- <br />
- # MSIE masquerades as Netscape, but it is fine<br />
- BrowserMatch \bMSIE !no-gzip !gzip-only-text/html<br />
- # Don't compress images<br />
- SetEnvIfNoCase Request_URI \<br />
- <indent>
- \.(?:gif|jpe?g|png)$ no-gzip dont-vary<br />
- </indent>
- <br />
- # Make sure proxies don't deliver the wrong content<br />
- Header append Vary User-Agent env=!dont-vary<br />
- </indent>
- </Location>
+ <highlight language="config">
+<Location />
+ # Insert filter
+ SetOutputFilter DEFLATE
+
+ # Netscape 4.x has some problems...
+ BrowserMatch ^Mozilla/4 gzip-only-text/html
+
+ # Netscape 4.06-4.08 have some more problems
+ BrowserMatch ^Mozilla/4\.0[678] no-gzip
+
+ # MSIE masquerades as Netscape, but it is fine
+ BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
+ # Don't compress images
+ SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary
+
+ # Make sure proxies don't deliver the wrong content
+ Header append Vary User-Agent env=!dont-vary
+</Location>
+ </highlight>
</example>
</section>
@@ -84,9 +83,9 @@ client</description>
will enable compression for documents in the container where it
is placed:</p>
- <example>
+ <highlight language="config">
SetOutputFilter DEFLATE
- </example>
+ </highlight>
<p>Some popular browsers cannot handle compression of all content
so you may want to set the <code>gzip-only-text/html</code> note to
@@ -100,13 +99,11 @@ client</description>
enabling compression only for the html files of the Apache
documentation:</p>
- <example>
- <Directory "/your-server-root/manual"><br />
- <indent>
- AddOutputFilterByType DEFLATE text/html<br />
- </indent>
- </Directory>
- </example>
+ <highlight language="config">
+<Directory "/your-server-root/manual">
+ AddOutputFilterByType DEFLATE text/html
+</Directory>
+ </highlight>
<p>For browsers that have problems even with compression of all file
types, use the <directive module="mod_setenvif"
@@ -118,11 +115,11 @@ client</description>
excerpt from the <a href="#recommended">configuration example</a>
defined in the section above:</p>
- <example>
- BrowserMatch ^Mozilla/4 gzip-only-text/html<br />
- BrowserMatch ^Mozilla/4\.0[678] no-gzip<br />
- BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
- </example>
+ <highlight language="config">
+BrowserMatch ^Mozilla/4 gzip-only-text/html
+BrowserMatch ^Mozilla/4\.0[678] no-gzip
+BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
+ </highlight>
<p>At first we probe for a <code>User-Agent</code> string that
indicates a Netscape Navigator version of 4.x. These versions
@@ -159,14 +156,12 @@ client</description>
>SetOutputFilter</directive> or <directive module="mod_mime"
>AddOutputFilter</directive>, for example:</p>
- <example>
- <Location /dav-area><br />
- <indent>
- ProxyPass http://example.com/<br />
- SetOutputFilter INFLATE<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+<Location /dav-area>
+ ProxyPass http://example.com/
+ SetOutputFilter INFLATE
+</Location>
+ </highlight>
<p>This Example will uncompress gzip'ed output from example.com, so other
filters can do further processing with it.
@@ -181,13 +176,11 @@ client</description>
>SetInputFilter</directive> or <directive module="mod_mime"
>AddInputFilter</directive>, for example:</p>
- <example>
- <Location /dav-area><br />
- <indent>
- SetInputFilter DEFLATE<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+<Location /dav-area>
+ SetInputFilter DEFLATE
+</Location>
+ </highlight>
<p>Now if a request contains a <code>Content-Encoding:
gzip</code> header, the body will be automatically decompressed.
@@ -222,9 +215,9 @@ client</description>
in a typical configuration where the addition of the <code>DEFLATE</code>
filter depends on the <code>User-Agent</code>, you should add:</p>
- <example>
+ <highlight language="config">
Header append Vary User-Agent
- </example>
+ </highlight>
<p>If your decision about compression depends on other information
than request headers (<em>e.g.</em> HTTP version), you have to set the
@@ -232,7 +225,9 @@ client</description>
compliant proxies from caching entirely.</p>
<example><title>Example</title>
+ <highlight language="config">
Header set Vary *
+ </highlight>
</example>
</section>
@@ -253,10 +248,12 @@ client</description>
>access log</a>.</p>
<example><title>Example</title>
- DeflateFilterNote ratio<br />
- <br />
- LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate<br />
+ <highlight language="config">
+ DeflateFilterNote ratio
+
+ LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate
CustomLog logs/deflate_log deflate
+ </highlight>
</example>
<p>If you want to extract more accurate values from your logs, you
@@ -279,12 +276,14 @@ client</description>
<p>Thus you may log it this way:</p>
<example><title>Accurate Logging</title>
- DeflateFilterNote Input instream<br />
- DeflateFilterNote Output outstream<br />
- DeflateFilterNote Ratio ratio<br />
- <br />
- LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate<br />
- CustomLog logs/deflate_log deflate
+ <highlight language="config">
+DeflateFilterNote Input instream
+DeflateFilterNote Output outstream
+DeflateFilterNote Ratio ratio
+
+LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate
+CustomLog logs/deflate_log deflate
+</highlight>
</example>
</usage>
<seealso><module>mod_log_config</module></seealso>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_dialup.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dialup.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dialup.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dialup.xml Thu Apr 26 17:23:00 2012
@@ -36,11 +36,11 @@ the document to validate. -->
by the various old modem standards. So, you can browse your site with a 56k
V.92 modem, by adding something like this:</p>
-<example>
-<Location /mysite><br />
-ModemStandard V.92<br />
+<highlight language="config">
+<Location /mysite>
+ ModemStandard V.92
</Location>
-</example>
+</highlight>
<p>Previously to do bandwidth rate limiting modules would have to block an entire
thread, for each client, and insert sleeps to slow the bandwidth down.
@@ -58,11 +58,11 @@ once the timer hits. From there the han
<usage>
<p>Specify what modem standard you wish to simulate.</p>
-<example>
-<Location /mysite><br />
-ModemStandard V.26bis<br />
+<highlight language="config">
+<Location /mysite>
+ ModemStandard V.26bis
</Location>
-</example>
+</highlight>
</usage>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_dir.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dir.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dir.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dir.xml Thu Apr 26 17:23:00 2012
@@ -77,7 +77,9 @@ a directory</description>
directory.</p>
<example><title>Example</title>
+ <highlight language="config">
DirectoryIndex index.html
+ </highlight>
</example>
<p>then a request for <code>http://example.com/docs/</code> would
@@ -87,9 +89,9 @@ a directory</description>
<p>Note that the documents do not need to be relative to the
directory;</p>
- <example>
+ <highlight language="config">
DirectoryIndex index.html index.txt /cgi-bin/index.pl
- </example>
+ </highlight>
<p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be
executed if neither <code>index.html</code> or <code>index.txt</code>
@@ -123,7 +125,9 @@ a directory</description>
to instead be issued.</p>
<example><title>Example</title>
+ <highlight language="config">
DirectoryIndexRedirect on
+ </highlight>
</example>
<p>A request for <code>http://example.com/docs/</code> would
@@ -168,15 +172,13 @@ a directory</description>
be aware that there are possible security implications to doing
this.</p>
- <example>
- # see security warning below!<br />
- <Location /some/path><br />
- <indent>
- DirectorySlash Off<br />
- SetHandler some-handler<br />
- </indent>
- </Location>
- </example>
+ <highlight language="config">
+# see security warning below!
+<Location /some/path>
+ DirectorySlash Off
+ SetHandler some-handler
+</Location>
+ </highlight>
<note type="warning"><title>Security Warning</title>
<p>Turning off the trailing slash redirect may result in an information
@@ -204,9 +206,9 @@ a directory</description>
<p>Use this to set a handler for any URL that doesn't map to anything
in your filesystem, and would otherwise return HTTP 404 (Not Found).
For example</p>
- <example>
- <code>FallbackResource /not-404.php</code>
- </example>
+ <highlight language="config">
+ FallbackResource /not-404.php
+ </highlight>
<p>will cause requests for non-existent files to be handled by
<code>not-404.php</code>, while requests for files that exist
are unaffected.</p>
@@ -218,22 +220,18 @@ a directory</description>
<module>mod_rewrite</module>, and the use of the <code>-f</code> and
<code>-d</code> tests for file and directory existence. This now
requires only one line of configuration.</p>
- <example>
- <code>FallbackResource /index.php</code>
- </example>
+ <highlight language="config">
+ FallbackResource /index.php
+ </highlight>
<p>Existing files, such as images, css files, and so on, will be
served normally.</p>
<p>In a sub-URI, such as <em>http://example.com/blog/</em> this
<em>sub-URI</em> has to be supplied as <var>local-url</var>:</p>
- <example>
- <code>
- <Directory /web/example.com/htdocs/blog><br />
- <indent>
- FallbackResource /blog/index.php<br />
- </indent>
- </Directory>
- </code>
- </example>
+ <highlight language="config">
+<Directory /web/example.com/htdocs/blog>
+ FallbackResource /blog/index.php
+</Directory>
+ </highlight>
</usage>
</directivesynopsis>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml?rev=1330980&r1=1330979&r2=1330980&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml Thu Apr 26 17:23:00 2012
@@ -50,9 +50,9 @@
needs to be configured to <directive
module="core">LogLevel</directive> <code>trace7</code>:
</p>
- <example>
+ <highlight language="config">
LogLevel dumpio:trace7
- </example>
+ </highlight>
</section>
<directivesynopsis>
@@ -69,7 +69,9 @@ later.</compatibility>
<p>Enable dumping of all input.</p>
<example><title>Example</title>
+ <highlight language="config">
DumpIOInput On
+ </highlight>
</example>
</usage>
@@ -89,7 +91,9 @@ later.</compatibility>
<p>Enable dumping of all output.</p>
<example><title>Example</title>
+ <highlight language="config">
DumpIOOutput On
+ </highlight>
</example>
</usage>
|
