Installing TWC Weather 
======================

Quick Start
===========
Installing twc_weather is failry straightforward:

  -- untar the tarball into the SM plugins directory, 
  -- modify it's configuration file to suit your needs,
  -- activate the plugin within SM.  

Users can then go to Options and click on the TWC Weather link 
to add weather locations of interest.


Detailed Install 
================
The instructions below assume you are relatively familiar with working from 
a Un*x shell and have some concept of how to operate a text editor (e.g. vi). 
It's also assumed that you have the appropriate file permissions to modify 
your squirrelmail and plugins directories.

You can either perform a fresh install or upgrade.  The only real 
difference in steps is whether or not you choose to maintain your 
existing twc_weather configuration (assuming that you are upgrading) .


Fresh Install
==============

Simply untar the file into the plugins directory making sure it is
in its own directory, and that the name of the directory is twc_weather.

The example below assumes you are at a shell prompt
starting in the Squirrel Mail install directory and the twc_weather
tarball is in /tmp and it's named twc_weather.tar.gz: 

  $ cd plugins
  $ tar -zxvf /tmp/twc_weather.tar.gz

Starting with twc_weather 1.3 beta 4 and higher twc_weather's config
file (config.php) will not be directly provided.  It has been renamed
config.php.sample. 

At this point copy this config.php.sample file to config.php:

  $ cd twc_weather
  $ cp config.php.sample config.php

Using your favorite text editor (e.g. vi) edit the config.php file
to your liking (from the twc_weather directory):

  $ vi config.php

Then go to your Squirrel Mail config directory and run conf.pl.  Choose option
8 and add the twc_weather plugin:

  $ cd ../../config
  $ ./conf.pl

Assuming you figured out how to Save and Exit the SM config script, twc_weather
should now be activiated.  

Open an SM mailbox with your favorite web browser and log in. 
Next, navigate to Options and then look for the TWC Weather option--enjoy!!!



Upgrading TWC Weather
=========================

If you already have a working previous twc_weather release and would
like to maintain your configuration settings (in config.php):

Start with untaring the new tarball into the plugins directory.

The example below assumes you are at a shell prompt
starting in the Squirrel Mail install directory and the twc_weather
tarball is in /tmp and it's named twc_weather.tar.gz:

  $ cd plugins
  $ tar -zxvf /tmp/twc_weather.tar.gz

Change into the twc_weather directory and check your config.php
file against the new version to see if there are any new
settings that you must add to your config.php file.

  $ cd twc_weather
  $ diff -Nau config.php config.php.sample

Or if it looks too complicated simply replace your config.php file with the 
config.php.sample provided and reconfigure the plugin.

  $ mv -f config.php config.php.old
  $ cp -f config.php.sample config.php
  $ vi config.php 

Once you've made your changes the new twc_weather upgrade is complete.  Either
refresh any open SM client connections or log in to a new session.

Enjoy!


PLEASE NOTE:
============
If you turned on weather_proxy_icons in config.php be sure that your
PHP has GD enabled with atleast GIF read and PNG write enabled.

If you seem to have issues right from the start (i.e. you're a new user or
figure that you've probably mangled twc_weather's config.php)
try deleting config.php from the twc_weather directory and just run with the
included config.php.sample (there is code that will try to use the sample 
file if the regular config.php is missing).


###
