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