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
  74 Installation
  75 ============
  76
  77 (a) Edit Makefile
  78
  79   Edit EMACS, LISPDIR, and so on in Makefile.
  80
  81         EMACS      Emacs command name.
  82         LISPDIR    site-lisp directory.
  83
  84   If LISPDIR is not specified (or NONE by default), it is automatically
  85   detected.
  86
  87 (b) Bytecompile and Install
  88
  89   Please do following.
  90
  91         % make
  92         % make install
  93
  94   If you use Emacs without subdirs.el (e.g. Mule 2.3 based on Emacs
  95   19.28), the following error message ocasinally appears.
  96
  97         Cannot open load file: mime-setup
  98
  99   In this case, add directories of custom, APEL, FLIM, SEMI to
 100   EMACSLOADPATH (environment variable), or add those directories to
 101   load-path in WL-CFG.
 102
 103
 104 Install as a XEmacs package
 105 ===========================
 106
 107   Wanderlust is able to be installed as one of XEmacs (21.0 or later)
 108   packages.  After installation as a XEmacs package, you do not need
 109   configurations of autoload, icon path in your own .emacs file.
 110
 111 (a) Edit Makefile
 112
 113   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
 114
 115         XEMACS      XEmacs command name.
 116         PACKAGEDIR  package directory.
 117
 118   If PACKAGEDIR is not specified (NONE by default) and the SEMI
 119   modules have been installed, it is automatically detected.
 120
 121 (b) Bytecompile and Install
 122
 123   Please do following.
 124
 125         % make package
 126         % make install-package
 127
 128   Install with Info file.
 129
 130
 131 load-path
 132 =========
 133
 134   If you are using Emacs 20.3 or later, or XEmacs, there are no need
 135   of setting about load-path.
 136
 137   If you are using Emacs 20.2 or earlier, please add directory of
 138   Wanderlust to load-path.
 139
 140   If you install by default setting, with Emacs 19.29 or later, Emacs
 141   20.1, or Emacs 20.2, you can write subdirs.el for example:
 142
 143   --------------------------------------------------------------------
 144     (normal-top-level-add-to-load-path
 145      '("apel" "flim" "semi" "wl"))
 146   --------------------------------------------------------------------
 147
 148   If you are using Emacs 19.28 or earlier, you can't use subdirs.el.
 149   Please you write setting about load-path in site configuration file.
 150
 151
 152 Manual
 153 ======
 154
 155   Manual is described in Info format. Please do following.
 156
 157         % make info
 158         % make install-info
 159
 160   If you install Wanderlust as a XEmacs package, Info file is already
 161   installed too, so there are no need of these commands.
 162
 163   Manual directory is automatically detected. Of course, it can be
 164   configured by INFODIR in Makefile.
 165
 166
 167 Sample configuration file
 168 =========================
 169
 170   Wanderlust requires following three configuration files.
 171
 172         ~/.addresses    Address Book
 173         ~/.folders      Folder Book
 174         ~/.wl           Wanderlust Configuration (loaded at startup)
 175
 176   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
 177   samples/en/ directory. Please refer them.
 178
 179   To get full information, please read Info file.