New feature: toggle visibility of mime buttons.
[more-wl.git] / INSTALL
blob4c604a82d3a3a3cec9b467f8e8dafb82c7318ee9
2         How to install Wanderlust
4                                         Kaoru Takahashi,
5                                         Yuuichi Teranishi,
6                                         Tsunehiko Baba
8 System Requirements
9 ===================
11   Wanderlust supports following Emacsen:
13         Mule 2.3 based on Emacs 19.34
14         Emacs 20.1 or later
15         XEmacs 20.4 or later
17   Before installing Wanderlust, please install the following MIME
18   modules.
20         SEMI    (1.14.6 or later)
21         FLIM    (1.14.6 or later)
23   Wanderlust and MIME modules require APEL.  Before installing MIME
24   modules, please install the APEL.
26         APEL    (10.6 or later)
29 Select MIME Module
30 ==================
32   For each Emacsen, Recommended combination of MIME module package
33   follows.
35   (a) XEmacs 21.1 or later
37         APEL 10.7, FLIM 1.14.9, SEMI 1.14.6
39     Installation as a XEmacs package, If possible.
41   (b) Emacs 20.4 or later
43         APEL 10.7, FLIM 1.14.9, SEMI 1.14.6
45  (c) Emacs 20.1 to 20.3
47         APEL 10.7, CLIME 1.14.6, SEMI 1.14.6
49     Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
50     earlier.
52   (d) Emacs 19.34 (Mule 2.3)
54         APEL 10.7, CLIME 1.14.6, SEMI 1.14.6
56     Mule based on Emacs 19.34 can also run SEMI.  See the following web
57     page to get more information (in Japanese).
59         http://www.jpl.org/elips/INSTALL-SEMI-ja.html
62 Install MIME Module
63 ===================
65   You can download these packages from following URLs.
67         APEL:   ftp://ftp.m17n.org/pub/mule/apel/
68         FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
69         CLIME:  ftp://ftp.jpl.org/pub/m17n/
70         SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
72   Please install APEL, FLIM(CLIME), and SEMI, in that order.  Generally,
73   'make install' will do the job.  To get full information, please refer
74   to the README.en within each package.
76   You can also use many other FLIM/SEMI variants.  Combination of the
77   latest versions should work.  For example, the following combinations
78   are confirmed to work:
80         APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
81         APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
83   You have to re-install Wanderlust if you upgraded APEL, FLIM, or SEMI.
86 Check Environment
87 =================
89   Before going to the next step, we recommend you to run tests by
91         % make check
92   or
93         % make EMACS=xemacs check
95   to check running environment including the version of APEL, FLIM, and
96   SEMI.  Note that even if you have installed new APEL/FLIM/SEMI, old
97   ones in load-path may cause trouble.  To find duplicated files in the
98   load-path, M-x list-load-path-shadows will help you.
101 Installation
102 ============
104 (a) Edit Makefile, WL-CFG
106   Edit EMACS, LISPDIR, and so on in Makefile.
108         EMACS      Emacs command name.
109         LISPDIR    site-lisp directory.
111   If LISPDIR is not specified (or NONE by default), it is automatically
112   detected.
114   Edit WL-CFG if you need. You can specify language for INFO, etc.
116 (b) Bytecompile and Install
118   Please do following.
120         % make
121         % make install
123   If you use Emacs without subdirs.el, the following error message
124   occasionally appears.
126         Cannot open load file: mime-setup
128   In this case, add directories of custom, APEL, FLIM, SEMI to
129   EMACSLOADPATH (environment variable), or add those directories to
130   load-path in WL-CFG.
133 Install as a XEmacs package
134 ===========================
136   Wanderlust is able to be installed as one of XEmacs (21.0 or later)
137   packages.  After installation as a XEmacs package, you do not need
138   configurations of autoload, icon path in your own .emacs file.
140 (a) Edit Makefile, WL-CFG
142   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
144         XEMACS      XEmacs command name.
145         PACKAGEDIR  package directory.
147   If PACKAGEDIR is not specified (NONE by default) and the SEMI
148   modules have been installed, it is automatically detected.
150   Edit WL-CFG if you need. You can specify language for INFO, etc.
152 (b) Bytecompile and Install
154   Please do following.
156         % make package
157         % make install-package
159   Install with Info file.
162 load-path
163 =========
165   If you are using Emacs 20.3 or later, or XEmacs, there is no need
166   to set load-path.
168   If you are using Emacs 20.2 or earlier, please add the directory of
169   Wanderlust to load-path.
171   If you install by default setting, with Emacs 19.29 or later, Emacs
172   20.1, or Emacs 20.2, you can write subdirs.el for example:
174   --------------------------------------------------------------------
175     (normal-top-level-add-to-load-path
176      '("apel" "flim" "semi" "wl"))
177   --------------------------------------------------------------------
180 Manual
181 ======
183   Manual is described in Info format. Please do following.
185         % make info
186         % make install-info
188   If you install Wanderlust as a XEmacs package, Info file is already
189   installed too, so there are no need of these commands.
191   Manual directory is automatically detected. Of course, it can be
192   configured by INFODIR in Makefile.
195 Sample configuration file
196 =========================
198   Wanderlust requires the following three configuration files:
200         ~/.wl           Wanderlust Configuration (loaded at startup)
201         ~/.folders      Folder Book
202         ~/.addresses    Address Book (optional)
204   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
205   samples/en/ directory. Please refer to them.
207   To get full information, please read Info file.
210 Local Variables: 
211 fill-column: 72
212 End: