2002-12-31 Ron Isaacson <Ron.Isaacson@morganstanley.com>
[elisp/wanderlust.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index b3c0e7d..d19d9eb 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,71 +5,88 @@
                                        Yuuichi Teranishi,
                                        Tsunehiko Baba
 
-Required environment
-====================
+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.13.4 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
 
-  If you use Mule based on Emacs 19.28 or earlier, please install tm.
-  SEMI does not support Emacs 19.28 or earlier.
+  Before installing Wanderlust, please install the following MIME
+  modules.
 
-  SEMI only supports relatively new Emacsen like Emacs 20.xx, XEmacs, etc.
-  But Mule based on Emacs 19.34 can also run SEMI.
-  See the following web page to get more information (written by Japanese).
+       SEMI    (1.14.3 or later)
+       FLIM    (1.14.3 or later)
 
-       http://www.jpl.org/elips/INSTALL-SEMI-ja.html
+  Wanderlust and MIME modules require APEL.  Before installing MIME
+  modules, please install the APEL.
 
+       APEL    (10.3 or later)
 
-(a) SEMI
 
-  SEMI requires APEL and FLIM packages.
-  Recommended combination of APEL, FLIM and SEMI are:
+Select MIME Module
+==================
 
-       APEL 10.2, FLIM 1.12.7 and SEMI 1.13.4
-         or
-       APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
+  For each Emacsen, Recommended combination of MIME module package
+  follows.
 
-  Combination of APEL 10.2 and FLIM 1.12.7 makes following error
-  while compiling FLIM 1.12.7.
+  (a) XEmacs 21.1 or later
 
-  'Please install latest APEL 7.3 or later.'
+       APEL 10.4, FLIM 1.14.5, SEMI 1.14.5
 
-  In this case, please comment out following lines in FLIM-CFG.
+    Installation as a XEmacs package, If possible.
 
-  (or (fboundp 'write-region-as-binary)
-      (error "Please install latest APEL 7.3 or later."))
-  (or (fboundp 'insert-file-contents-as-binary)
-     (error "Please install latest APEL 7.3 or later."))
+  (b) Emacs 20.4 or later
 
-  You can download these packages from following URLs.
+       APEL 10.4, FLIM 1.14.5, SEMI 1.14.5
+
+ (c) Emacs 20.1 to 20.3
 
-       APEL:     ftp://ftp.m17n.org/mule/apel/
-       FLIM:     ftp://ftp.m17n.org/mule/flim/
-       SEMI:     ftp://ftp.m17n.org/mule/semi/
+       APEL 10.4, CLIME 1.14.5, SEMI 1.14.5
 
-  Please install APEL, FLIM, SEMI in order.
-  Generally  'make install' will do the job.
-  To get full information, please refer README.en within each package.
+    Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
+    earlier.
 
-  You can also use many other FLIM/SEMI variants.
-  Combination of the latest versions should work.
-  For example, following combination is confirmed to work.
+  (d) Emacs 19.34 (Mule 2.3)
 
-       APEL 10.2, Chao 1.14.1 and REMI 1.14.1
+       APEL 10.4, CLIME 1.14.5, SEMI 1.14.5
 
-(b) tm
+    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
+===================
+
+  You can download these packages from following URLs.
 
-  The tm, whose version is 8.7 or later, is recommended.  Please
-  obtain from the following web site.
+       APEL:   ftp://ftp.m17n.org/pub/mule/apel/
+       FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
+       CLIME:  ftp://ftp.jpl.org/pub/m17n/
+       SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
 
-       http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
+  Please install APEL, FLIM(CLIME), and SEMI, in that order.  Generally,
+  'make install' will do the job.  To get full information, please refer
+  to the README.en within each package.
 
-  To get full information, please refer README.en within package.
+  You can also use many other FLIM/SEMI variants.  Combination of the
+  latest versions should work.  For example, the following combinations
+  are confirmed to work:
 
+       APEL 10.4, SLIM 1.14.9, SEMI 1.14.5
+       APEL 10.4, CLIME 1.14.5, EMIKO 1.14.1
+
+  You have to re-install Wanderlust if you upgraded APEL, FLIM, or SEMI.
+
+  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
 ============
@@ -91,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
 
@@ -131,10 +148,10 @@ Install as a XEmacs package
 load-path
 =========
 
-  If you are using Emacs 20.3 or later, or XEmacs, there are no need
-  of setting about load-path.
+  If you are using Emacs 20.3 or later, or XEmacs, there is no need
+  to set load-path.
 
-  If you are using Emacs 20.2 or earlier, please add directory of
+  If you are using Emacs 20.2 or earlier, please add the directory of
   Wanderlust to load-path.
 
   If you install by default setting, with Emacs 19.29 or later, Emacs
@@ -145,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 you write setting about load-path in site configuration file.
-
 
 Manual
 ======
@@ -167,13 +181,18 @@ Manual
 Sample configuration file
 =========================
 
-  Wanderlust requires following three configuration files.
+  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 them.
+  samples/en/ directory. Please refer to them.
 
   To get full information, please read Info file.
+
+
+Local Variables: 
+fill-column: 72
+End: