README.en

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