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