← Back to branch summary

~ctrlproxy/ctrlproxy/trunk

« back to all changes in this revision

Viewing changes to doc/log_irssi.mod.xml

  • Committer: jelmer
  • Date: 2003-10-18 22:02:02 UTC
  • Revision ID: jelmer@samba.org-20031018220202-6801a76318fb4d13
Update

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/log_irssi.mod.xml
 
1
<ctrlproxy:module name="log_irssi"
 
2
        xmlns:ctrlproxy="http://ctrlproxy.vernstok.nl/common">
 
3
        <modulemeta>
 
4
                <description>Irssi-style log files</description>
 
5
                <version>0.1</version>
 
6
                <author>Jelmer Vernooij</author>
 
7
                <homepage>http://jelmer.vernstok.nl/ctrlproxy/</homepage>
 
8
        </modulemeta>
 
9
 
 
10
        <description>
 
11
                <para>Module that logs IRC data to the specified file 
 
12
                in the same format that the irssi(1) IRC client uses.</para>
 
13
 
 
14
                <para>Each channel or nick gets it's own seperate log file, 
 
15
                which is located in a directory with the name of the IRC 
 
16
                network.</para>
 
17
 
 
18
        </description>
 
19
 
 
20
        <configuration>
 
21
                <element name="logfile">
 
22
                        <description>Should specify a base path that log files 
 
23
                        are to be generated in. For each network, a subdirectory 
 
24
                        will be created in this directory.</description>
 
25
                </element>
 
26
        </configuration>
 
27
 
 
28
        <example>
 
29
                <![CDATA[
 
30
                <ctrlproxy>
 
31
                        <plugins>
 
32
                                <plugin autoload="1" file="log_irssi">
 
33
                                        <logfile>/home/jelmer/log/ctrlproxy</logfile>
 
34
                                </plugin>
 
35
                                <plugin autoload="1" file="socket"/>
 
36
                        </plugins>
 
37
 
 
38
                        <networks>
 
39
                                <network name="OFTC">
 
40
                                        <servers><ipv4 host="irc.oftc.net"/></servers>
 
41
                                        <channel name="#flood"/>
 
42
                                </network>
 
43
                        </networks>
 
44
                </ctrlproxy>
 
45
                ]]>
 
46
        </example>
 
47
</ctrlproxy:module>