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