From: Jim Jagielski <jim@apache.org>
Date: Tue, 14 Dec 2004 17:26:51 +0000 (+0000)
Subject: Add in 1st version docs for mod_dumpio...
X-Git-Tag: 2.1.3~258
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b5dca2ef56c631a9102d4b672b844e2d870585e7;p=thirdparty%2Fapache%2Fhttpd.git

Add in 1st version docs for mod_dumpio...


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

diff --git a/docs/manual/mod/mod_dumpio.xml b/docs/manual/mod/mod_dumpio.xml
new file mode 100644
index 00000000000..dc1fb078343
--- /dev/null
+++ b/docs/manual/mod/mod_dumpio.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 106803 $ -->
+
+<!--
+ Copyright 2002-2004 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_dumpio.xml.meta">
+
+<name>mod_dumpio</name>
+<description>Dumps to error.log all I/O as desired.</description>
+<status>Extension</status>
+<sourcefile>mod_dumpio.c</sourcefile>
+<identifier>dumpio_module</identifier>
+
+<summary>
+    <p><code>mod_dumpio</code> allows for the logging of
+    all input received by Apache and/or all output sent by
+    Apache to be logged (dumped) to the error.log file.
+    </p>
+
+    <p>The data logging is done right after SSL decoding (for
+    input) and right before SSL encoding (for output). As can
+    be expected, this can produce extreme volumes of data,
+    and should only be used when debugging problems.</p>
+</summary>
+
+<section id="enable">
+    <title>Enabling DumpIO Support</title>
+
+    <p>To enable the module, it should be compiled and
+    loaded in to your running Apache configuration. Logging
+    can then be enabled or disabled via the below directives.</p>
+</section>
+
+<directivesynopsis>
+
+<name>DumpIOInput</name>
+<description>Dump all input data to the error log</description>
+<syntax>DumpIOInput On|Off</syntax>
+<default>DumpIOInput Off</default>
+<contextlist><context>server config</context></contextlist>
+<compatibility>DumpIOInput is only available in Apache 2.1.3 and 
+later.</compatibility>
+
+<name>DumpIOOutput</name>
+<description>Dump all output data to the error log</description>
+<syntax>DumpIOOutput On|Off</syntax>
+<default>DumpIOOutput Off</default>
+<contextlist><context>server config</context></contextlist>
+<compatibility>DumpIOOutput is only available in Apache 2.1.3 and 
+later.</compatibility>
+
+</directivesynopsis>
+</modulesynopsis>
diff --git a/docs/manual/mod/mod_dumpio.xml.meta b/docs/manual/mod/mod_dumpio.xml.meta
new file mode 100644
index 00000000000..9f474bc1241
--- /dev/null
+++ b/docs/manual/mod/mod_dumpio.xml.meta
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<metafile>
+  <basename>mod_dumpio</basename>
+  <path>/mod/</path>
+  <relpath>..</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>