<?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_tar.1'>
    <refmeta>
	<refentrytitle>bf_tar</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="manual">Bogofilter Reference Manual</refmiscinfo>
	<refmiscinfo class="source">Bogofilter</refmiscinfo>
    </refmeta>
    <refnamediv id='name'>
	<refname>bf_tar</refname>
	<refpurpose>shell script to write a tar file of a
	    <application>bogofilter</application> directory to stdout</refpurpose>
    </refnamediv>
    <refsynopsisdiv id='synopsis'>
	<cmdsynopsis>
	    <command>bf_tar</command>
	    <arg choice='opt'>-r</arg>
	    <arg choice='opt'>-R</arg>
	    <arg choice='plain'><replaceable>bogofilter_directory</replaceable></arg>
	</cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'><title>Description</title>
	<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>
    <refsect1 id='options'><title>Options</title>
	<para>The <option>-r</option> option causes <command>bf_tar</command> to remove
	    inactive log files after the archive has been written
	    successfully. The default is to leave log files.</para>
	<para>The <option>-R</option> option causes <command>bf_tar</command> to remove
	    inactive log files before the archive is written. This may
	    reduce chances that the resulting archive is recoverable
	    should it become damaged. The archive may be smaller
	    though. The default is to leave log files.</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='examples'><title>Examples</title>
	<itemizedlist>
	    <listitem>
		<para><userinput>bf_tar ~/.bogofilter &gt; outfile.tar</userinput></para>
		<para>Writes a standard .tar file containing the essential files
		from <filename>~/.bogofilter</filename> to
		<filename>outfile.tar</filename>.</para>
	    </listitem>
	    <listitem>
		<para><userinput>bf_tar ~/.bogofilter | gzip -9 -c &gt;
		outfile.tar.gz</userinput></para>
		<para>Writes a gzipped .tar.gz file containing the essential files
		from <filename>~/.bogofilter</filename> to
		<filename>outfile.tar.gz</filename>.</para>
	    </listitem>
	    <listitem>
		<para><userinput>bf_tar `pwd`/mydirectory
		&gt; outfile.tar</userinput></para>
		<para>Prepend <userinput>$(pwd)/</userinput> or
		<userinput>`pwd`/</userinput> if you want to specify an
		absolute path instead of a relative path.</para>
	    </listitem>
	</itemizedlist>
    </refsect1>
    <refsect1 id='notes'><title>Notes</title>
	<para>This script is meant for use with Berkeley DB based
	    <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 <application>bogofilter</application> is configured)
	    so that <filename>/usr/xpg4/bin/sh</filename> can be used.</para>
    </refsect1>
    <refsect1 id="authors"><title>Authors</title>
	<para><author><firstname>Matthias</firstname><surname>Andree</surname></author></para>
    </refsect1>
</refentry>
