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