[PATCH 1.0.0] trivial xml documentation stuff
Nicolas Kaiser
nikai at nikai.net
Fri Dec 16 15:24:43 CET 2005
Some trivial xml documentation stuff:
* typos
* consistent use of 'attribute', 'command', and 'option' tags
* use 'emphasis' tag instead of _bla_
* use 'MiB' instead of 'MByte' where explicitly used in this
meaning (less ambiguous; Note that in contrast, in README.db
'MB' appears to be used in the SI meaning)
I tried to go for a line width of about 80.
Cheers,
n.
---
doc/bf_compact.xml | 16 +++---
doc/bf_copy.xml | 20 +++----
doc/bf_tar.xml | 15 ++---
doc/bogofilter.xml | 131 ++++++++++++++++++++++++++++------------------------
doc/bogolexer.xml | 16 +++---
doc/bogotune.xml | 13 ++---
doc/bogoupgrade.xml | 18 ++++---
doc/bogoutil.xml | 43 +++++++++--------
8 files changed, 146 insertions(+), 126 deletions(-)
diff -urpN bogofilter-1.0.0.orig/doc/bf_compact.xml bogofilter-1.0.0/doc/bf_compact.xml
--- bogofilter-1.0.0.orig/doc/bf_compact.xml 2005-05-16 03:14:17.000000000 +0200
+++ bogofilter-1.0.0/doc/bf_compact.xml 2005-12-16 14:09:55.000000000 +0100
@@ -8,7 +8,7 @@
</refmeta>
<refnamediv id='name'>
<refname>bf_compact</refname>
- <refpurpose>shell script to compact a bogofilter directory</refpurpose>
+ <refpurpose>shell script to compact a <application>bogofilter</application> directory</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
@@ -19,13 +19,13 @@
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
- <para><command>bf_compact</command> creates a more
- compact bogofilter working directory with a dump/load cycle
- and renames the previous
+ <para><command>bf_compact</command> creates a more compact
+ <application>bogofilter</application> working directory with a
+ dump/load cycle and renames the previous
<replaceable>bogofilter_directory</replaceable> to
<replaceable>bogofilter_directory</replaceable><filename>.old</filename>.</para>
- <para>Note: bf_compact cannot be used to process the current
- working directory, ".", because of directory renaming issues.</para>
+ <para>Note: <command>bf_compact</command> cannot be used to process the
+ current working directory, ".", because of directory renaming issues.</para>
<para>If no <replaceable>wordlist_file</replaceable> arguments are
given, then <command>bf_compact</command> will use the
configured set of wordlists, if the given
@@ -41,10 +41,10 @@
<replaceable>bogofilter_directory</replaceable><filename>.old</filename>
and all of its contents!</para>
<para>This script is meant for use with Berkeley DB based
- bogofilter versions.</para>
+ <application>bogofilter</application> versions.</para>
<para>This script expects a SUSv2 compliant shell. Solaris
systems should have the <systemitem>SUNWxcu4</systemitem> package installed (when
- bogofilter is configured) so that
+ <application>bogofilter</application> is configured) so that
<filename>/usr/xpg4/bin/sh</filename> can
be used.</para>
</refsect1>
diff -urpN bogofilter-1.0.0.orig/doc/bf_copy.xml bogofilter-1.0.0/doc/bf_copy.xml
--- bogofilter-1.0.0.orig/doc/bf_copy.xml 2005-05-16 03:17:05.000000000 +0200
+++ bogofilter-1.0.0/doc/bf_copy.xml 2005-12-16 14:15:31.000000000 +0100
@@ -8,7 +8,8 @@
</refmeta>
<refnamediv id='name'>
<refname>bf_copy</refname>
- <refpurpose>shell script to copy a bogofilter working directory</refpurpose>
+ <refpurpose>shell script to copy a <application>bogofilter</application>
+ working directory</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
@@ -20,10 +21,10 @@
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
- <para><command>bf_copy</command> copies a bogofilter working
- directory to another directory. Currently it copies the
- database files (*.db), related files (log.*), and
- DB_CONFIG (if present).</para>
+ <para><command>bf_copy</command> copies a
+ <application>bogofilter</application> working directory to another
+ directory. Currently it copies the database files (*.db), related
+ files (log.*), and DB_CONFIG (if present).</para>
</refsect1>
<refsect1 id='options'><title>Options</title>
<para>The <option>-c</option> option causes only active log files to
@@ -40,11 +41,10 @@
</refsect1>
<refsect1 id='notes'><title>Notes</title>
<para>This script is meant for use with Berkeley DB and SQLite based
- bogofilter versions.</para>
+ <application>bogofilter</application> versions.</para>
<para>This script expects a SUSv2 compliant shell. Solaris
- systems should have the <systemitem>SUNWxcu4</systemitem> package installed (when
- bogofilter is configured) so that
- <filename>/usr/xpg4/bin/sh</filename> can
- be used.</para>
+ systems should have the <systemitem>SUNWxcu4</systemitem> package
+ installed (when <application>bogofilter</application> is configured)
+ so that <filename>/usr/xpg4/bin/sh</filename> can be used.</para>
</refsect1>
</refentry>
diff -urpN bogofilter-1.0.0.orig/doc/bf_tar.xml bogofilter-1.0.0/doc/bf_tar.xml
--- bogofilter-1.0.0.orig/doc/bf_tar.xml 2005-05-20 05:36:03.000000000 +0200
+++ bogofilter-1.0.0/doc/bf_tar.xml 2005-12-16 14:20:13.000000000 +0100
@@ -8,8 +8,8 @@
</refmeta>
<refnamediv id='name'>
<refname>bf_tar</refname>
- <refpurpose>shell script to write a tar file of a bogofilter
- directory to stdout</refpurpose>
+ <refpurpose>shell script to write a tar file of a
+ <application>bogofilter</application> directory to stdout</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
@@ -21,7 +21,7 @@
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
- <para><command>bf_tar</command> bundles a bogofilter
+ <para><command>bf_tar</command> bundles a <application>bogofilter</application>
working directory in tar format and copies it to
standard output (your console, or where you redirect it, see
<link linkend='examples'>EXAMPLES</link> below).</para></refsect1>
@@ -65,13 +65,12 @@
</refsect1>
<refsect1 id='notes'><title>Notes</title>
<para>This script is meant for use with Berkeley DB based
- bogofilter versions.</para>
+ <application>bogofilter</application> versions.</para>
<para>This script requires a SUSv2 compliant
<command>pax</command> utility.</para>
<para>This script expects a SUSv2 compliant shell. Solaris
- systems should have the <systemitem>SUNWxcu4</systemitem> package installed (when
- bogofilter is configured) so that
- <filename>/usr/xpg4/bin/sh</filename> can
- be used.</para>
+ systems should have the <systemitem>SUNWxcu4</systemitem> package
+ installed (when <application>bogofilter</application> is configured)
+ so that <filename>/usr/xpg4/bin/sh</filename> can be used.</para>
</refsect1>
</refentry>
diff -urpN bogofilter-1.0.0.orig/doc/bogofilter.xml bogofilter-1.0.0/doc/bogofilter.xml
--- bogofilter-1.0.0.orig/doc/bogofilter.xml 2005-10-29 20:42:48.000000000 +0200
+++ bogofilter-1.0.0/doc/bogofilter.xml 2005-12-16 14:36:12.000000000 +0100
@@ -106,10 +106,10 @@
In its normal mode of operation, it takes an email message or other
text on standard input, does a statistical check against lists of
"good" and "bad" words, and returns a status code indicating whether
-or not the message is spam. Bogofilter is designed with a fast
-algorithm, uses the Berkeley DB for fast startup and lookups,
-coded directly in C, and tuned for speed, so it can be used for
-production by sites that process a lot of mail.</para>
+or not the message is spam. <application>Bogofilter</application> is
+designed with a fast algorithm, uses the Berkeley DB for fast startup
+and lookups, coded directly in C, and tuned for speed, so it can be
+used for production by sites that process a lot of mail.</para>
</refsect1>
<refsect1 id='theory'><title>THEORY OF OPERATION</title>
@@ -210,8 +210,10 @@ to a user's email population can be dete
<para>The <option>-V</option> option prints the version number and
exits.</para>
-<para>The <option>-Q</option> (query) option prints bogofilter's configuration,
-i.e. registration parameters, parsing options, bogofilter directory, etc.</para>
+<para>The <option>-Q</option> (query) option prints
+<application>bogofilter</application>'s configuration, i.e. registration
+parameters, parsing options, <application>bogofilter</application>
+directory, etc.</para>
<para>CLASSIFICATION OPTIONS</para>
@@ -219,14 +221,17 @@ i.e. registration parameters, parsing op
with an X-Bogosity line at the end of the message header. This
requires keeping the entire message in memory when it's read from
stdin (or from a pipe or socket). If the message is read from a file
-that can be rewound, bogofilter will read it a second time.</para>
+that can be rewound, <application>bogofilter</application> will read it
+a second time.</para>
<para>The <option>-e</option> (embed) option tells
<application>bogofilter</application> to exit with code 0 if the
message can be classified, i.e. if there is not an error. Normally
-bogofilter uses different codes for spam, ham, and unsure
-classifications, but this simplifies using bogofilter with procmail or
-maildrop.</para>
+<application>bogofilter</application> uses different codes for spam, ham,
+and unsure classifications, but this simplifies using
+<application>bogofilter</application> with
+<application>procmail</application> or
+<application>maildrop</application>.</para>
<para>The <option>-t</option> (terse) option tells
<application>bogofilter</application> to print an abbreviated
@@ -279,11 +284,12 @@ name and classification information for
<para>An object in this context shall be a maildir (autodetected), or
if it's not a maildir, a single mail unless <option>-M</option> is
-given - in that case it's processed as a mbox. (The Content-Length:
+given - in that case it's processed as mbox. (The Content-Length:
header is not taken into account currently.)</para>
-<para>When reading mbox format, bogofilter relies on the empty line
-after a mail. If needed, formail -es will ensure this is the case.</para>
+<para>When reading mbox format, <application>bogofilter</application>
+relies on the empty line after a mail. If needed,
+<command>formail -es</command> will ensure this is the case.</para>
<para>The <option>-B <replaceable>object ...</replaceable></option>
(bulk mode) option tells <application>bogofilter</application> to
@@ -310,28 +316,26 @@ as spam. The database is created if abs
<application>bogofilter</application> to register the text presented
as non-spam.</para>
-<para><application>Bogofilter</application> doesn't detect if a
-message registered twice. If you do this by accident, the token
-counts will off by 1 from what you really want and the corresponding
-spam scores will be slightly off. Given a large number of tokens and
-messages in the wordlist, this doesn't matter. The problem _can_ be
-corrected by using the <option>-S</option> option or the <option>-N</option>
-option.</para>
-
-<para>The <option>-S</option> option tells
-<application>bogofilter</application> to undo a prior registration of
-the same message as spam. If a message was incorrectly entered as
-spam by '-s' or '-u' and you want to remove it and enter it as
-non-spam, use options '-Sn'. If '-S' is used for a message that
-wasn't registered as spam, the counts will still be
-decremented.</para>
-
-<para>The <option>-N</option> option tells
-<application>bogofilter</application> to undo a prior registration of
-the same message as non-spam. If a message was incorrectly entered as
-non-spam by '-n' or '-u' and you want to remove it and enter it as
-spam, then use '-Ns'. If '-N' is used for a message that wasn't
-registered as non-spam, the counts will still be decremented.</para>
+<para><application>Bogofilter</application> doesn't detect if a message
+registered twice. If you do this by accident, the token counts will off by 1
+from what you really want and the corresponding spam scores will be slightly
+off. Given a large number of tokens and messages in the wordlist, this
+doesn't matter. The problem <emphasis>can</emphasis> be corrected by using
+the <option>-S</option> option or the <option>-N</option> option.</para>
+
+<para>The <option>-S</option> option tells <application>bogofilter</application>
+to undo a prior registration of the same message as spam. If a message was
+incorrectly entered as spam by <option>-s</option> or <option>-u</option>
+and you want to remove it and enter it as non-spam, use <option>-Sn</option>.
+If <option>-S</option> is used for a message that wasn't registered as spam,
+the counts will still be decremented.</para>
+
+<para>The <option>-N</option> option tells <application>bogofilter</application>
+to undo a prior registration of the same message as non-spam. If a message was
+incorrectly entered as non-spam by <option>-n</option> or <option>-u</option>
+and you want to remove it and enter it as spam, then use <option>-Ns</option>.
+If <option>-N</option> is used for a message that wasn't registered as non-spam,
+the counts will still be decremented.</para>
<para>GENERAL OPTIONS</para>
@@ -339,15 +343,16 @@ registered as non-spam, the counts will
option tells <application>bogofilter</application> to read the config
file named.</para>
-<para>The <option>-C</option> option prevents bogofilter from reading
-configuration files.</para>
+<para>The <option>-C</option> option prevents
+<application>bogofilter</application> from reading configuration
+files.</para>
<para>The <option>-d <replaceable>dir</replaceable></option> option
allows you to set the directory for the database. See the ENVIRONMENT
section for other directory setting options.</para>
<para>The <option>-k <replaceable>cachesize</replaceable></option> option
-sets the cache size for the BerkeleyDB subsystem, in units of 1 MByte (1,048,576
+sets the cache size for the BerkeleyDB subsystem, in units of 1 MiB (1,048,576
bytes). Properly sizing the cache improves
<application>bogofilter</application>'s performance. The recommended
size is one third of the size of the database file. You can run the
@@ -380,27 +385,27 @@ passthrough mode. Note that this only w
<replaceable>value<optional>,value</optional></replaceable></option>
option allows setting the sp-esf value and the ns-esf value.
With two values, both sp-esf and ns-esf are set. If only one
- value is given, parameters are set as decribed in the note
+ value is given, parameters are set as described in the note
below.</para>
<para>The <option>-m
<replaceable>value<optional>,value</optional><optional>,value</optional></replaceable></option>
option allows setting the min-dev value and, optionally, the
robs and robx values. With three values, min-dev, robs, and
- robx are all set. If fewer valuesare given, parameters are set
- as decribed in the note below.</para>
+ robx are all set. If fewer values are given, parameters are set
+ as described in the note below.</para>
<para>The <option>-o
<replaceable>value<optional>,value</optional></replaceable></option>
option allows setting the spam-cutoff ham-cutoff values. With
two values, both spam-cutoff and ham-cutoff are set. If only
- one value is given, parameters are set as decribed in the note
+ one value is given, parameters are set as described in the note
below.</para>
<para>Note: All of these options allow fewer values to be provided.
Values can be skipped by using just the comma delimiter, in which
case the corresponding parameter(s) won't be changed. If only
- the first value is provided, then only the first parameterm is
+ the first value is provided, then only the first parameter is
set. Trailing values can be skipped, in which case the
corresponding parameters won't be changed. Within the parameter
list, spaces are not allowed after commas.</para>
@@ -443,11 +448,12 @@ them. For example to change the X-Bogosi
</refsect1>
<refsect1 id='environment'><title>ENVIRONMENT</title>
-<para>Bogofilter uses a database directory, which can be set in the
-config file. If not set there, bogofilter will use the value of
+<para><application>Bogofilter</application> uses a database directory,
+which can be set in the config file. If not set there,
+<application>bogofilter</application> will use the value of
<envar>BOGOFILTER_DIR</envar>. Both can be overridden by the
<option>-d <replaceable>dir</replaceable></option> option. If none of
-that is available, bogofilter will use directory
+that is available, <application>bogofilter</application> will use directory
<filename>$HOME/.bogofilter</filename>.</para>
</refsect1>
@@ -529,7 +535,7 @@ spam
</programlisting>
and this similar rule will also register the tokens in the mail
-according to the bogofilter classification:
+according to the <application>bogofilter</application> classification:
<programlisting>:0HB:
* ? bogofilter -u
@@ -539,8 +545,9 @@ spam
<para>If <application>bogofilter</application> fails (returning 3) the
message will be treated as non-spam.</para>
-<para>This one is for maildrop, it automatically defers the mail and
- retries later when the xfilter command fails, use this in your
+<para>This one is for <application>maildrop</application>, it
+ automatically defers the mail and retries later when the
+ <application>xfilter</application> command fails, use this in your
<filename>~/.mailfilter</filename>:</para>
<programlisting>xfilter "bogofilter -u -e -p"
if (/^X-Bogosity: Spam, tests=bogofilter/)
@@ -574,13 +581,14 @@ macro index \ed "<enter-command>un
<para>Install <application>bogofilter</application> on the mail server</para>
</step>
<step>
- <para>Prime the bogofilter databases with a spam and non-spam corpus.
- Since <application>bogofilter</application> will be serving a larger community,
- it is important to prime it with a representative set of messages.</para>
+ <para>Prime the <application>bogofilter</application> databases with a spam
+and non-spam corpus. Since <application>bogofilter</application> will be
+serving a larger community, it is important to prime it with a representative
+set of messages.</para>
</step>
<step>
- <para>Set up the MTA to invoke bogofilter on each message.
- While this is an MTA specific step, you'll probably need to use the
+ <para>Set up the MTA to invoke <application>bogofilter</application> on each
+ message. While this is an MTA specific step, you'll probably need to use the
<option>-p</option>, <option>-u</option>, and <option>-e</option> options.</para>
</step>
<step>
@@ -623,8 +631,9 @@ comments.</para>
<refsect1 id='logmessages'><title>Log messages</title>
-<para>Bogofilter writes messages to the system log when the <option>-l</option>
-option is used. What is written depends on which other flags are used.</para>
+<para><application>Bogofilter</application> writes messages to the system log
+ when the <option>-l</option> option is used. What is written depends on
+ which other flags are used.</para>
<para>A classification run will generate (we are not showing the date
and host part here):
@@ -632,18 +641,20 @@ option is used. What is written depends
bogofilter[1412]: X-Bogosity: Ham, spamicity=0.000227
bogofilter[1415]: X-Bogosity: Spam, spamicity=0.998918
</screen></para>
-<para>Using '-u' to classify a message and update a wordlist will
- produce (one a single line):
+<para>Using <option>-u</option> to classify a message and update a wordlist
+ will produce (one a single line):
<screen>
bogofilter[1426]: X-Bogosity: Spam, spamicity=0.998918,
register -s, 329 words, 1 messages
</screen></para>
- <para>Registering words ('-l' and '-s', '-n', '-S', or '-N') will produce:
+ <para>Registering words (<option>-l</option> and <option>-s</option>,
+ <option>-n</option>, <option>-S</option>, or <option>-N</option>) will produce:
<screen>
bogofilter[1440]: register-n, 255 words, 1 messages
</screen></para>
-<para>A registration run (using '-s', '-n', '-N', or '-S') will generate messages like:
+<para>A registration run (using <option>-s</option>, <option>-n</option>,
+ <option>-N</option>, or <option>-S</option>) will generate messages like:
<screen>
bogofilter[17330]: register-n, 574 words, 3 messages
bogofilter[6244]: register-s, 1273 words, 4 messages
diff -urpN bogofilter-1.0.0.orig/doc/bogolexer.xml bogofilter-1.0.0/doc/bogolexer.xml
--- bogofilter-1.0.0.orig/doc/bogolexer.xml 2004-12-30 23:07:19.000000000 +0100
+++ bogofilter-1.0.0/doc/bogolexer.xml 2005-12-16 12:40:24.000000000 +0100
@@ -28,8 +28,10 @@
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
- <para><application>Bogolexer</application> is part of the bogofilter Bayesian spam filter package.</para>
- <para>It is used to separate messages into tokens and to test new versions of the lexer.l code.</para>
+ <para><application>Bogolexer</application> is part of the
+ <application>bogofilter</application> Bayesian spam filter package.</para>
+ <para>It is used to separate messages into tokens and to test new versions of
+ the <filename>lexer.l</filename> code.</para>
</refsect1>
<refsect1 id="options">
<title>OPTIONS</title>
@@ -42,8 +44,8 @@
to print a token count,
without printing the actual tokens. </para>
<para>The <option>-h</option> option prints the help message and exits.</para>
- <para>The <option>-n</option> option tells bogolexer to map
- non-ascii characters to the question point '?'.</para>
+ <para>The <option>-n</option> option tells <application>bogolexer</application>
+ to map non-ascii characters to the question point '?'.</para>
<para>The <option>-v</option> option increases the verbosity level.</para>
<para>The <option>-x <replaceable>flags</replaceable></option> option
@@ -53,8 +55,8 @@ allows setting of debug flags for printi
tells <application>bogolexer</application> to read the config file named.
</para>
-<para>The <option>-C</option> option prevents bogolexer from reading
- configuration files.</para>
+<para>The <option>-C</option> option prevents <application>bogolexer</application>
+ from reading configuration files.</para>
<para>The <option>-D</option> option redirects the debugging output to
stdout (it defaults to stderr).</para>
@@ -73,7 +75,7 @@ exits.</para>
<refsect1 id="author">
<title>AUTHOR</title>
- <para>The bogofilter developer team.</para>
+ <para>The <application>bogofilter</application> developer team.</para>
<para>
For updates, see <ulink url="http://bogofilter.sourceforge.net/">
the bogofilter project page</ulink>.
diff -urpN bogofilter-1.0.0.orig/doc/bogotune.xml bogofilter-1.0.0/doc/bogotune.xml
--- bogofilter-1.0.0.orig/doc/bogotune.xml 2005-01-18 06:03:59.000000000 +0100
+++ bogofilter-1.0.0/doc/bogotune.xml 2005-12-16 12:40:35.000000000 +0100
@@ -121,12 +121,13 @@
<refsect1 id='environment'><title>ENVIRONMENT</title>
- <para>Bogofilter uses a database directory, which can be set in
- the config file. If not set there, bogofilter will use the value
- of <envar>BOGOFILTER_DIR</envar>. Both can be overridden by the
+ <para><application>Bogofilter</application> uses a database directory,
+ which can be set in the config file. If not set there,
+ <application>bogofilter</application> will use the value of
+ <envar>BOGOFILTER_DIR</envar>. Both can be overridden by the
<option>-d<replaceable>dir</replaceable></option> option. If none
- of that is available, bogofilter will use directory
- <filename>$HOME/.bogofilter</filename>.</para>
+ of that is available, <application>bogofilter</application> will use
+ directory <filename>$HOME/.bogofilter</filename>.</para>
</refsect1>
@@ -138,7 +139,7 @@
<refsect1 id="author">
<title>AUTHOR</title>
- <para>The bogofilter developer team.</para>
+ <para>The <application>bogofilter</application> developer team.</para>
<para>
For updates, see <ulink url="http://bogofilter.sourceforge.net/">
the bogofilter project page</ulink>.
diff -urpN bogofilter-1.0.0.orig/doc/bogoupgrade.xml bogofilter-1.0.0/doc/bogoupgrade.xml
--- bogofilter-1.0.0.orig/doc/bogoupgrade.xml 2004-08-28 15:41:11.000000000 +0200
+++ bogofilter-1.0.0/doc/bogoupgrade.xml 2005-12-16 12:28:21.000000000 +0100
@@ -8,7 +8,8 @@
</refmeta>
<refnamediv id='name'>
<refname>bogoupgrade</refname>
-<refpurpose>upgrades bogofilter database to current version</refpurpose>
+<refpurpose>upgrades <application>bogofilter</application> database to
+current version</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
@@ -57,10 +58,11 @@ it.</para>
<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>Stop all instances of <application>bogofilter</application>.
+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
+<application>bogofilter</application>.</para></listitem>
<listitem><para>Backup your data. Let's assume that you said:</para>
<screen>
@@ -68,12 +70,14 @@ fire off bogofilter.</para></listitem>
<prompt>$</prompt> <userinput>mkdir ~/.bogofilter</userinput>
</screen></listitem>
-<listitem><para>If your bogofilter version is less than 0.7, say:</para>
+<listitem><para>If your <application>bogofilter</application> version is less
+than 0.7, say:</para>
<screen>
<prompt>$</prompt> <userinput>bogoupgrade -i ~/.bogofilter.safe/goodlist -o ~/.bogofilter/goodlist.db</userinput>
<prompt>$</prompt> <userinput>bogoupgrade -i ~/.bogofilter.safe/badlist -o ~/.bogofilter/spamlist.db</userinput>
</screen>
-<para>If your bogofilter version is 0.7 or greater, say:</para>
+<para>If your <application>bogofilter</application> version is 0.7 or greater,
+say:</para>
<screen>
<prompt>$</prompt> <userinput>bogoupgrade -i ~/.bogofilter.safe/hamlist.count -o ~/.bogofilter/goodlist.db</userinput>
<prompt>$</prompt> <userinput>bogoupgrade -i ~/.bogofilter.safe/spamlist.count -o ~/.bogofilter/spamlist.db</userinput>
diff -urpN bogofilter-1.0.0.orig/doc/bogoutil.xml bogofilter-1.0.0/doc/bogoutil.xml
--- bogofilter-1.0.0.orig/doc/bogoutil.xml 2005-08-14 15:03:37.000000000 +0200
+++ bogofilter-1.0.0/doc/bogoutil.xml 2005-12-16 14:38:59.000000000 +0100
@@ -7,7 +7,8 @@
</refmeta>
<refnamediv id="name">
<refname>bogoutil</refname>
- <refpurpose>Dumps, loads, and maintains bogofilter database files</refpurpose>
+ <refpurpose>Dumps, loads, and maintains
+ <application>bogofilter</application> database files</refpurpose>
</refnamediv>
<refsynopsisdiv id="synopsis">
@@ -76,10 +77,11 @@
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
- <para><application>Bogoutil</application> is part of the bogofilter Bayesian spam filter package.</para>
- <para>It is used to dump and load bogofilter's Berkeley DB databases to and
- from text files, perform database maintenance functions, and to display the
- values for specific words.</para>
+ <para><application>Bogoutil</application> is part of the
+ <application>bogofilter</application> Bayesian spam filter package.</para>
+ <para>It is used to dump and load <application>bogofilter</application>'s
+ Berkeley DB databases to and from text files, perform database maintenance
+ functions, and to display the values for specific words.</para>
</refsect1>
<refsect1 id="options">
<title>OPTIONS</title>
@@ -154,11 +156,11 @@
This option is primarily useful for debugging.
</para>
<para>The <option>-C</option> inhibits reading configuration
- files and lets bogoutil go with the defaults.</para>
+ files and lets <application>bogoutil</application> go with the defaults.</para>
<para>The <option>--config-file
<replaceable>file</replaceable></option> option tells
- bogoutil to read <replaceable>file</replaceable> instead of
- the standard configuration file.</para>
+ <application>bogoutil</application> to read <replaceable>file</replaceable>
+ instead of the standard configuration file.</para>
<para>The <option>-D</option> redirects debug output to stdout (it
usually goes to stderr).</para>
<para>The <option>-x <replaceable>flags</replaceable></option>
@@ -166,9 +168,10 @@
<para>
Option <option>-n</option> stands for "replace non-ascii characters".
It will replace characters with the high bit (0x80) by question marks.
- This can be useful if a word list has lots of unreadable tokens, for example from asian spam.
- The "bad" characters will be converted to question marks and matching tokens will be combined
- when used with '-m' or '-l', but not with '-d'.
+ This can be useful if a word list has lots of unreadable tokens, for
+ example from Asian spam. The "bad" characters will be converted to
+ question marks and matching tokens will be combined when used with
+ <option>-m</option> or <option>-l</option>, but not with <option>-d</option>.
</para>
<para>
Option <option>-a age</option> indicates an acceptable token age, with older ones being discarded.
@@ -194,13 +197,13 @@
<refsect1 id="environment_maintenance">
<title>ENVIRONMENT MAINTENANCE</title>
<para>The <option>--db-checkpoint <replaceable>dir</replaceable></option>
- option causes bogoutil to flush the buffer caches and
- checkpoint the database environment.</para>
+ option causes <application>bogoutil</application> to flush the buffer
+ caches and checkpoint the database environment.</para>
<para>The <option>--db-list-logfiles
<replaceable>dir</replaceable></option>
- option causes bogoutil to list the log files in the
- environment. Zero or more keywords can be added or combined
- (separated by whitespace) to modify the behaviork of this
+ option causes <application>bogoutil</application> to list the log
+ files in the environment. Zero or more keywords can be added or
+ combined (separated by whitespace) to modify the behavior of this
mode. The default behavior is to list only inactive log
files with relative paths. You can add <option>all</option>
to list all log files (inactive and active). You can add
@@ -208,8 +211,8 @@
paths.
</para>
<para>The <option>--db-prune <replaceable>dir</replaceable></option>
- option causes bogoutil to checkpoint the database
- environment and remove inactive log files.</para>
+ option causes <application>bogoutil</application> to checkpoint
+ the database environment and remove inactive log files.</para>
<para>The <option>--db-recover <replaceable>dir</replaceable></option>
option runs a regular database recovery
in the specified database directory. If that fails, it will retry
@@ -248,8 +251,8 @@
that do not allow a query of the database page size.</para>
<para>
The <option>--db-verify <replaceable>file</replaceable></option>
- option requests that bogofilter verifies the database file.
- It prints only errors, unless in verbose mode.
+ option requests that <application>bogofilter</application> verifies
+ the database file. It prints only errors, unless in verbose mode.
</para>
</refsect1>
More information about the bogofilter-dev
mailing list