granicus.if.org Git - apache/blob - docs/manual/mod/mod_dumpio.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Copyright 2004-2005 The Apache Software Foundation or its licensors, as
   8  applicable.
   9
  10  Licensed under the Apache License, Version 2.0 (the "License");
  11  you may not use this file except in compliance with the License.
  12  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_dumpio.xml.meta">
  24
  25 <name>mod_dumpio</name>
  26 <description>Dumps all I/O to error log as desired.</description>
  27 <status>Extension</status>
  28 <sourcefile>mod_dumpio.c</sourcefile>
  29 <identifier>dumpio_module</identifier>
  30
  31 <summary>
  32     <p><code>mod_dumpio</code> allows for the logging of
  33     all input received by Apache and/or all output sent by
  34     Apache to be logged (dumped) to the error.log file.
  35     </p>
  36
  37     <p>The data logging is done right after SSL decoding (for
  38     input) and right before SSL encoding (for output). As can
  39     be expected, this can produce extreme volumes of data,
  40     and should only be used when debugging problems.</p>
  41 </summary>
  42
  43 <section id="enable">
  44     <title>Enabling dumpio Support</title>
  45
  46     <p>To enable the module, it should be compiled and
  47     loaded in to your running Apache configuration. Logging
  48     can then be enabled or disabled via the below directives.</p>
  49 </section>
  50
  51 <directivesynopsis>
  52
  53 <name>DumpIOInput</name>
  54 <description>Dump all input data to the error log</description>
  55 <syntax>DumpIOInput On|Off</syntax>
  56 <default>DumpIOInput Off</default>
  57 <contextlist><context>server config</context></contextlist>
  58 <compatibility>DumpIOInput is only available in Apache 2.1.3 and
  59 later.</compatibility>
  60
  61 <usage>
  62     <p>Enable dumping of all input.</p>
  63
  64     <example><title>Example</title>
  65       DumpIOInput On
  66     </example>
  67 </usage>
  68
  69 </directivesynopsis>
  70
  71 <directivesynopsis>
  72
  73 <name>DumpIOOutput</name>
  74 <description>Dump all output data to the error log</description>
  75 <syntax>DumpIOOutput On|Off</syntax>
  76 <default>DumpIOOutput Off</default>
  77 <contextlist><context>server config</context></contextlist>
  78 <compatibility>DumpIOOutput is only available in Apache 2.1.3 and
  79 later.</compatibility>
  80
  81 <usage>
  82     <p>Enable dumping of all output.</p>
  83
  84     <example><title>Example</title>
  85       DumpIOOutput On
  86     </example>
  87 </usage>
  88
  89 </directivesynopsis>
  90 </modulesynopsis>