projects / elisp / wanderlust.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Define unmark functions for temporary marks.
[elisp/wanderlust.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 256789c..6728742 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,42 +5,60 @@
                                        Yuuichi Teranishi,
                                        Tsunehiko Baba
 
                                        Yuuichi Teranishi,
                                        Tsunehiko Baba
 
-Select MIME Module
-==================
+System Requirements
+===================
+
+  Wanderlust supports following Emacsen:
+
+       Mule 2.3 based on Emacs 19.34
+       Emacs 20.1 or later
+       XEmacs 20.4 or later
+
+  Before installing Wanderlust, please install the following MIME
+  modules.
 
 
-  Before installing Wanderlust, please install the following MIME modules. 
+       SEMI    (1.14.6 or later)
+       FLIM    (1.14.9 or later)
 
 
-       SEMI    (1.14.1 or later)
+  Wanderlust and MIME modules require APEL.  Before installing MIME
+  modules, please install the APEL.
 
 
-  SEMI requires APEL and FLIM packages.  For each Emacsen, Recommended
-  combination of MIME module package following.
+       APEL    (10.6 or later)
 
 
-(a) XEmacs 21.1 or later
 
 
-       APEL 10.3, FLIM 1.14.3, SEMI 1.14.3
+Select MIME Module
+==================
+
+  For each Emacsen, Recommended combination of MIME module package
+  follows.
 
 
-  Installation as a XEmacs package, If possible.
+  (a) XEmacs 21.1 or later
 
 
-(b) Emacs 20.4 or later
+       APEL 10.7, FLIM 1.14.9, SEMI 1.14.6
 
 
-       APEL 10.3, FLIM 1.14.3, SEMI 1.14.3
+    Installation as a XEmacs package, If possible.
 
 
-(c) Emacs 20.1 to 20.3
+  (b) Emacs 20.4 or later
 
 
-       APEL 10.3, CLIME 1.14.0, SEMI 1.14.3
+       APEL 10.7, FLIM 1.14.9, SEMI 1.14.6
 
 
-  Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
-  earlier.
+ (c) Emacs 20.1 to 20.3
 
 
-(d) Emacs 19.34 (Mule 2.3)
+       APEL 10.7, CLIME 1.14.6, SEMI 1.14.6
 
 
-       APEL 10.3, CLIME 1.14.0, SEMI 1.14.3
+    Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
+    earlier.
 
 
-  Mule based on Emacs 19.34 can also run SEMI.  See the following web
-  page to get more information (in Japanese).
+  (d) Emacs 19.34 (Mule 2.3)
+
+       APEL 10.7, CLIME 1.14.6, SEMI 1.14.6
+
+    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
 
 
        http://www.jpl.org/elips/INSTALL-SEMI-ja.html
 
+
 Install MIME Module
 ===================
 
 Install MIME Module
 ===================
 
@@ -48,7 +66,7 @@ Install MIME Module
 
        APEL:   ftp://ftp.m17n.org/pub/mule/apel/
        FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
 
        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/
 
   Please install APEL, FLIM(CLIME), and SEMI, in that order.  Generally,
        SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
 
   Please install APEL, FLIM(CLIME), and SEMI, in that order.  Generally,
@@ -59,14 +77,31 @@ Install MIME Module
   latest versions should work.  For example, the following combinations
   are confirmed to work:
 
   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
+       APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
+       APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
+
+  You have to re-install Wanderlust if you upgraded APEL, FLIM, or SEMI.
+
+
+Check Environment
+=================
+
+  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
 ============
 
 
 
 Installation
 ============
 
-(a) Edit Makefile
+(a) Edit Makefile, WL-CFG
 
   Edit EMACS, LISPDIR, and so on in Makefile.
 
 
   Edit EMACS, LISPDIR, and so on in Makefile.
 
@@ -76,6 +111,8 @@ Installation
   If LISPDIR is not specified (or NONE by default), it is automatically
   detected.
 
   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.
 (b) Bytecompile and Install
 
   Please do following.
@@ -83,8 +120,8 @@ Installation
        % make
        % make install
 
        % 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
 
 
        Cannot open load file: mime-setup
 
@@ -100,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.
 
   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.
 
 
   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
 
@@ -110,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.
 
   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.
 (b) Bytecompile and Install
 
   Please do following.
@@ -137,9 +176,6 @@ load-path
      '("apel" "flim" "semi" "wl"))
   --------------------------------------------------------------------
 
      '("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
 ======
 
 Manual
 ======
@@ -161,9 +197,9 @@ Sample configuration file
 
   Wanderlust requires the following three configuration files:
 
 
   Wanderlust requires the following three configuration files:
 
-       ~/.addresses    Address Book
-       ~/.folders      Folder Book
        ~/.wl           Wanderlust Configuration (loaded at startup)
        ~/.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.
 
   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
   samples/en/ directory. Please refer to them.