
README for the Public Version of stt2
-------------------------------------

stt2 was written by the RIPE NCC:

  Email:  ncc@ripe.net
  Web:    http://www.ripe.net

stt2 is a tool that uses templates to produce customised standard
emails. These templates may also contain Perl code to produce the
email text and perform other actions. The standard usage is to
produce a reply to the current message using the template specified.
For a description of the format of the templates see stt(5).

Stt2 uses and requires the MH email handler.

Instructions for Installing stt2
--------------------------------

The installation procedure for stt2 is the following:

1. Install the Required Modules

First of all you need to download and install the standard Perl
modules that stt2 uses. The easiest way to this is to download
them from CPAN by invoking the CPAN shell with the command:
     
    perl5 -MCPAN -e shell
    
These are the prerequisite modules:

    Getopt::Long
    Sys::Hostname
    Digest::MD5
    File::Basename
    File::Compare
    File::Copy
    Mail::Internet
    Mail::Address
    Mail::Util

Some of them should come with your Perl 5 distribution, like
Getopt::Long and File::Basename.

After installation of the CPAN modules, you need to install one extra
module, which is provided by us. It is PathUtils and it comes with
this distribution in the PathUtils-1.00.tar.gz file.

The PathUtils module is used to deal with different aspects of
directory paths, like getting the absolute path of a file, mounting
point of the local file system and so on. Unfortunately, it uses
several low-level C API functions calls, so it is OS dependent. We
have tested it on BSD/OS 3.1 and 4.1 but it may not work on your OS.
We welcome patches for other OSes.

The PathUtils module has a standard Perl module wrapper, so it can be
installed with the normal:

    perl5 Makefile.PL
    make
    make install

sequence.

2. Install the Program.

You probably need to set the location of your Perl5 interpreter in
the first line of the stt2 script. This is often /usr/bin/perl or 
/usr/local/bin/perl.

To install the stt2 executable and all supporting files under /usr/local/,
become a superuser in your system and enter:
    
    make install
    
That will copy the stt2 executable into /usr/local/bin/, the manual
pages into the man1 and man5 subdirectories under /usr/local/man/
and the configuration file stt.conf into /etc/ .
    
If you'd like to change the installation prefix you can do that by
editing the supplied Makefile ( you may also have to change the stt2
source as it looks for /etc/stt.conf ).

Example
-------

An example template is provided, example.stt and can be run by:

  stt2 example

It will use the current MHmessage.

Run-time help
-------------

The command-line options can be obtained by calling the program 
with no arguments.

Feedback
--------

Please send bug-reports and any other feedback to:

Maldwyn Morris
maldwyn@ripe.net
Software Manager
RIPE NCC


