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