# README for aliases2cdbm
# created 1999-Feb-13 05:34 jmk
# autodate: 2000-Jan-09 05:16

DESCRIPTION

`Aliases2cdbm' is a utility for converting mail aliases from a text
file (e.g., /etc/aliases) into input suitable for the `cdbmake'
utility.  Cdbmake can then create a constant database (CDB) suitable
for reliable, high-speed mail alias lookups (see
<ftp://koobera.math.uic.edu/www/cdb.html> for more information about
D.J. Bernstein's cdb package, which includes cdbmake).

See the included manual page for a description of the syntax of the
aliases file that aliases2cdbm understands.

Note that i designed aliases2cdbm for use with the `exim' MTA (mail
transport agent) version 2.x or later, by Philip Hazel
<http://www.exim.org/>.  In particular, aliases2cdbm parses the aliases
file format described in exim's specification document, with a few
additions gleaned from inspecting exim's source code.  Aliases2cdbm may
well not parse aliases files that work with other MTAs.  Your mileage
may vary.

INSTALLING

Installation should be relatively straightforward:

  (0) Inspect the Makefile to ensure that things will work for your
      system.  In particular, pay attention to the following settings:
      
        PREFIX
        ETCDIR
        INSTALL_BIN
        INSTALL_MAN
        INSTALL_SCRIPT
        INSTALL_DATA
        MKDIRS
        CC
        OPTFLAGS
        WARNFLAGS

  (1) Build aliases2cdbm and The Fine Manual page:
  
        make

  (2) Test aliases2cdbm on the included sample aliases files:
  
        ./aliases2cdbm ./aliases.sample
        ./aliases2cdbm ./aliases.warnings

      The first file should generate valid cdbmake input.  The second
      should generate some valid cdbmake input and several warnings.

  (3) Install aliases2cdbm and The Fine Manual page:
  
        make install

  (4) Optionally, install the exim.newaliases.cdb script and config
      file:

        make extra
        make install-extra
        
      Then add the following line to your exim.conf:
      
        bi_command = /usr/local/sbin/exim.newaliases.cdb

      Now `exim -bi' turns your /etc/aliases file into
      /etc/aliases.cdb.

  (5) There you are.

If you have RPM <http://www.rpm.org/> installed on your system, you can
build source and binary RPM packages directly from the aliases2cdbm
tarball using the included spec file:

        rpm -ta --clean aliases2cdbm-<version>.tar.gz

LICENSE

Aliases2cdbm is Copyright © 1999-2000 by Jim Knoble <jmknoble@pobox.com>.

Aliases2cdbm is open source software and is licensed under version 2 of
the GNU General Public License (GPL) <ftp://ftp.gnu.org/gnu/COPYING-2.0>,
or, at your option, any later version <ftp://ftp.gnu.org/gnu/COPYING>.
For more information about open source software, please see the Open
Source Initiative's website <http://www.opensource.org/>.

DISCLAIMER

The software is provided "as is", without warranty of any kind, express
or implied, including but not limited to the warranties of
merchantability, fitness for a particular purpose and noninfringement. In
no event shall the author(s) be liable for any claim, damages or other
liability, whether in an action of contract, tort or otherwise, arising
from, out of or in connection with the software or the use or other
dealings in the software.  Eat your vegetables.

-- 
jim knoble
jmknoble@pobox.com