Merge from trunk

[elisp/wanderlust.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index fd8539f..d19d9eb 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,51 +5,58 @@
                                        Yuuichi Teranishi,
                                        Tsunehiko Baba
 
-Select MIME Module
-==================
+System Requirements
+===================
 
-  Before installing Wanderlust, please install either of the following
-  MIME modules. SEMI is recommended because it's more functional.
+  Wanderlust supports following Emacsen:
 
-       SEMI    (1.14.1 or later)
-       tm      (8.7 or later)
+       Mule 2.3 based on Emacs 19.34
+       Emacs 20.1 or later
+       XEmacs 20.4 or later
 
-  SEMI requires APEL and FLIM packages.  For each Emacsen, Recommended
-  combination of MIME module package following.
+  Before installing Wanderlust, please install the following MIME
+  modules.
 
-(a) XEmacs 21.1 or later
+       SEMI    (1.14.3 or later)
+       FLIM    (1.14.3 or later)
 
-       APEL 10.3, FLIM 1.14.3, SEMI 1.14.3
+  Wanderlust and MIME modules require APEL.  Before installing MIME
+  modules, please install the APEL.
 
-  Installation as a XEmacs package, If possible.
+       APEL    (10.3 or later)
 
-(b) Emacs 20.4 or later
 
-       APEL 10.3, FLIM 1.14.3, SEMI 1.14.3
+Select MIME Module
+==================
 
-(c) Emacs 20.1 to 20.3
+  For each Emacsen, Recommended combination of MIME module package
+  follows.
 
-       APEL 10.3, CLIME 1.14.0, SEMI 1.14.3
+  (a) XEmacs 21.1 or later
 
-  Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
-  earlier.
+       APEL 10.4, FLIM 1.14.5, SEMI 1.14.5
 
-(d) Emacs 19.34 (Mule 2.3)
+    Installation as a XEmacs package, If possible.
 
-       APEL 10.3, CLIME 1.14.0, SEMI 1.14.3
+  (b) Emacs 20.4 or later
 
-  Mule based on Emacs 19.34 can also run SEMI.  See the following web
-  page to get more information (in Japanese).
+       APEL 10.4, FLIM 1.14.5, SEMI 1.14.5
 
-       http://www.jpl.org/elips/INSTALL-SEMI-ja.html
+ (c) Emacs 20.1 to 20.3
+
+       APEL 10.4, CLIME 1.14.5, SEMI 1.14.5
 
-(e) Emacs 19.28 or earlier (Mule 2.3, Nemacs)
+    Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
+    earlier.
 
-       APEL 10.3, CLIME 1.14.0, tm 8.8
+  (d) Emacs 19.34 (Mule 2.3)
 
-  If you use Mule based on Emacs 19.28 or earlier, please install tm.
-  SEMI does not support Emacs 19.28 or earlier.  You need upgrade APEL
-  and CLIME.
+       APEL 10.4, CLIME 1.14.5, SEMI 1.14.5
+
+    Mule based on Emacs 19.34 can also run SEMI.  See the following web
+    page to get more information (in Japanese).
+
+       http://www.jpl.org/elips/INSTALL-SEMI-ja.html
 
 
 Install MIME Module
@@ -59,11 +66,8 @@ Install MIME Module
 
        APEL:   ftp://ftp.m17n.org/pub/mule/apel/
        FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
-       CLIME:
+       CLIME:  ftp://ftp.jpl.org/pub/m17n/
        SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
-       tm:     http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
-
-(a) SEMI
 
   Please install APEL, FLIM(CLIME), and SEMI, in that order.  Generally,
   'make install' will do the job.  To get full information, please refer
@@ -73,20 +77,16 @@ Install MIME Module
   latest versions should work.  For example, the following combinations
   are confirmed to work:
 
-       APEL 10.2, Chao 1.14.1, REMI 1.14.2
-       APEL 10.2, SLIM 1.14.3, EMY 1.13.9
-
-(b) tm
-
-  The tm, whose version is 8.7 or later, is recommended.  To get full
-  information, please refer README.en within package.
+       APEL 10.4, SLIM 1.14.9, SEMI 1.14.5
+       APEL 10.4, CLIME 1.14.5, EMIKO 1.14.1
 
-  tm-8.8 or earlier makes following error while compiling Wanderlust.
+  You have to re-install Wanderlust if you upgraded APEL, FLIM, or SEMI.
 
-       Use tm-8.x with APEL 10.2 or later.
-
-  In this case, please install APEL 10.2 or later.
+  Do following, running environment test included APEL, FLIM, and SEMI
+  version check.  You can specify the emacs command name.
 
+       % make check
+       % make EMACS=xemacs check
 
 Installation
 ============
@@ -108,8 +108,8 @@ Installation
        % make
        % make install
 
-  If you use Emacs without subdirs.el (e.g. Mule 2.3 based on Emacs
-  19.28), the following error message ocasinally appears.
+  If you use Emacs without subdirs.el, the following error message
+  occasionally appears.
 
        Cannot open load file: mime-setup
 
@@ -162,9 +162,6 @@ load-path
      '("apel" "flim" "semi" "wl"))
   --------------------------------------------------------------------
 
-  If you are using Emacs 19.28 or earlier, you can't use subdirs.el.
-  Please write setting about load-path in site configuration file.
-
 
 Manual
 ======
@@ -186,9 +183,9 @@ Sample configuration file
 
   Wanderlust requires the following three configuration files:
 
-       ~/.addresses    Address Book
-       ~/.folders      Folder Book
        ~/.wl           Wanderlust Configuration (loaded at startup)
+       ~/.folders      Folder Book
+       ~/.addresses    Address Book (optional)
 
   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
   samples/en/ directory. Please refer to them.