From e987f97673d4074e01c3236c828a7aa8c451911d Mon Sep 17 00:00:00 2001
From: =?utf8?q?Andr=C3=A9=20Malo?= <nd@apache.org>
Date: Mon, 15 Mar 2004 20:45:58 +0000
Subject: [PATCH] add initial documentation for EnableExceptionHook. Please
 review.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@102965 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/manual/mod/leader.xml     |  2 ++
 docs/manual/mod/mpm_common.xml | 25 +++++++++++++++++++++++++
 docs/manual/mod/perchild.xml   |  2 ++
 docs/manual/mod/prefork.xml    |  2 ++
 docs/manual/mod/threadpool.xml |  2 ++
 docs/manual/mod/worker.xml     |  2 ++
 6 files changed, 35 insertions(+)

diff --git a/docs/manual/mod/leader.xml b/docs/manual/mod/leader.xml
index baa0195839..ac7ed17557 100644
--- a/docs/manual/mod/leader.xml
+++ b/docs/manual/mod/leader.xml
@@ -55,6 +55,8 @@ MPM</description>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Listen</name>
diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml
index 634c415acc..b8091ee3a6 100644
--- a/docs/manual/mod/mpm_common.xml
+++ b/docs/manual/mod/mpm_common.xml
@@ -128,6 +128,31 @@ switch before dumping core</description>
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>EnableExceptionHook</name>
+<description>Enable the fatal exception handler after a crash</description>
+<syntax>EnableExceptionHook On|Off</syntax>
+<default>EnableExceptionHook Off</default>
+<contextlist><context>server config</context></contextlist>
+<modulelist><module>leader</module><module>perchild</module>
+<module>prefork</module><module>threadpool</module>
+<module>worker</module></modulelist>
+<compatibility>Available in version 2.0.49 an later</compatibility>
+
+<usage>
+    <p>For safety reasons this directive is only available if the server was
+    configured with the <code>--enable-exception-hook</code> option. It
+    enables a hook that allows external modules to plug in and do something
+    after a child crashed.</p>
+    
+    <p>There are already two modules, <code>mod_whatkilledus</code> and
+    <code>mod_backtrace</code> that make use of this hook. Please have a
+    look at Jeff Trawick's <a
+    href="http://www.apache.org/~trawick/exception_hook.html"
+    >EnableExceptionHook site</a> for more information about these.</p>
+</usage>
+</directivesynopsis>
+
 <directivesynopsis>
 <name>Group</name>
 <description>Group under which the server will answer
diff --git a/docs/manual/mod/perchild.xml b/docs/manual/mod/perchild.xml
index 7efbf614b2..aa30c2b77c 100644
--- a/docs/manual/mod/perchild.xml
+++ b/docs/manual/mod/perchild.xml
@@ -144,6 +144,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>PidFile</name>
diff --git a/docs/manual/mod/prefork.xml b/docs/manual/mod/prefork.xml
index f65b3ce8ac..744b758f10 100644
--- a/docs/manual/mod/prefork.xml
+++ b/docs/manual/mod/prefork.xml
@@ -85,6 +85,8 @@ uses</a></seealso>
 
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>PidFile</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Listen</name>
diff --git a/docs/manual/mod/threadpool.xml b/docs/manual/mod/threadpool.xml
index 7fcf070bfa..6c22abcc0e 100644
--- a/docs/manual/mod/threadpool.xml
+++ b/docs/manual/mod/threadpool.xml
@@ -50,6 +50,8 @@
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Listen</name>
diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml
index 58360f2a7c..28deb4a353 100644
--- a/docs/manual/mod/worker.xml
+++ b/docs/manual/mod/worker.xml
@@ -141,6 +141,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>PidFile</name>
-- 
2.50.1