← Back to branch summary

~ctrlproxy/ctrlproxy/trunk

« back to all changes in this revision

Viewing changes to doc/report-time.mod.xml

  • Committer: jelmer
  • Date: 2005-10-30 01:15:57 UTC
  • Revision ID: jelmer@samba.org-20051030011557-7137f871b7495c7c
Re-import docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/report-time.mod.xml
 
1
<ctrlproxy:module name="report-time"
 
2
        xmlns:ctrlproxy="http://ctrlproxy.vernstok.nl/common">
 
3
        <modulemeta>
 
4
                <description>Time reporter</description>
 
5
                <version>0.1</version>
 
6
                <author>Jelmer Vernooij</author>
 
7
                <email>jelmer@vernstok.nl</email>
 
8
                <homepage>http://ctrlproxy.vernstok.nl/</homepage>
 
9
        </modulemeta>
 
10
 
 
11
        <description>
 
12
                <para>Very simple module that prints the time before every message. Such 
 
13
                        messages are very useful for backlogs. That way, you can know at 
 
14
                        approximately which time something was said.</para>
 
15
        </description>
 
16
 
 
17
        <configuration>
 
18
                <element name="format">
 
19
                        <description>Format of the timestamp. See the manual page of the 
 
20
                                strftime() function for what is supported.</description>
 
21
                </element>
 
22
        </configuration>
 
23
 
 
24
        <example>
 
25
                <![CDATA[
 
26
                <ctrlproxy>
 
27
                        <plugins>
 
28
                                <plugin autoload="1" file="report_time">
 
29
                                        <format>%h:%m:%s</format>
 
30
                                        <interval>300</interval>
 
31
                                </plugin>
 
32
                        </plugins>
 
33
                </ctrlproxy>
 
34
        ]]>
 
35
        </example>
 
36
</ctrlproxy:module>