README.en

   1 [README for FLIM (English Version)]
   2
   3 What's FLIM
   4 ===========
   5
   6   FLIM is a library to provide basic features about message
   7   representation or encoding.  It consists of following
   8   modules:
   9
  10     std11.el    --- STD 11 (RFC 822) parser and utility
  11
  12     mime.el     --- MIME library
  13
  14         mime-def.el --- Definitions about MIME format
  15
  16         mime-parse.el --- MIME parser
  17
  18         mel.el --- MIME encoder/decoder
  19             mel-dl.el --- base64 (b-encoding) encoder/decoder
  20                           (for Emacs 20 with dynamic loading support)
  21             mel-b.el  --- base64 (b-encoding) encoder/decoder
  22                           (for other emacsen)
  23             mel-q.el  --- quoted-printable and q-encoding encoder/decoder
  24             mel-u.el  --- unofficial module for uuencode
  25             mel-g.el  --- unofficial module for gzip64
  26
  27         eword-decode.el --- encoded-word decoder
  28         eword-encode.el --- encoded-word encoder
  29
  30     mailcap.el  --- mailcap parser and utility
  31
  32
  33 Installation
  34 ============
  35
  36 (0) before installing it, please install APEL package.  APEL package
  37     is available at:
  38
  39         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  40
  41 (1-a) run in expanded place
  42
  43   If you don't want to install other directories, please do only
  44   following:
  45
  46         % make
  47
  48   You can specify the emacs command name, for example
  49
  50         % make install EMACS=xemacs
  51
  52   If `EMACS=...' is omitted, EMACS=emacs is used.
  53
  54 (1-b) make install
  55
  56   If you want to install other directories, please do following:
  57
  58         % make install
  59
  60   You can specify the emacs command name, for example
  61
  62         % make install EMACS=xemacs
  63
  64   If `EMACS=...' is omitted, EMACS=emacs is used.
  65
  66   You can specify the prefix of the directory tree for Emacs Lisp
  67   programs and shell scripts, for example:
  68
  69         % make install PREFIX=~/
  70
  71   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  72   specified emacs command is used (perhaps /usr/local).
  73
  74   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  75   will create the following directory tree:
  76
  77         /usr/local/share/emacs/site-lisp/flim/   --- FLIM
  78
  79   You can specify site-lisp directory, for example
  80
  81         % make install LISPDIR=~/share/emacs/lisp
  82
  83   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  84   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  85   /usr/local/lib/xemacs/site-lisp).
  86
  87   You can specify other optional settings by editing the file
  88   FLIM-CFG.  Please read comments in it.
  89
  90 (1-c) install as a XEmacs package
  91
  92   If you want to install to XEmacs package directory, please do
  93   following:
  94
  95         % make install-package
  96
  97   You can specify the emacs command name, for example
  98
  99         % make install-package XEMACS=xemacs-21
 100
 101   If `XEMACS=...' is omitted, XEMACS=xemacs is used.
 102
 103   You can specify the package directory, for example:
 104
 105         % make install PACKAGEDIR=~/.xemacs
 106
 107   If `PACKAGEDIR=...' is omitted, the first existing package
 108   directory is used.
 109
 110   Notice that XEmacs package system requires XEmacs 21.0 or later.
 111
 112
 113 load-path (for Emacs or MULE)
 114 =============================
 115
 116   If you are using Emacs or Mule, please add directory of FLIM to
 117   load-path.  If you install by default setting, you can write
 118   subdirs.el for example:
 119
 120   --------------------------------------------------------------------
 121   (normal-top-level-add-to-load-path '("apel" "flim"))
 122   --------------------------------------------------------------------
 123
 124   If you are using XEmacs, there are no need of setting about
 125   load-path.
 126
 127
 128 Bug reports
 129 ===========
 130
 131   If you write bug-reports and/or suggestions for improvement, please
 132   send them to the tm Mailing List:
 133
 134         bug-tm-en@chamonix.jaist.ac.jp  (English)
 135         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 136
 137   Via the tm ML, you can report FLIM bugs, obtain the latest release
 138   of FLIM, and discuss future enhancements to FLIM. To join the tm ML,
 139   send an empty e-mail to
 140
 141         tm-en-help@chamonix.jaist.ac.jp (English)
 142         tm-ja-help@chamonix.jaist.ac.jp (Japanese)