Doc fixes.
[elisp/wanderlust.git] / README
1
2  Wanderlust -- Yet Another Message Interface on Emacsen
3                       by Yuuichi Teranishi <teranisi@gohome.org>
4
5
6 Wanderlust is a mail/news management system with IMAP4rev1 support for Emacs.
7
8 Features:
9
10  * Implementation in elisp only.
11  * Support of IMAP4rev1 [1], NNTP [2], POP(POP3[3]/APOP), MH and Maildir.
12  * Integrated access to messages based on Folder Specifications like Mew[4].
13  * Key bindings and mark processing like Mew.
14  * Management of threads and unread messages.
15  * Folder mode to select and edit subscribed folders.
16  * Message cache, Disconnected Operation.
17  * MH-like Fcc (Fcc: %Backup is possible).
18  * Full support of MIME (by SEMI or tm[5]).
19  * Draft editing of mail and news as a same interface.
20  * Icon based interface for the list of Folder (XEmacs).
21  * Skip fetching of a large message part of MIME(IMAP4).
22  * Server side searching (IMAP4), internationalized searching is available.
23  * Virtual folder.
24  * Compressed folder.
25  * Automatic expiration of old messages.
26  * Automatic refiling.
27  * Draft templates.
28
29 System Requirements:
30
31  * Emacs19 or later.
32  * tm (version 8.7 or later) or SEMI (version 1.14.1 or later).
33  * APEL (version 10.2 or later)
34
35 Install:
36
37 See INSTALL to install.
38
39 Web Page:
40
41 Wanderlust Official web page is available at:
42
43 http://www.gohome.org/wl/.
44
45 You can get latest Wanderlust version from there.
46
47 Mailing List:
48
49 Wanderlust Mailing List <wl@lists.airs.net>
50
51 Via the Wanderlust ML, we discuss about Wanderlust, announce the latest
52 release.  In this list, Japanese is mainly used for discussion, but we
53 also welcome mails written in English.
54
55 To subscribe, send mail to wl-ctl@lists.airs.net, with '# guide' as
56 the message body.
57
58 CVS:
59
60   Development of Wanderlust uses CVS.  So latest developing version is
61   available at CVS.
62
63 (0) cvs login (first time only)
64
65     % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
66
67     CVS password: [CR] # NULL string
68
69 (1) checkout
70
71     % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout wanderlust
72
73   If you would like to join CVS based development, please send mail to
74
75         cvs@cvs.m17n.org
76
77   with your account name and your public key for ssh.  cvsroot is
78   :ext:cvs@cvs.m17n.org:/cvs/root.
79
80   If you cannot use ssh, please send UNIX /etc/passwd style crypted
81   password.  You can commit with the cvsroot
82   :pserver:<accountname>@cvs.m17n.org:/cvs/root.
83
84   We hope you will join the open development.
85
86 References:
87
88 [1] M. Crispin, "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 2060,
89     1996.
90 [2] B. Kantor and P. Lapsley, "Network News Transfer Protocol: A
91     Proposed Standard for the Stream-Based Transmission of News", RFC
92     977, 1986.
93 [3] J. Myers, M. Rose, "Post Office Protocol - Version 3", RFC 1929, 1996.
94 [4] "Mew -- Messaging in the Emacs World", 
95     (Copyright (C) 1994, 1995, 1996, 1997, 1998 Mew developing team.)
96     Available from http://www.mew.org/.
97 [5] "tm -- MIME package for GNU Emacs",
98     (Copyright (C) 1994, 1995, 1996 MORIOKA Tomohiko)
99     Latest tm package is available from 
100     ftp://ftp.jaist.ac.jp/pub/GNU/elisp/
101