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 (9.12 or later) package.
  43     APEL package is available at:
  44
  45         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/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
  85   You can specify site-lisp directory, for example
  86
  87         % make install LISPDIR=~/share/emacs/lisp
  88
  89   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  90   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  91   /usr/local/lib/xemacs/site-lisp).
  92
  93   If the emu modules (included in APEL package) have been installed in
  94   the non-standard directory, you should specify where they will be
  95   found, for example:
  96
  97         % make install VERSION_SPECIFIC_LISPDIR=~/elisp
  98
  99   Following make target is available to find what files are parts of
 100   emu / APEL package, and where are directories to install them:
 101
 102     % make what-where LISPDIR=~/elisp VERSION_SPECIFIC_LISPDIR=~/elisp
 103
 104   You can specify other optional settings by editing the file
 105   FLIM-CFG.  Please read comments in it.
 106
 107 (1-c) install as a XEmacs package
 108
 109   If you want to install to XEmacs package directory, please do
 110   following:
 111
 112         % make install-package
 113
 114   You can specify the XEmacs command name, for example
 115
 116         % make install-package XEMACS=xemacs-21
 117
 118   If `XEMACS=...' is omitted, XEMACS=xemacs is used.
 119
 120   You can specify the package directory, for example:
 121
 122         % make install PACKAGEDIR=~/.xemacs
 123
 124   If `PACKAGEDIR=...' is omitted, the first existing package
 125   directory is used.
 126
 127   Notice that XEmacs package system requires XEmacs 21.0 or later.
 128
 129
 130 load-path (for Emacs or MULE)
 131 =============================
 132
 133   If you are using Emacs or Mule, please add directory of FLIM to
 134   load-path.  If you install by default setting, you can write
 135   subdirs.el for example:
 136
 137   --------------------------------------------------------------------
 138   (normal-top-level-add-to-load-path '("apel" "flim"))
 139   --------------------------------------------------------------------
 140
 141   If you are using XEmacs, there are no need of setting about
 142   load-path.
 143
 144
 145 Bug reports
 146 ===========
 147
 148   If you write bug-reports and/or suggestions for improvement, please
 149   send them to the tm Mailing List:
 150
 151         bug-tm-en@chamonix.jaist.ac.jp  (English)
 152         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 153
 154   Via the tm ML, you can report FLIM bugs, obtain the latest release
 155   of FLIM, and discuss future enhancements to FLIM. To join the tm ML,
 156   send an empty e-mail to
 157
 158         tm-en-help@chamonix.jaist.ac.jp (English)
 159         tm-ja-help@chamonix.jaist.ac.jp (Japanese)