# $Id: INSTALL,v 1.13 2008/03/19 00:28:36 gilles Exp gilles $
# 
# INSTALL file for imapsync 
# imapsync : IMAP sync or copy tool.

GETTING
-------

http://www.linux-france.org/prj/imapsync/dist/

PREREQUISITES
-------------

You need : 
- Perl 
  try : perl -v

  Get Perl here:
  http://www.perl.org/

- Some perl modules. To verify you have
  all modules in one command, just run:

  perl -c imapsync

  The good answer is "imapsync syntax OK".

Here is some individual module help:

- Perl Mail::IMAPClient module 
  try : 

  perl -mMail::IMAPClient -e ''
  
  Get the Mail::IMAPClient module here:
  http://search.cpan.org/
  http://search.cpan.org/~djkernen/
  http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/
  
  In fact I use Mail-IMAPClient-2.2.9 (debian package)
  To know the version you have on your system try :

  perl -mMail::IMAPClient -e 'print $Mail::IMAPClient::VERSION, "\n"'

  New Mail-IMAPClient-3.xx doesn't work with imapsync for the moment.

- Perl Digest::MD5 module. 
  http://search.cpan.org/
  http://search.cpan.org/~gaas/Digest-MD5-2.36/
  To know the version you have on your system try :
  perl -mDigest::MD5 -e 'print $Digest::MD5::VERSION, "\n"'
  I use 2.36 (debian etch package)

- Term::ReadKey
  perl -mTerm::ReadKey -e ''

- IO:Socket:SSL.pm
  perl -mIO::Socket::SSL -e ''

- Date::Manip
  perl -mDate::Manip -e ''

- (Option) Perl Digest::HMAC_MD5 module
  Good for non plain text password over network.


INSTALLING
----------
To see what will be done, just run:

make -n install

To install imapsync, just run:

make install

or copy the file imapsync where you want it to be.

WINDOWS
-------

- Install Perl if it isn't already installed.
  ActivePerl from ActiveState is a good candidate if
  you understand nothing at free/open software
  and want to run imapsync with success.
- Use PPM to install modules listed in the PREREQUISITES section.
  PPM is Perl Package Manager.

TESTING
-------

The test will break as they are home specific.
You need a running imap server on localhost with two accounts
toto@est.belle with a password located in the file /var/tmp/secret1
titi@est.belle with a password located in the file /var/tmp/secret2

Of course, you can change the file tests.sh and run the tests with :

sh -x tests.sh

The tests.sh script break on first failure ("set -e" directive).

Since I added more tests you also need a remote imap server see the
file tests.sh and help yourself. No time to make a universal test
file.