INSTALL instructions for email2sms, written by Adam Spiers <adam@spiers.net>
==============================================================================

Prerequisites
-------------

- Ensure you have Perl 5.004 or greater, on a UNIX box of some sort.

- Ensure you have the following CPAN modules installed:

    o MIME-tools
    o Lingua::EN::Squeeze

  The easiest way to install them (or to check whether they're
  installed) is to su to root and do:

    # perl -MCPAN -e shell

  Follow the instructions if you've never done this before.
  When you get to the cpan> prompt, do:

    cpan> install MIME::Entity
    cpan> install Lingua::EN::Squeeze

  This will install them.

  (You can try a

    $ perldoc CPAN

  if you get stuck with the CPAN module.)

- The current version of Lingua::EN::Squeeze seems to have some
  problems with the SelfLoader module it uses, causing 'Prototype
  mismatch' errors.  I'm not sure yet whether this is a fault with
  Squeeze, SelfLoader, or Perl itself (I've contacted the author of
  Squeeze).  If you encounter these problems, try the supplied patch
  to Squeeze.pm by changing to the directory containing the module
  (try a 'find /usr/lib/perl5 -name Lingua -type d' if you can't find
  it) and then do:

    $ patch < Lingua.patch


Installation
------------

- Copy the email2sms Perl script to somewhere on your $PATH.

- Type 'rehash' if your shell is one of the ones which caches all
  executables (tcsh and zsh spring to mind).

- Copy the sample config file sample.email2smsrc to ~/.email2smsrc (or
  to somewhere else if you want).

- Edit the config file (it's fully commented and should all be very
  obvious).

- Put something like this in a sensible place in your ~/.procmailrc:

    :0 c
    | email2sms | send_SMS

  where send_SMS is a program which sends anything it receives on
  STDIN to your phone.  See sample.send_SMS for an example script
  which sends a message via a typical WWW -> SMS gateway.

  (N.B. If you write any new 'plugins' similar to this which send the
  message provided in STDIN to a phone, please send them to me so that
  I can include them in the distribution.)

That's all, folks!