INSTALL

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