aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorPaul Rodger <paul@paulrodger.com>2002-04-26 03:04:02 +0000
committerPaul Rodger <paul@paulrodger.com>2002-04-26 03:04:02 +0000
commit9736dff04db7f5a15390b5133d83b00cd3ab4d4e (patch)
tree3953c14a072d6f1a238fe304db27dbef46a7eb7f /README
parentf1f2b97b1b6a5cb6a354104eb8a4eaf5c631ab16 (diff)
downloadarchivemail-9736dff04db7f5a15390b5133d83b00cd3ab4d4e.tar.gz
archivemail-9736dff04db7f5a15390b5133d83b00cd3ab4d4e.tar.bz2
archivemail-9736dff04db7f5a15390b5133d83b00cd3ab4d4e.zip
Fixed bugs where archivemail would refuse to work on python version less than
2.2.
Diffstat (limited to 'README')
-rw-r--r--README61
1 files changed, 45 insertions, 16 deletions
diff --git a/README b/README
index 8506f62..5c70188 100644
--- a/README
+++ b/README
@@ -3,13 +3,7 @@
archivemail - archive and compress old mail in your mailbox
-----------------------------------------------------------
-INSTALLATION:
-
-To install archivemail, run:
- python setup.py install
-
-
-USE:
+OVERVIEW:
archivemail is a tool written in python(1) for archiving and compressing old
email in mailboxes.
@@ -25,19 +19,54 @@ just the most recent messages.
'archivemail' can save a lot of disk space and will significantly reduce
overhead on your mail reader. The number of days before mail is considered
-'old' is up to you, but the default is 180 days.
+'old' is up to you, but the default is 180 days. You can also archive messages
+by an absolute date or only archive unread messages.
-For more detailed information, look at the archivemail man page.
-'archivemail' currently works on mbox, maildir and MH format mailboxes
-and requires python v2.0 or greater. It also supports deleting old mail
-instead of archiving it with the '--delete' option.
+REQUIREMENTS:
+
+archivemail requires python version 2.0 or later, with the optional 'zlib'
+module, although the zlib module comes with most python installations. If you
+are compiling your own version of python < version 2.2, make sure you
+uncomment the 'zlib' moduile in Modules/Setup in the python source directory.
+
+You can check to see if you version of python has the 'zlib' module by
+trying this:
+
+ flare:~$ python
+ Python 2.1 (#1, Apr 26 2002, 11:22:45)
+ [GCC 2.95.2 20000220 (Debian GNU/Linux)] on linux2
+ Type "copyright", "credits" or "license" for more information.
+ >>> import zlib
+ >>>
+
+If you get an ImportError, then the zlib python module has not been installed.
+Try upgrading your python distribution.
+
+Python is available from http://www.python.org/
-The best way to run archivemail is from cron. Giving the '-q' option to
-archivemail will make it quiet, only printing messages if something went
-wrong. Check out the 'examples' directory for an example shell script to
-be run from cron.
+If you want to run the bundled test script, you will need python version 2.1
+or later, because we use the PyUnit 'unittest' module. Sorry.
+
+
+INSTALLATION:
+
+To install archivemail, run:
+ python setup.py install
+
+
+USE:
+
+For more detailed information, look at the archivemail man page.
+
+The best way to run archivemail is from cron, giving the '-q' option to
+archivemail to make it quiet, only printing messages if something went wrong.
+Check out the 'examples' directory for an example shell script to be run from
+cron.
The archivemail website is at: http://archivemail.sourceforge.net/
+If you have any feedback or bug reports about archivemail, you are very
+welcome to email me.
+
-- Paul Rodger <paul@paulrodger.com>