INSTALL

   1
   2         How to install Wanderlust
   3
   4                                         Kaoru Takahashi,
   5                                         Yuuichi Teranishi,
   6                                         Tsunehiko Baba
   7
   8 System Requirements
   9 ===================
  10
  11   Wanderlust supports following Emacsen:
  12
  13         Mule 2.3 based on Emacs 19.34
  14         Emacs 20.1 or later
  15         XEmacs 20.4 or later
  16
  17   Before installing Wanderlust, please install the following MIME
  18   modules.
  19
  20         SEMI    (1.14.3 or later)
  21         FLIM    (1.14.3 or later)
  22
  23   Wanderlust and MIME modules require APEL.  Before installing MIME
  24   modules, please install the APEL.
  25
  26         APEL    (10.3 or later)
  27
  28
  29 Select MIME Module
  30 ==================
  31
  32   For each Emacsen, Recommended combination of MIME module package
  33   follows.
  34
  35   (a) XEmacs 21.1 or later
  36
  37         APEL 10.5, FLIM 1.14.5, SEMI 1.14.5
  38
  39     Installation as a XEmacs package, If possible.
  40
  41   (b) Emacs 20.4 or later
  42
  43         APEL 10.5, FLIM 1.14.5, SEMI 1.14.5
  44
  45  (c) Emacs 20.1 to 20.3
  46
  47         APEL 10.5, CLIME 1.14.5, SEMI 1.14.5
  48
  49     Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
  50     earlier.
  51
  52   (d) Emacs 19.34 (Mule 2.3)
  53
  54         APEL 10.5, CLIME 1.14.5, SEMI 1.14.5
  55
  56     Mule based on Emacs 19.34 can also run SEMI.  See the following web
  57     page to get more information (in Japanese).
  58
  59         http://www.jpl.org/elips/INSTALL-SEMI-ja.html
  60
  61
  62 Install MIME Module
  63 ===================
  64
  65   You can download these packages from following URLs.
  66
  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/
  71
  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.
  75
  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:
  79
  80         APEL 10.5, SLIM 1.14.9, SEMI 1.14.5
  81         APEL 10.5, CLIME 1.14.5, EMIKO 1.14.1
  82
  83   You have to re-install Wanderlust if you upgraded APEL, FLIM, or SEMI.
  84
  85
  86 Check Environment
  87 =================
  88
  89   Before going to the next step, we recommend you to run tests by
  90
  91         % make check
  92   or
  93         % make EMACS=xemacs check
  94
  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.)
  98
  99
 100 Installation
 101 ============
 102
 103 (a) Edit Makefile, WL-CFG
 104
 105   Edit EMACS, LISPDIR, and so on in Makefile.
 106
 107         EMACS      Emacs command name.
 108         LISPDIR    site-lisp directory.
 109
 110   If LISPDIR is not specified (or NONE by default), it is automatically
 111   detected.
 112
 113   Edit WL-CFG if you need. You can specify language for INFO, etc.
 114
 115 (b) Bytecompile and Install
 116
 117   Please do following.
 118
 119         % make
 120         % make install
 121
 122   If you use Emacs without subdirs.el, the following error message
 123   occasionally appears.
 124
 125         Cannot open load file: mime-setup
 126
 127   In this case, add directories of custom, APEL, FLIM, SEMI to
 128   EMACSLOADPATH (environment variable), or add those directories to
 129   load-path in WL-CFG.
 130
 131
 132 Install as a XEmacs package
 133 ===========================
 134
 135   Wanderlust is able to be installed as one of XEmacs (21.0 or later)
 136   packages.  After installation as a XEmacs package, you do not need
 137   configurations of autoload, icon path in your own .emacs file.
 138
 139 (a) Edit Makefile, WL-CFG
 140
 141   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
 142
 143         XEMACS      XEmacs command name.
 144         PACKAGEDIR  package directory.
 145
 146   If PACKAGEDIR is not specified (NONE by default) and the SEMI
 147   modules have been installed, it is automatically detected.
 148
 149   Edit WL-CFG if you need. You can specify language for INFO, etc.
 150
 151 (b) Bytecompile and Install
 152
 153   Please do following.
 154
 155         % make package
 156         % make install-package
 157
 158   Install with Info file.
 159
 160
 161 load-path
 162 =========
 163
 164   If you are using Emacs 20.3 or later, or XEmacs, there is no need
 165   to set load-path.
 166
 167   If you are using Emacs 20.2 or earlier, please add the directory of
 168   Wanderlust to load-path.
 169
 170   If you install by default setting, with Emacs 19.29 or later, Emacs
 171   20.1, or Emacs 20.2, you can write subdirs.el for example:
 172
 173   --------------------------------------------------------------------
 174     (normal-top-level-add-to-load-path
 175      '("apel" "flim" "semi" "wl"))
 176   --------------------------------------------------------------------
 177
 178
 179 Manual
 180 ======
 181
 182   Manual is described in Info format. Please do following.
 183
 184         % make info
 185         % make install-info
 186
 187   If you install Wanderlust as a XEmacs package, Info file is already
 188   installed too, so there are no need of these commands.
 189
 190   Manual directory is automatically detected. Of course, it can be
 191   configured by INFODIR in Makefile.
 192
 193
 194 Sample configuration file
 195 =========================
 196
 197   Wanderlust requires the following three configuration files:
 198
 199         ~/.wl           Wanderlust Configuration (loaded at startup)
 200         ~/.folders      Folder Book
 201         ~/.addresses    Address Book (optional)
 202
 203   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
 204   samples/en/ directory. Please refer to them.
 205
 206   To get full information, please read Info file.
 207
 208
 209 Local Variables:
 210 fill-column: 72
 211 End: