<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='bf_compact.1'>
    <refmeta>
	<refentrytitle>bf_compact</refentrytitle>
	<manvolnum>1</manvolnum>
    </refmeta>
    <refnamediv id='name'>
	<refname>bf_compact</refname>
	<refpurpose>shell script to compact a <application>bogofilter</application> directory</refpurpose>
    </refnamediv>
    <refsynopsisdiv id='synopsis'>
	<cmdsynopsis>
	    <command>bf_compact</command>
	    <arg choice='plain'><replaceable>bogofilter_directory</replaceable></arg>
	    <arg rep='repeat' choice='opt'><replaceable>wordlist_name</replaceable></arg>
	</cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'><title>Description</title>
	<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:  <command>bf_compact</command> cannot be used to process the
	    current working directory, ".", because that cannot be
	    renamed.</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
	<replaceable>bogofilter_directory</replaceable> is the same as
	the configured, or use all *.db files if it is a different
	directory.</para></refsect1>
    <refsect1 id='exitstatus'><title>Exit Status</title>
	<para>The script exits with status code 0 if everything went
	    well, and nonzero if it encountered trouble.</para>
    </refsect1>
    <refsect1 id='notes'><title>Notes</title>
	<para>This script will delete
		<replaceable>bogofilter_directory</replaceable><filename>.old</filename>
	and all of its contents!</para>
	<para>This script expects a SUSv2 compliant shell.  Solaris
	    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>