Remove some obsolete documentation
[jelmer/ctrlproxy.git] / 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                 <email>jelmer@vernstok.nl</email>
8                 <homepage>http://ctrlproxy.vernstok.nl/</homepage>
9         </modulemeta>
10
11         <description>
12                 <para>Module that logs IRC data to the specified file 
13                 in the same format that the irssi(1) IRC client uses.</para>
14
15                 <para>Each channel or nick gets it's own seperate log file, 
16                 which is located in a directory with the name of the IRC 
17                 network.</para>
18
19                 <para>If no directory is specified, data will be logged to <parameter>$HOME/.ctrlproxy/log_irssi/$NETWORK/$CHANNEL</parameter>.</para>
20
21         </description>
22
23         <configuration>
24                 <element name="logfile">
25                         <description>Should specify a base path that log files 
26                         are to be generated in. For each network, a subdirectory 
27                         will be created in this directory.</description>
28                 </element>
29         </configuration>
30
31         <example>
32                 <![CDATA[
33                 <ctrlproxy>
34                         <plugins>
35                                 <plugin autoload="1" file="log_irssi">
36                                         <logfile>/home/jelmer/log/ctrlproxy</logfile>
37                                 </plugin>
38                         </plugins>
39
40                         <networks>
41                                 <network name="OFTC">
42                                         <servers><ipv4 host="irc.oftc.net"/></servers>
43                                         <channel name="#flood"/>
44                                 </network>
45                         </networks>
46                 </ctrlproxy>
47                 ]]>
48         </example>
49 </ctrlproxy:module>