-[README for MEL (English Version)]
-by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-$Id: README.en,v 1.2 1997-04-30 12:50:28 morioka Exp $
+[README for FLIM (English Version)]
+by MORIOKA Tomohiko
-What's MEL
+What's FLIM
===========
- MEL stands for "MIME Encoding Library". It consists of following
+ FLIM is a library to provide basic features about message
+ representation or encoding. It consists of following
modules:
- mel.el --- main module
- mel-b.el --- base64 (b-encoding) encoder/decoder
- mel-q.el --- quoted-printable and q-encoding encoder/decoder
- mel-u.el --- unofficial module for uuencode
- mel-g.el --- unofficial module for gzip64
+ 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
+
+ This library should work on:
+
+ Emacs 20.4 and up
+ XEmacs 21.1 and up
Installation
============
-(0) before installing it, please install APEL package. APEL package
- is available at:
+(0) before installing it, please install APEL (10.7 or later) package.
+ APEL package is available at:
- ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
+ ftp://ftp.m17n.org/pub/mule/apel/
(1-a) run in expanded place
You can specify the emacs command name, for example
- % make install EMACS=xemacs
+ % make EMACS=xemacs
If `EMACS=...' is omitted, EMACS=emacs is used.
If `EMACS=...' is omitted, EMACS=emacs is used.
You can specify the prefix of the directory tree for Emacs Lisp
- programs and shell scripts, for example:
+ programs, for example:
% make install PREFIX=~/
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/mel/ --- MEL
-
- You can specify other optional settings by editing the file
- MEL-CFG. Please read comments in it.
-
-
-load-path (for Emacs or MULE)
-=============================
-
- If you are using Emacs or Mule, please add directory of MEL to
- load-path. If you install by default setting, you can write
- subdirs.el for example:
-
- --------------------------------------------------------------------
- (normal-top-level-add-to-load-path '("apel" "mel"))
- --------------------------------------------------------------------
-
- If you are using XEmacs, there are no need of setting about
- load-path.
-
-
-How to use
-==========
-
-Region
-------
-
-Command mime-encode-region (START END ENCODING)
-
- Encode region START to END of current buffer using ENCODING.
-
-Command mime-decode-region (start end encoding)
-
- Decode region START to END of current buffer using ENCODING.
-
-Command base64-encode-region (start end)
-
- Encode region START to END of current buffer using base64.
-
-Command base64-decode-region (start end)
-
- Decode region START to END of current buffer using base64.
+ /usr/local/share/emacs/site-lisp/flim/ --- FLIM
-Command quoted-printable-encode-region (start end)
+ You can specify site-lisp directory, for example
- Encode region START to END of current buffer using quoted-printable.
+ % make install LISPDIR=~/share/emacs/lisp
-Command quoted-printable-decode-region (start end)
+ 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).
- Decode region START to END of current buffer using quoted-printable.
+ 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:
-Command uuencode-encode-region (start end)
+ % make install VERSION_SPECIFIC_LISPDIR=~/elisp
- Encode region START to END of current buffer using uuencode.
+ Following make target is available to find what files are parts of
+ emu / APEL package, and where are directories to install them:
-Command uuencode-decode-region (start end)
+ % make what-where LISPDIR=~/elisp VERSION_SPECIFIC_LISPDIR=~/elisp
- Decode region START to END of current buffer using uuencode.
-
-Command gzip64-encode-region (start end)
-
- Encode region START to END of current buffer using x-gzip64.
-
-Command gzip64-decode-region (start end)
-
- Decode region START to END of current buffer using x-gzip64.
-
-Variable mime-encoding-method-alist
-
- Alist of encoding vs. corresponding method to encode region.
- Each element looks like (STRING . FUNCTION) or (STRING . nil).
- STRING is content-transfer-encoding.
- FUNCTION is region encoder and nil means not to encode.
-
-Variable mime-decoding-method-alist
-
- Alist of encoding vs. corresponding method to decode region.
- Each element looks like (STRING . FUNCTION).
- STRING is content-transfer-encoding.
- FUNCTION is region decoder.
-
-File
-----
-
-Command mime-insert-encoded-file (FILENAME ENCODING)
-
- Insert file FILENAME encoded by ENCODING format.
-
-Command base64-insert-encoded-file (FILENAME)
-
- Insert base64 encoded file.
-
-Command quoted-printable-insert-encoded-file (FILENAME)
-
- Insert quoted-printable encoded file.
-
-Command uuencode-insert-encoded-file (FILENAME)
-
- Insert uuencode encoded file.
-
-Command gzip64-insert-encoded-file (FILENAME)
-
- Insert gzip64 encoded file.
-
-Variable mime-file-encoding-method-alist
-
- Alist of encoding vs. corresponding method to insert encoded file.
- Each element looks like (STRING . FUNCTION).
- STRING is content-transfer-encoding.
- FUNCTION is function to insert encoded file.
-
-String
-------
-
-Function base64-encode-string (STRING)
-
- Encode STRING as base64 and return it.
+ You can specify other optional settings by editing the file
+ FLIM-CFG. Please read comments in it.
-Function base64-decode-string (STRING)
+(1-c) install as a XEmacs package
- Decode STRING as base64 and return it.
+ If you want to install to XEmacs package directory, please do
+ following:
-Function q-encoding-encode-string (STRING &optional MODE)
+ % make install-package
- Encode STRING as Q-encoding of encoded-word.
- MODE allows `text', `comment', `phrase' or nil. Default value is
- `phrase'.
+ You can specify the XEmacs command name, for example
-Function q-encoding-decode-string (STRING)
+ % make install-package XEMACS=xemacs-21
- Decode STRING as Q-encoding of encoded-word.
+ If `XEMACS=...' is omitted, XEMACS=xemacs is used.
-Function base64-encoded-length (STRING)
+ You can specify the package directory, for example:
- Return length of base64 encoded STRING.
+ % make install PACKAGEDIR=~/.xemacs
-Function q-encoded-length (STRING &optional MODE)
+ If `PACKAGEDIR=...' is omitted, the first existing package
+ directory is used.
- Return length of Q-encoding encoded STRING.
- MODE allows `text', `comment', `phrase' or nil. Default value is
- `phrase'.
+ Notice that XEmacs package system requires XEmacs 21.0 or later.
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)
+ send them to the Emacs-MIME Mailing Lists:
- Via the tm ML, you can report tm bugs, obtain the latest release of
- tm, and discuss future enhancements to tm. To join the tm ML, send
- e-mail to
+ emacs-mime-en@lists.chise.org (English)
+ emacs-mime-ja@lists.chise.org (Japanese)
- tm-ja-admin@chamonix.jaist.ac.jp (Japanese)
- tm-en-admin@chamonix.jaist.ac.jp (English)
+ Via the Emacs-MIME ML, you can report FLIM bugs, obtain the latest
+ release of FLIM, and discuss future enhancements to FLIM. To join
+ the Emacs-MIME ML, please see the descriptions of the following
+ pages:
- Since the user registration is done manually, please write the mail
- body in human-recognizable language (^_^).
+ http://lists.chise.org/mailman/listinfo/emacs-mime-en (English)
+ http://lists.chise.org/mailman/listinfo/emacs-mime-ja (Japanese)
projects / elisp / flim.git / blobdiff