Add an incomplete document for mod_lbmethod_heartbeat.

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

1 files changed, 52 insertions, 0 deletions

diff --git a/docs/manual/mod/mod_lbmethod_heartbeat.xml b/docs/manual/mod/mod_lbmethod_heartbeat.xml
new file mode 100644
index 0000000000..1b916f5c8b
--- /dev/null
+++ b/docs/manual/mod/mod_lbmethod_heartbeat.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision$ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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_lbmethod_bybusyness.xml.meta">
+
+<name>mod_lbmethod_heartbeat</name>
+<description><!-- FIXME: --> This document is still under development.</description>
+<status>Extension</status>
+<sourcefile>mod_lbmethod_heartbeat.c</sourcefile>
+<identifier>lbmethod_heartbeat_module</identifier>
+<compatibility>Available in version 2.3 and later</compatibility>
+
+<summary>
+    <note><!-- FIXME: --> This document is still under development.</note>
+</summary>
+<seealso><module>mod_proxy</module></seealso>
+<seealso><module>mod_proxy_balancer</module></seealso>
+<seealso><module>mod_heartbeat</module></seealso>
+<seealso><module>mod_heartmonitor</module></seealso>
+
+<directivesynopsis>
+<name>HeartbeatStorage</name>
+<description>Path to read heartbeat data</description>
+<syntax>HeartbeatStorage <var>file-path</var></syntax>
+<default>HeartbeatStorage logs/hb.dat</default>
+<contextlist><context>server config</context></contextlist>
+
+<usage>
+    <note><!-- FIXME: -->This document is still under development.</note>
+</usage> 
+</directivesynopsis>
+
+</modulesynopsis>