[README for MEL (English Version)]
by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-$Id: README.en,v 1.1 1997-04-29 11:47:35 morioka Exp $
+$Id: README.en,v 1.10 1998-03-08 22:44:00 shuhei-k Exp $
What's MEL
===========
MEL stands for "MIME Encoding Library". 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
+ mel.el --- main module
+ mel-dl.el --- base64 (b-encoding) encoder/decoder
+ (for Emacs 20 with dynamic loading support)
+ mel-b.el --- base64 (b-encoding) encoder/decoder
+ (for other emacsen)
+ mel-q.el --- quoted-printable and q-encoding encoder/decoder
+ mel-u.el --- unofficial module for uuencode
+ mel-g.el --- unofficial module for gzip64
Installation
(0) before installing it, please install APEL package. APEL package
is available at:
- ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/alpha/
+ ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
(1-a) run in expanded place
/usr/local/share/emacs/site-lisp/mel/ --- MEL
+ 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).
+
You can specify other optional settings by editing the file
MEL-CFG. Please read comments in it.
Command base64-encode-region (start end)
- Encode region START to END of current buffer using base64.
+ Encode current region by base64.
+ START and END are buffer positions.
+
+ This function calls internal base64 encoder if size of region is
+ smaller than `base64-internal-encoding-limit', otherwise it calls
+ external base64 encoder specified by `base64-external-encoder'. In
+ this case, you must install the program (maybe mmencode included in
+ metamail or XEmacs package).
Command base64-decode-region (start end)
- Decode region START to END of current buffer using base64.
+ Decode current region by base64.
+ START and END are buffer positions.
+
+ This function calls internal base64 decoder if size of region is
+ smaller than `base64-internal-decoding-limit', otherwise it calls
+ external base64 decoder specified by `base64-external-decoder'. In
+ this case, you must install the program (maybe mmencode included in
+ metamail or XEmacs package).
Command quoted-printable-encode-region (start end)
- Encode region START to END of current buffer using quoted-printable.
+ Encode current region by quoted-printable.
+ START and END are buffer positions.
+
+ This function calls internal quoted-printable encoder if size of
+ region is smaller than `quoted-printable-internal-encoding-limit',
+ otherwise it calls external quoted-printable encoder specified by
+ `quoted-printable-external-encoder'. In this case, you must install
+ the program (maybe mmencode included in metamail or XEmacs package).
Command quoted-printable-decode-region (start end)
- Decode region START to END of current buffer using quoted-printable.
+ Decode current region by quoted-printable.
+ START and END are buffer positions.
+
+ This function calls internal quoted-printable decoder if size of
+ region is smaller than `quoted-printable-internal-decoding-limit',
+ otherwise it calls external quoted-printable decoder specified by
+ `quoted-printable-external-decoder'. In this case, you must install
+ the program (maybe mmencode included in metamail or XEmacs package).
Command uuencode-encode-region (start end)
Command base64-insert-encoded-file (FILENAME)
- Insert base64 encoded file.
+ Encode contents of file FILENAME to base64, and insert the result.
+
+ It calls external base64 encoder specified by
+ `base64-external-encoder'. So you must install the program (maybe
+ mmencode included in metamail or XEmacs package).
Command quoted-printable-insert-encoded-file (FILENAME)
Function base64-encode-string (STRING)
- Encode STRING as base64 and return it.
+ Encode STRING to base64, and return the result.
Function base64-decode-string (STRING)
- Decode STRING as base64 and return it.
+ Decode STRING which is encoded in base64, and return the result.
Function q-encoding-encode-string (STRING &optional MODE)
- Encode STRING as Q-encoding of encoded-word.
+ Encode STRING to Q-encoding of encoded-word, and return the result.
MODE allows `text', `comment', `phrase' or nil. Default value is
`phrase'.
Function q-encoding-decode-string (STRING)
- Decode STRING as Q-encoding of encoded-word.
+ Decode STRING which is encoded in Q-encoding and return the result.
Function base64-encoded-length (STRING)
bug-tm-en@chamonix.jaist.ac.jp (English)
bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
- 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
-
- tm-ja-admin@chamonix.jaist.ac.jp (Japanese)
- tm-en-admin@chamonix.jaist.ac.jp (English)
+ Via the tm ML, you can report MEL bugs, obtain the latest release of
+ MEL, and discuss future enhancements to MEL. To join the tm ML, send
+ an empty e-mail to
- Since the user registration is done manually, please write the mail
- body in human-recognizable language (^_^).
+ tm-en-help@chamonix.jaist.ac.jp (English)
+ tm-ja-help@chamonix.jaist.ac.jp (Japanese)