INSTALL

   1
   2         How to install Wanderlust
   3
   4                                         Kaoru Takahashi,
   5                                         Yuuichi Teranishi,
   6                                         Tsunehiko Baba
   7
   8 Select MIME Module
   9 ==================
  10
  11   Before installing Wanderlust, please install either of the following
  12   MIME modules. SEMI is recommended because it's more functional.
  13
  14         SEMI    (1.14.1 or later)
  15         tm      (8.7 or later)
  16
  17   SEMI requires APEL and FLIM packages.  For each Emacsen, Recommended
  18   combination of MIME module package following.
  19
  20 (a) XEmacs 21.1 or later
  21
  22         APEL 10.3, FLIM 1.14.3, SEMI 1.14.3
  23
  24   Installation as a XEmacs package, If possible.
  25
  26 (b) Emacs 20.4 or later
  27
  28         APEL 10.3, FLIM 1.14.3, SEMI 1.14.3
  29
  30 (c) Emacs 20.1 to 20.3
  31
  32         APEL 10.3, CLIME 1.14.0, SEMI 1.14.3
  33
  34   Use CLIME instead of FLIM.  FLIM does not support Emacs 20.3 or
  35   earlier.
  36
  37 (d) Emacs 19.34 (Mule 2.3)
  38
  39         APEL 10.3, CLIME 1.14.0, SEMI 1.14.3
  40
  41   Mule based on Emacs 19.34 can also run SEMI.  See the following web
  42   page to get more information (in Japanese).
  43
  44         http://www.jpl.org/elips/INSTALL-SEMI-ja.html
  45
  46 (e) Emacs 19.28 or earlier (Mule 2.3, Nemacs)
  47
  48         APEL 10.3, CLIME 1.14.0, tm 8.8
  49
  50   If you use Mule based on Emacs 19.28 or earlier, please install tm.
  51   SEMI does not support Emacs 19.28 or earlier.  You need upgrade APEL
  52   and CLIME.
  53
  54
  55 Install MIME Module
  56 ===================
  57
  58   You can download these packages from following URLs.
  59
  60         APEL:   ftp://ftp.m17n.org/pub/mule/apel/
  61         FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
  62         CLIME:
  63         SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
  64         tm:     http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
  65
  66 (a) SEMI
  67
  68   Please install APEL, FLIM(CLIME), and SEMI, in that order.  Generally,
  69   'make install' will do the job.  To get full information, please refer
  70   to the README.en within each package.
  71
  72   You can also use many other FLIM/SEMI variants.  Combination of the
  73   latest versions should work.  For example, the following combinations
  74   are confirmed to work:
  75
  76         APEL 10.2, Chao 1.14.1, REMI 1.14.2
  77         APEL 10.2, SLIM 1.14.3, EMY 1.13.9
  78
  79 (b) tm
  80
  81   The tm, whose version is 8.7 or later, is recommended.  To get full
  82   information, please refer README.en within package.
  83
  84   tm-8.8 or earlier makes following error while compiling Wanderlust.
  85
  86         Use tm-8.x with APEL 10.2 or later.
  87
  88   In this case, please install APEL 10.2 or later.
  89
  90
  91 Installation
  92 ============
  93
  94 (a) Edit Makefile
  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 (b) Bytecompile and Install
 105
 106   Please do following.
 107
 108         % make
 109         % make install
 110
 111   If you use Emacs without subdirs.el (e.g. Mule 2.3 based on Emacs
 112   19.28), the following error message ocasinally appears.
 113
 114         Cannot open load file: mime-setup
 115
 116   In this case, add directories of custom, APEL, FLIM, SEMI to
 117   EMACSLOADPATH (environment variable), or add those directories to
 118   load-path in WL-CFG.
 119
 120
 121 Install as a XEmacs package
 122 ===========================
 123
 124   Wanderlust is able to be installed as one of XEmacs (21.0 or later)
 125   packages.  After installation as a XEmacs package, you do not need
 126   configurations of autoload, icon path in your own .emacs file.
 127
 128 (a) Edit Makefile
 129
 130   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
 131
 132         XEMACS      XEmacs command name.
 133         PACKAGEDIR  package directory.
 134
 135   If PACKAGEDIR is not specified (NONE by default) and the SEMI
 136   modules have been installed, it is automatically detected.
 137
 138 (b) Bytecompile and Install
 139
 140   Please do following.
 141
 142         % make package
 143         % make install-package
 144
 145   Install with Info file.
 146
 147
 148 load-path
 149 =========
 150
 151   If you are using Emacs 20.3 or later, or XEmacs, there is no need
 152   to set load-path.
 153
 154   If you are using Emacs 20.2 or earlier, please add the directory of
 155   Wanderlust to load-path.
 156
 157   If you install by default setting, with Emacs 19.29 or later, Emacs
 158   20.1, or Emacs 20.2, you can write subdirs.el for example:
 159
 160   --------------------------------------------------------------------
 161     (normal-top-level-add-to-load-path
 162      '("apel" "flim" "semi" "wl"))
 163   --------------------------------------------------------------------
 164
 165   If you are using Emacs 19.28 or earlier, you can't use subdirs.el.
 166   Please write setting about load-path in site configuration file.
 167
 168
 169 Manual
 170 ======
 171
 172   Manual is described in Info format. Please do following.
 173
 174         % make info
 175         % make install-info
 176
 177   If you install Wanderlust as a XEmacs package, Info file is already
 178   installed too, so there are no need of these commands.
 179
 180   Manual directory is automatically detected. Of course, it can be
 181   configured by INFODIR in Makefile.
 182
 183
 184 Sample configuration file
 185 =========================
 186
 187   Wanderlust requires the following three configuration files:
 188
 189         ~/.addresses    Address Book
 190         ~/.folders      Folder Book
 191         ~/.wl           Wanderlust Configuration (loaded at startup)
 192
 193   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
 194   samples/en/ directory. Please refer to them.
 195
 196   To get full information, please read Info file.
 197
 198
 199 Local Variables:
 200 fill-column: 72
 201 End: