INSTALL ezmlmx
==============

Requirements and Assumptions
----------------------------

1. Requirement: fehQlibs (>= 27) installed
   (typically at /usr/local) and symlinked to qlibs.

2. Requirement: s/qmail, qmail, or notqmail are 
   installed. None-qmail forks need to preserve 
   qmail's API.

3. Assumption: The directory /package
   exists following the slashpackage convention.


Basic Installation
------------------

1. Untar ezmlmx-V.RR (R: Release, V: Version)
   under /package:
 
	$ tar -xzf path-to/ezmlmx-V.RR

2. Move to the generated directory

	$ cd /package/mail/ezmlm/ezmlm-V.RR

3. Adjust

- conf-home
- conf-qmail
- conf-man (if necessary) 
- conf-qlib (if necessary)

to your needs. Optional,

- conf-cc (compiler settings) and
- conf-ld (loader settings) 

need to be fine-tuned.

The other conf-* files will be discussed later.

4. Call

	$ package/install
  
The binaries and man files will be installed
given the location provided in conf-home.

This setup uses English language templates.


Localized Installation
----------------------

ezmlmx comes with language templates for

- ch_GB (Chinese)
- cs (Czech)
- da (Danish)
- de (German)
- en_US (US English)
- es (Estonia)
- fr (France)
- hu (Hungary)
- id (India) 
- it (Italian)
- ja (Japan)
- nl (Dutch)
- pl (Polish)
- pt (Portugese)
- pt_BR (Brasilian Portugese)
- ru (Russian)
- sv (Sverige)

They reside in the directory ./ezmlmrc and
are subject of personal adjustments.

If one of the language templates fits your
requirements, simply call

	$ package/control LANGUAGE

where LANGUAGE is the abbriviation of one 
of the exisiting templates shortcut names.

The resulting file ``ezmlmrc'' will be
copied to ezmlmx' home directory.


Database Setup
--------------

(tbd)


Testing
-------

Use ./compile/ezmlm-test in the installation
directory for testing ezmlmx. This script is 
'mangeled' and populated while invoking

	$ package/compile it-test

Several criteria have to be met for this to work:

0. You need to have qmail installed allowing mail delivery to
   "eztest@host" and subaddresses.

2. You need to have a user "eztest" or edit the script to change to a
   user that exists on your system.

3. You need to be that user when you invoke this script and the script
   needs to reside in the same dir as the binaries you want to test.

4. This user needs to have execute permission for the build dir

The script will use 

- ~eztest/__TSTDIR and 
- ~eztest/__TSTDIR__err 

and destroy any files therein. 

Both user name and directory names etc can be configured below, 
but this should only very rarely be necessary.

This program is experimental and not yet properly documented. Please
send comments to lindberg@id.wustl.edu. I'm attempting to make this a
rigorous test for future ezmlm+idx installations so that full function
can be verified when upgrading to a new version.


Setting up a cron job for digests
---------------------------------

One concept of ezmlm/ezmlmx is to provide a *digest* of the archived
mails and send those to users, having subscribed for digest reports.

It is task of ezmlm-cron to provide such a digest. In this case,
ezmlm-cron needs to called by the cron facility. In order to support
its invocation, the file

- ezcronrc
  is generated upon call of ezmlm-cron 
 
This file now includes instructions to raise digest reports
for particular mailing lists in the given interval. 


Setting up a mailing list archive
---------------------------------

Typicall, on call of ezmlm-make, automatically a mailing
list archive is set up; check man ezmlm-make(3) for options.

Responsible for creating an *index* for this archive is 
ezmlm-idx to be called for the list just once.
Rather, the maintenance and update of this index is 
achived via ezmlm-archive.

The call to this module needs to be provissioned into
the file

- list/editor
  where list is the name your your mailing list upon 
  generation by ezmlm-make. Typically:

   |/usr/local/bin/ezmlm/ezmlm-archive '/var/qmail/alias/list' || exit 0

Now, all incoming new mailings to this list will be 
indexed and potentially made accessible via HTTP(S) and
ezmlm-cgi.