man page for bogoupgrade

[Graham Wilson]

On Mon, Oct 21, 2002 at 09:26:22PM -0500, Graham Wilson wrote:
> attached is a first go at a man page for bogoupgrade.

below is a patch to this man page to make it give more info. i ran it
through xmlto and the <programlisting> parts turned out wrong. maybe
somebody with more docbook xml knowledge could look at it?

--- src/bogofilter/cvs/bogoupgrade.xml	2002-10-22 06:47:16.000000000 -0500
+++ tmp/bogoupgrade.xml	2002-10-23 22:34:52.000000000 -0500
@@ -24,9 +24,41 @@
 
 <refsect1 id='description'><title>DESCRIPTION</title>
 <para><command>bogoupgrade</command> is a command to upgrade
-<application>bogofilter</application>'s databases to the latest version. Since
-the format of the database changes once in a while, the utility is designed to 
-make the upgrade easy.</para>
+<application>bogofilter</application>'s databases from (before version 0.7.5)
+to a version compatible with 0.7.5+. Since the format of the database changes
+once in a while, the utility is designed to make the upgrade easy.</para>
+</refsect1>
+
+<refsect1 id='upgrading'><title>UPGRADING</title>
+<para>Follow these instructions to upgrade
+<application>bogofilter</application>'s databases to the latest version.</para>
+
+<orderedlist>
+<listitem><para>Stop all instances of bogofilter. While the upgrade tools lock
+the database files, the upgrade may take a long time if you have a busy site.
+Don't forget to stop cron jobs or daemons that fetch and process mail and could
+fire off bogofilter.</para></listitem>
+
+<listitem><para>Backup your data. Let's assume that you said:</para>
+<programlisting>
+$ mv ~/.bogofilter ~/.bogofilter.safe
+$ mkdir ~/.bogofilter
+</programlisting></listitem>
+
+<listitem><para>If your bogofilter version is less than 0.7, say:</para>
+<programlisting>
+$ /usr/bin/bogoupgrade.pl -b /usr/bin/bogoutil -i ~/.bogofilter.safe/goodlist -o ~/.bogofilter/goodlist.db
+$ /usr/bin/bogoupgrade.pl -b /usr/bin/bogoutil -i ~/.bogofilter.safe/badlist -o ~/.bogofilter/spamlist.db
+</programlisting>
+<para>If your bogofilter version is 0.7 or greater, say:</para>
+<programlisting>
+$ /usr/bin/bogoupgrade.pl -b /usr/bin/bogoutil -i ~/.bogofilter.safe/hamlist.count -o ~/.bogofilter/goodlist.db
+$ /usr/bin/bogoupgrade.pl -b /usr/bin/bogoutil -i ~/.bogofilter.safe/spamlist.count -o ~/.bogofilter/spamlist.db
+</programlisting></listitem>
+
+<listitem><para>Done. Restart any stopped daemons, cron tasks,
+etc.</para></listitem>
+</orderedlist>
 </refsect1>
 
 <refsect1 id='options'><title>OPTIONS</title>

--
gram