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.3, 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.3, 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
  45 Install MIME Module
  46 ===================
  47
  48   You can download these packages from following URLs.
  49
  50         APEL:   ftp://ftp.m17n.org/pub/mule/apel/
  51         FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
  52         CLIME:  ftp://ftp.jpl.org/pub/m17n/
  53         SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
  54
  55   Please install APEL, FLIM(CLIME), and SEMI, in that order.  Generally,
  56   'make install' will do the job.  To get full information, please refer
  57   to the README.en within each package.
  58
  59   You can also use many other FLIM/SEMI variants.  Combination of the
  60   latest versions should work.  For example, the following combinations
  61   are confirmed to work:
  62
  63         APEL 10.3, SLIM 1.14.7, SEMI 1.14.3
  64         APEL 10.3, CLIME 1.14.3, EMIKO 1.14.1
  65
  66   You have to re-install Wanderlust if you upgraded APEL, FLIM, or SEMI.
  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, the following error message
  90   occasionally 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
 144 Manual
 145 ======
 146
 147   Manual is described in Info format. Please do following.
 148
 149         % make info
 150         % make install-info
 151
 152   If you install Wanderlust as a XEmacs package, Info file is already
 153   installed too, so there are no need of these commands.
 154
 155   Manual directory is automatically detected. Of course, it can be
 156   configured by INFODIR in Makefile.
 157
 158
 159 Sample configuration file
 160 =========================
 161
 162   Wanderlust requires the following three configuration files:
 163
 164         ~/.wl           Wanderlust Configuration (loaded at startup)
 165         ~/.folders      Folder Book
 166         ~/.addresses    Address Book (optional)
 167
 168   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
 169   samples/en/ directory. Please refer to them.
 170
 171   To get full information, please read Info file.
 172
 173
 174 Local Variables:
 175 fill-column: 72
 176 End: