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.4, 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.4, FLIM 1.14.5, SEMI 1.14.5
  44
  45  (c) Emacs 20.1 to 20.3
  46
  47         APEL 10.4, 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.4, 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.4, SLIM 1.14.9, SEMI 1.14.5
  81         APEL 10.4, 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   Do following, running environment test included APEL, FLIM, and SEMI
  86   version check.  You can specify the emacs command name.
  87
  88         % make check
  89         % make EMACS=xemacs check
  90
  91 Installation
  92 ============
  93
  94 (a) Edit Makefile, WL-CFG
  95
  96   Edit EMACS, LISPDIR, and so on in Makefile.
  97
  98         EMACS      Emacs command name.
  99         LISPDIR    site-lisp directory.
 100
 101   If LISPDIR is not specified (or NONE by default), it is automatically
 102   detected.
 103
 104   Edit WL-CFG if you need. You can specify language for INFO, etc.
 105
 106 (b) Bytecompile and Install
 107
 108   Please do following.
 109
 110         % make
 111         % make install
 112
 113   If you use Emacs without subdirs.el, the following error message
 114   occasionally appears.
 115
 116         Cannot open load file: mime-setup
 117
 118   In this case, add directories of custom, APEL, FLIM, SEMI to
 119   EMACSLOADPATH (environment variable), or add those directories to
 120   load-path in WL-CFG.
 121
 122
 123 Install as a XEmacs package
 124 ===========================
 125
 126   Wanderlust is able to be installed as one of XEmacs (21.0 or later)
 127   packages.  After installation as a XEmacs package, you do not need
 128   configurations of autoload, icon path in your own .emacs file.
 129
 130 (a) Edit Makefile, WL-CFG
 131
 132   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
 133
 134         XEMACS      XEmacs command name.
 135         PACKAGEDIR  package directory.
 136
 137   If PACKAGEDIR is not specified (NONE by default) and the SEMI
 138   modules have been installed, it is automatically detected.
 139
 140   Edit WL-CFG if you need. You can specify language for INFO, etc.
 141
 142 (b) Bytecompile and Install
 143
 144   Please do following.
 145
 146         % make package
 147         % make install-package
 148
 149   Install with Info file.
 150
 151
 152 load-path
 153 =========
 154
 155   If you are using Emacs 20.3 or later, or XEmacs, there is no need
 156   to set load-path.
 157
 158   If you are using Emacs 20.2 or earlier, please add the directory of
 159   Wanderlust to load-path.
 160
 161   If you install by default setting, with Emacs 19.29 or later, Emacs
 162   20.1, or Emacs 20.2, you can write subdirs.el for example:
 163
 164   --------------------------------------------------------------------
 165     (normal-top-level-add-to-load-path
 166      '("apel" "flim" "semi" "wl"))
 167   --------------------------------------------------------------------
 168
 169
 170 Manual
 171 ======
 172
 173   Manual is described in Info format. Please do following.
 174
 175         % make info
 176         % make install-info
 177
 178   If you install Wanderlust as a XEmacs package, Info file is already
 179   installed too, so there are no need of these commands.
 180
 181   Manual directory is automatically detected. Of course, it can be
 182   configured by INFODIR in Makefile.
 183
 184
 185 Sample configuration file
 186 =========================
 187
 188   Wanderlust requires the following three configuration files:
 189
 190         ~/.wl           Wanderlust Configuration (loaded at startup)
 191         ~/.folders      Folder Book
 192         ~/.addresses    Address Book (optional)
 193
 194   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
 195   samples/en/ directory. Please refer to them.
 196
 197   To get full information, please read Info file.
 198
 199
 200 Local Variables:
 201 fill-column: 72
 202 End: