mbot (0.3-7) mbot.1.sgml

--- mbot-0.3.orig/mbot.1.sgml
+++ mbot-0.3/mbot.1.sgml
@@ -0,0 +1,148 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<refentry>
+  <refentryinfo>
+    <address>
+      <email>dim@tuxfamily.org</email>
+    </address>
+    <author>
+      <firstname>Dimitri</firstname>
+      <surname>Fontaine</surname>
+    </author>
+    <date>Décembre 2003</date>
+    <copyright>
+      <year>2003</year>
+      <holder>Dimitri Fontaine</holder>
+    </copyright>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>mbot</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>mbot</refname>
+    <refpurpose>
+      Mail handling robot
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>mbot</command>
+      <arg><option>-h</option></arg>
+      <arg><option>-c</option> configuration file</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      <command>mbot</command> is a generic purpose mail robot, written
+      in python. The first goal while writting this piece of software
+      was to provide some kind of web access (http) to people limited on
+      mail (smtp).
+    </para>
+
+    <para>
+      So mbot will receive some mail and make some action for you,
+      then send you back a reply mail. The actions mbot will take are
+      to be defined in its configuration file (see
+      <command>mbot.conf</command>(5)) and depends on the available
+      handlers :
+
+      <variablelist>
+      <varlistentry>
+        <term>GoogleHandler</term>
+        <listitem>
+          <para>Used to perform some search with the well known search
+          engine</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>UrlHandler</term>
+        <listitem>
+          <para>This one allows to download some url and attach its
+          content to the return mail, with the mime type properly
+          set.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>NewsHandler</term>
+        <listitem>
+          <para>You can also send some news (with images) to mbot, it
+          will fill your database with it. Currently supported RDBMs
+          are PostgreSQL and MySQL, so you will have to choose between
+          PgNewsHandler and MyNewsHandler.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PipeHandler</term>
+        <listitem>
+          <para>This one will make mbot call an arbitrary given command!</para>
+        </listitem>
+      </varlistentry>
+      </variablelist>
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+      <varlistentry>
+        <term><option>-h</option></term>
+        <listitem>
+          <para>will print the help page.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-c</option></term>
+        <listitem>
+          <para>specifies the configuration file to use. If omitted mbot
+	  will look for it in his own directory.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Install</title>
+    <para>
+
+    To install that mail bot, just add a line in your mail alias file,
+    often found under <filename>/etc/aliases</filename>.
+
+    </para>
+    <para>
+
+    If you use the <command>exim</command> MTA, be sure to add the option
+    <command>pipe_as_creator</command> to your configuration, in the
+    <command>address_pipe</command> section.
+
+    </para>
+  </refsect1>
+
+
+  <refsect1>
+    <title>Bugs</title>
+    <para> There should be none... :)
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <command>mbot.conf</command>(5)
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Authors</title>
+    <para>
+      <command>mbot</command> was writen by Dimitri Fontaine
+      <email>dim@tuxfamily.org</email> and Christophe Truffier
+      <email>nah-ko@tuxfamily.org</email>.
+    </para>
+  </refsect1>
+  
+</refentry>