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   This library should work on:
  39
  40         Emacs 20.4 and up
  41         XEmacs 21.1 and up
  42
  43
  44 Installation
  45 ============
  46
  47 (0) before installing it, please install APEL (9.22 or later) package.
  48     APEL package is available at:
  49
  50         ftp://ftp.m17n.org/pub/mule/apel/
  51
  52 (1-a) run in expanded place
  53
  54   If you don't want to install other directories, please do only
  55   following:
  56
  57         % make
  58
  59   You can specify the emacs command name, for example
  60
  61         % make EMACS=xemacs
  62
  63   If `EMACS=...' is omitted, EMACS=emacs is used.
  64
  65 (1-b) make install
  66
  67   If you want to install other directories, please do following:
  68
  69         % make install
  70
  71   You can specify the emacs command name, for example
  72
  73         % make install EMACS=xemacs
  74
  75   If `EMACS=...' is omitted, EMACS=emacs is used.
  76
  77   You can specify the prefix of the directory tree for Emacs Lisp
  78   programs, for example:
  79
  80         % make install PREFIX=~/
  81
  82   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  83   specified emacs command is used (perhaps /usr/local).
  84
  85   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  86   will create the following directory tree:
  87
  88         /usr/local/share/emacs/site-lisp/flim/   --- FLIM
  89
  90   You can specify site-lisp directory, for example
  91
  92         % make install LISPDIR=~/share/emacs/lisp
  93
  94   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  95   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  96   /usr/local/lib/xemacs/site-lisp).
  97
  98   If the emu modules (included in APEL package) have been installed in
  99   the non-standard directory, you should specify where they will be
 100   found, for example:
 101
 102         % make install VERSION_SPECIFIC_LISPDIR=~/elisp
 103
 104   Following make target is available to find what files are parts of
 105   emu / APEL package, and where are directories to install them:
 106
 107     % make what-where LISPDIR=~/elisp VERSION_SPECIFIC_LISPDIR=~/elisp
 108
 109   You can specify other optional settings by editing the file
 110   FLIM-CFG.  Please read comments in it.
 111
 112 (1-c) install as a XEmacs package
 113
 114   If you want to install to XEmacs package directory, please do
 115   following:
 116
 117         % make install-package
 118
 119   You can specify the XEmacs command name, for example
 120
 121         % make install-package XEMACS=xemacs-21
 122
 123   If `XEMACS=...' is omitted, XEMACS=xemacs is used.
 124
 125   You can specify the package directory, for example:
 126
 127         % make install PACKAGEDIR=~/.xemacs
 128
 129   If `PACKAGEDIR=...' is omitted, the first existing package
 130   directory is used.
 131
 132   Notice that XEmacs package system requires XEmacs 21.0 or later.
 133
 134
 135 Bug reports
 136 ===========
 137
 138   If you write bug-reports and/or suggestions for improvement, please
 139   send them to the EMACS-MIME Mailing List:
 140
 141         emacs-mime-en@m17n.org  (English)
 142         emacs-mime-ja@m17n.org  (Japanese)
 143
 144   Via the EMACS-MIME ML, you can report FLIM bugs, obtain the latest
 145   release of FLIM, and discuss future enhancements to FLIM.  To join
 146   the EMACS-MIME ML, send an empty e-mail to
 147
 148         emacs-mime-en-ctl@m17n.org      (English)
 149         emacs-mime-ja-ctl@m17n.org      (Japanese)