INSTALL

   1
   2         How to install Wanderlust
   3
   4                                         Kaoru Takahashi,
   5                                         Yuuichi Teranishi,
   6                                         Tsunehiko Baba
   7
   8 Required environment
   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.13.4 or later)
  15         tm      (8.7 or later)
  16
  17   If you use Mule based on Emacs 19.28 or earlier, please install tm.
  18   SEMI does not support Emacs 19.28 or earlier.
  19
  20   SEMI only supports relatively new Emacsen like Emacs 20.xx, XEmacs, etc.
  21   But Mule based on Emacs 19.34 can also run SEMI.
  22   See the following web page to get more information (written by Japanese).
  23
  24         http://www.jpl.org/elips/INSTALL-SEMI-ja.html
  25
  26
  27 (a) SEMI
  28
  29   SEMI requires APEL and FLIM packages.
  30   Recommended combination of APEL, FLIM and SEMI are:
  31
  32         APEL 10.2, FLIM 1.12.7 and SEMI 1.13.4
  33          or
  34         APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
  35
  36   Combination of APEL 10.2 and FLIM 1.12.7 makes following error
  37   while compiling FLIM 1.12.7.
  38
  39         Please install latest APEL 7.3 or later.
  40
  41   In this case, please comment out following lines in FLIM-CFG.
  42
  43   (or (fboundp 'write-region-as-binary)
  44       (error "Please install latest APEL 7.3 or later."))
  45   (or (fboundp 'insert-file-contents-as-binary)
  46      (error "Please install latest APEL 7.3 or later."))
  47
  48   You can download these packages from following URLs.
  49
  50         APEL:     ftp://ftp.m17n.org/mule/apel/
  51         FLIM:     ftp://ftp.m17n.org/mule/flim/
  52         SEMI:     ftp://ftp.m17n.org/mule/semi/
  53
  54   Please install APEL, FLIM, SEMI in order.
  55   Generally  'make install' will do the job.
  56   To get full information, please refer README.en within each package.
  57
  58   You can also use many other FLIM/SEMI variants.
  59   Combination of the latest versions should work.
  60   For example, following combination is confirmed to work.
  61
  62         APEL 10.2, Chao 1.14.1 and REMI 1.14.1
  63
  64 (b) tm
  65
  66   The tm, whose version is 8.7 or later, is recommended.  Please
  67   obtain from the following web site.
  68
  69         http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
  70
  71   To get full information, please refer README.en within package.
  72
  73   tm-8.8 or earlier makes following error while compiling Wanderlust.
  74
  75         Use tm-8.x with APEL 10.2 or later.
  76
  77   In this case, please install APEL 10.2 or later.
  78
  79         APEL:     ftp://ftp.m17n.org/mule/apel/
  80
  81
  82 Installation
  83 ============
  84
  85 (a) Edit Makefile
  86
  87   Edit EMACS, LISPDIR, and so on in Makefile.
  88
  89         EMACS      Emacs command name.
  90         LISPDIR    site-lisp directory.
  91
  92   If LISPDIR is not specified (or NONE by default), it is automatically
  93   detected.
  94
  95 (b) Bytecompile and Install
  96
  97   Please do following.
  98
  99         % make
 100         % make install
 101
 102   If you use Emacs without subdirs.el (e.g. Mule 2.3 based on Emacs
 103   19.28), the following error message ocasinally appears.
 104
 105         Cannot open load file: mime-setup
 106
 107   In this case, add directories of custom, APEL, FLIM, SEMI to
 108   EMACSLOADPATH (environment variable), or add those directories to
 109   load-path in WL-CFG.
 110
 111
 112 Install as a XEmacs package
 113 ===========================
 114
 115   Wanderlust is able to be installed as one of XEmacs (21.0 or later)
 116   packages.  After installation as a XEmacs package, you do not need
 117   configurations of autoload, icon path in your own .emacs file.
 118
 119 (a) Edit Makefile
 120
 121   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
 122
 123         XEMACS      XEmacs command name.
 124         PACKAGEDIR  package directory.
 125
 126   If PACKAGEDIR is not specified (NONE by default) and the SEMI
 127   modules have been installed, it is automatically detected.
 128
 129 (b) Bytecompile and Install
 130
 131   Please do following.
 132
 133         % make package
 134         % make install-package
 135
 136   Install with Info file.
 137
 138
 139 load-path
 140 =========
 141
 142   If you are using Emacs 20.3 or later, or XEmacs, there are no need
 143   of setting about load-path.
 144
 145   If you are using Emacs 20.2 or earlier, please add directory of
 146   Wanderlust to load-path.
 147
 148   If you install by default setting, with Emacs 19.29 or later, Emacs
 149   20.1, or Emacs 20.2, you can write subdirs.el for example:
 150
 151   --------------------------------------------------------------------
 152     (normal-top-level-add-to-load-path
 153      '("apel" "flim" "semi" "wl"))
 154   --------------------------------------------------------------------
 155
 156   If you are using Emacs 19.28 or earlier, you can't use subdirs.el.
 157   Please you write setting about load-path in site configuration file.
 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 following three configuration files.
 179
 180         ~/.addresses    Address Book
 181         ~/.folders      Folder Book
 182         ~/.wl           Wanderlust Configuration (loaded at startup)
 183
 184   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
 185   samples/en/ directory. Please refer them.
 186
 187   To get full information, please read Info file.