Import imapsplit-1.0RC1
[imapsplit.git] / INSTALL
blob70caf0e6db3919a43a66947b833428683ed3f47e
1 Installation and configuration instructions for imapsplit
2 =========================================================
4 1. Requirements
5   - Python (http://python.org/), tested with version 2.4.1, may work
6     with earlier versions, please send success (or fail) reports to
7     the mailing list (see below) or some of the authors (see the
8     AUTHORS file)
10 2. Installation and configuration
11   - Extract the tarball:
13     # tar xzvf imapsplit-<version>.tar.gz
15     This will create subdirectory imapsplit-<version>/
17   - Copy imapsplit.py to location you want it to be.
19   - Ensure that you have you HOME envirenment variable set ('must be'
20     in unices I've seen). Create .imapsplit directory within your home
21     directory. Copy config.py file to the ~/.imapsplit directory.
23   - Edit the ~/.imapsplit/config.py to configure your imap host(s) and
24     rules for it. See the instructions in the provided config.py for
25     details about writting configuration.
26   - [Optional] Example line in crontab, with redirecting stdout to log:
28     * * * * * (echo ================== && /bin/date && /home/nedko/bin/imapsplit.py) >> /home/nedko/.imapsplit/imapsplitlog
30 3. Reporting problems and talking to other imapsplit users
31   - There is a mailing list imapsplit-misc@lists.sourceforge.net
32     You need to subscribe in order to send mails to the mailing
33     list. You can use this web page:
34     http://lists.sourceforge.net/lists/listinfo/imapsplit-misc
35     to subscribe.
36   - Try to contact one of the authors (see the AUTHORS file)