X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=INSTALL;h=67287429dafe370d550ed90d6a15ba399b0cca15;hb=3a60c8832bbffb3d8bd9f9c691e5411b8e20bc21;hp=9ead24b29e08bd1f924f3392fb11dc8a447c5943;hpb=dc5f020fc1f620e945327aa0413bd25f2f2d2d26;p=elisp%2Fwanderlust.git

diff --git a/INSTALL b/INSTALL
index 9ead24b..6728742 100644
--- a/INSTALL
+++ b/INSTALL
@@ -5,84 +5,103 @@
 					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.6 or later)
+	FLIM	(1.14.9 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.6 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.7, FLIM 1.14.9, SEMI 1.14.6
 
-  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.7, FLIM 1.14.9, SEMI 1.14.6
+
+ (c) Emacs 20.1 to 20.3
+
+	APEL 10.7, CLIME 1.14.6, SEMI 1.14.6
+
+    Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
+    earlier.
 
-	APEL:     ftp://ftp.m17n.org/mule/apel/
-	FLIM:     ftp://ftp.m17n.org/mule/flim/
-	SEMI:     ftp://ftp.m17n.org/mule/semi/
+  (d) Emacs 19.34 (Mule 2.3)
 
-  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.
+	APEL 10.7, CLIME 1.14.6, SEMI 1.14.6
 
-  You can also use many other FLIM/SEMI variants.
-  Combination of the latest versions should work.
-  For example, following combination is confirmed to work.
+    Mule based on Emacs 19.34 can also run SEMI.  See the following web
+    page to get more information (in Japanese).
 
-	APEL 10.2, Chao 1.14.1 and REMI 1.14.1
+	http://www.jpl.org/elips/INSTALL-SEMI-ja.html
+
+
+Install MIME Module
+===================
+
+  You can download these packages from following URLs.
 
-(b) tm
+	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/
 
-  The tm, whose version is 8.7 or later, is recommended.  Please
-  obtain from the following web site.
+  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.
 
-	http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
+  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:
 
-  To get full information, please refer README.en within package.
+	APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
+	APEL 10.6, 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.
+Check Environment
+=================
 
-	APEL:     ftp://ftp.m17n.org/mule/apel/
+  Before going to the next step, we recommend you to run tests by
+
+	% make check
+  or
+	% make EMACS=xemacs check
+
+  to check running environment including the version of APEL, FLIM, and
+  SEMI.  Note that even if you have installed new APEL/FLIM/SEMI, old
+  ones in load-path may cause trouble.  To find duplicated files in the
+  load-path, M-x list-load-path-shadows will help you.
 
 
 Installation
 ============
 
-(a) Edit Makefile
+(a) Edit Makefile, WL-CFG
 
   Edit EMACS, LISPDIR, and so on in Makefile.
 
@@ -92,6 +111,8 @@ Installation
   If LISPDIR is not specified (or NONE by default), it is automatically
   detected.
 
+  Edit WL-CFG if you need. You can specify language for INFO, etc.
+
 (b) Bytecompile and Install
 
   Please do following.
@@ -99,8 +120,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
 
@@ -116,7 +137,7 @@ Install as a XEmacs package
   packages.  After installation as a XEmacs package, you do not need
   configurations of autoload, icon path in your own .emacs file.
 
-(a) Edit Makefile
+(a) Edit Makefile, WL-CFG
 
   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
 
@@ -126,6 +147,8 @@ Install as a XEmacs package
   If PACKAGEDIR is not specified (NONE by default) and the SEMI
   modules have been installed, it is automatically detected.
 
+  Edit WL-CFG if you need. You can specify language for INFO, etc.
+
 (b) Bytecompile and Install
 
   Please do following.
@@ -139,10 +162,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
@@ -153,9 +176,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
 ======
@@ -175,13 +195,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: