~ctrlproxy/ctrlproxy/trunk

<ctrlproxy:module name="repl_command"

        xmlns:ctrlproxy="http://ctrlproxy.vernstok.nl/common">

        <modulemeta>

                <description>Replicate lines on demand</description>

                <version>0.1</version>

                <author>Jelmer Vernooij</author>

                <email>jelmer@vernstok.nl</email>

                <homepage>http://ctrlproxy.vernstok.nl/</homepage>

                <requirements>admin module</requirements>

        </modulemeta>

 

        <description>

                <para>Replicates certain lines of backlog, when the user requests 

                        so via a <command>/CTRLPROXY</command> or <command>/MSG CTRLPROXY</command> command.</para>

        </description>

 

        <section>

                <title>The BACKLOG command</title>

 

                <para>The <command>BACKLOG</command> command can be run by using 

                        the command interface of the 'admin' module.</para>

 

                <para>Without any arguments, the BACKLOG command replicates all the 

                        backlogs for the current channel.</para>

 

                <para>WIth one argument, the name of a channel, all lines on that 

                        channel are replicated.</para>

 

                <para>With two arguments, the first argument contains the name of a channel 

                        and the second the number of lines to replicate, the specified number 

                        of (most recent) lines from the specified channel is replicated.</para>

        </section>

 

        <section><title>Example commands</title>

                <screen>

                        BACKLOG 

                        BACKLOG #flood.nl

                        BACKLOG #linux.nl 500

                </screen>

        </section>

</ctrlproxy:module>