summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_echo.xml
blob: ab9ee1a9efb1ab77ea797b80aa361f73196d94a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<?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_echo.xml.meta">

<name>mod_echo</name>
<description>A simple echo server to illustrate protocol
modules</description>
<status>Experimental</status>
<sourcefile>mod_echo.c</sourcefile>
<identifier>echo_module</identifier>

<summary>
    <p>This module provides an example protocol module to illustrate the
    concept. It provides a simple echo server. Telnet to it and type
    stuff, and it will echo it.</p>
</summary>

<directivesynopsis>

<name>ProtocolEcho</name>
<description>Turn the echo server on or off</description>
<syntax>ProtocolEcho On|Off</syntax>
<default>ProtocolEcho Off</default>
<contextlist><context>server config</context>
<context>virtual host</context></contextlist>

<usage>
    <p>The <directive>ProtocolEcho</directive> directive enables or
    disables the echo server.</p>

    <example><title>Example</title>
    <highlight language="config">
      ProtocolEcho On
    </highlight>
    </example>
</usage>

</directivesynopsis>
</modulesynopsis>