INSTALL

   1
   2         How to install Wanderlust
   3
   4                                         Kaoru Takahashi,
   5                                         Yuuichi Teranishi,
   6                                         Tsunehiko Baba
   7
   8 System Requirements
   9 ===================
  10
  11   Wanderlust supports following Emacsen:
  12
  13         Emacs 24.5 or later
  14
  15   Before installing Wanderlust, please install the following MIME
  16   modules.
  17
  18         SEMI-EPG
  19         FLIM-LB
  20
  21   Wanderlust and MIME modules require APEL-LB.  Before installing MIME
  22   modules, please install APEL-LB.
  23
  24
  25 Install MIME Module
  26 ===================
  27
  28   You can download these packages from following URLs.
  29
  30         APEL-LB:        https://github.com/wanderlust/apel
  31         FLIM-LB:        https://github.com/wanderlust/flim
  32         SEMI-EPG:       https://github.com/wanderlust/semi
  33
  34   Please install APEL-LB, FLIM-LB, and SEMI-EPG, in that order.
  35   Generally, 'make install' will do the job.  To get full information,
  36   please refer to the README.en within each package.
  37
  38   You have to re-install Wanderlust if you upgraded APEL-LB, FLIM-LB, or
  39   SEMI-EPG.
  40
  41
  42 Check Environment
  43 =================
  44
  45   Before going to the next step, we recommend you to run tests by
  46
  47         % make check
  48   or
  49         % make EMACS=xemacs check
  50
  51   to check running environment including the version of APEL, FLIM, and
  52   SEMI.  Note that even if you have installed new APEL/FLIM/SEMI, old
  53   ones in load-path may cause trouble.  To find duplicated files in the
  54   load-path, M-x list-load-path-shadows will help you.
  55
  56
  57 Installation
  58 ============
  59
  60 (a) Edit Makefile, WL-CFG
  61
  62   Edit EMACS, LISPDIR, and so on in Makefile.
  63
  64         EMACS      Emacs command name.
  65         LISPDIR    site-lisp directory.
  66
  67   If LISPDIR is not specified (or NONE by default), it is automatically
  68   detected.
  69
  70   Edit WL-CFG if you need. You can specify language for INFO, etc.
  71
  72 (b) Bytecompile and Install
  73
  74   Please do following.
  75
  76         % make
  77         % make install
  78
  79   If you use Emacs without subdirs.el, the following error message
  80   occasionally appears.
  81
  82         Cannot open load file: mime-setup
  83
  84   In this case, add directories of custom, APEL, FLIM, SEMI to
  85   EMACSLOADPATH (environment variable), or add those directories to
  86   load-path in WL-CFG.
  87
  88
  89 Install as a XEmacs package
  90 ===========================
  91
  92   Wanderlust is able to be installed as one of XEmacs (21.0 or later)
  93   packages.  After installation as a XEmacs package, you do not need
  94   configurations of autoload, icon path in your own .emacs file.
  95
  96 (a) Edit Makefile, WL-CFG
  97
  98   Edit XEMACS, PACKAGEDIR, and so on in Makefile.
  99
 100         XEMACS      XEmacs command name.
 101         PACKAGEDIR  package directory.
 102
 103   If PACKAGEDIR is not specified (NONE by default) and the SEMI
 104   modules have been installed, it is automatically detected.
 105
 106   Edit WL-CFG if you need. You can specify language for INFO, etc.
 107
 108 (b) Bytecompile and Install
 109
 110   Please do following.
 111
 112         % make package
 113         % make install-package
 114
 115   Install with Info file.
 116
 117
 118 load-path
 119 =========
 120
 121   If you are using Emacs 20.3 or later, or XEmacs, there is no need
 122   to set load-path.
 123
 124   If you are using Emacs 20.2 or earlier, please add the directory of
 125   Wanderlust to load-path.
 126
 127   If you install by default setting, with Emacs 19.29 or later, Emacs
 128   20.1, or Emacs 20.2, you can write subdirs.el for example:
 129
 130   --------------------------------------------------------------------
 131     (normal-top-level-add-to-load-path
 132      '("apel" "flim" "semi" "wl"))
 133   --------------------------------------------------------------------
 134
 135
 136 Manual
 137 ======
 138
 139   Manual is described in Info format. Please do following.
 140
 141         % make info
 142         % make install-info
 143
 144   If you install Wanderlust as a XEmacs package, Info file is already
 145   installed too, so there are no need of these commands.
 146
 147   Manual directory is automatically detected. Of course, it can be
 148   configured by INFODIR in Makefile.
 149
 150
 151 Sample configuration file
 152 =========================
 153
 154   Wanderlust requires the following three configuration files:
 155
 156         ~/.wl           Wanderlust Configuration (loaded at startup)
 157         ~/.folders      Folder Book
 158         ~/.addresses    Address Book (optional)
 159
 160   Each sample file (dot.addresses, dot.folders, dot.wl) exists on
 161   samples/en/ directory. Please refer to them.
 162
 163   To get full information, please read Info file.
 164
 165
 166 Local Variables:
 167 fill-column: 72
 168 End: