1 [README for MEL (English Version)]
2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
3 $Id: README.en,v 1.4 1997-04-30 13:15:12 morioka Exp $
8 MEL stands for "MIME Encoding Library". It consists of following
11 mel.el --- main module
12 mel-b.el --- base64 (b-encoding) encoder/decoder
13 mel-q.el --- quoted-printable and q-encoding encoder/decoder
14 mel-u.el --- unofficial module for uuencode
15 mel-g.el --- unofficial module for gzip64
21 (0) before installing it, please install APEL package. APEL package
24 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
26 (1-a) run in expanded place
28 If you don't want to install other directories, please do only
33 You can specify the emacs command name, for example
35 % make install EMACS=xemacs
37 If `EMACS=...' is omitted, EMACS=emacs is used.
41 If you want to install other directories, please do following:
45 You can specify the emacs command name, for example
47 % make install EMACS=xemacs
49 If `EMACS=...' is omitted, EMACS=emacs is used.
51 You can specify the prefix of the directory tree for Emacs Lisp
52 programs and shell scripts, for example:
54 % make install PREFIX=~/
56 If `PREFIX=...' is omitted, the prefix of the directory tree of the
57 specified emacs command is used (perhaps /usr/local).
59 For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
60 will create the following directory tree:
62 /usr/local/share/emacs/site-lisp/mel/ --- MEL
64 You can specify other optional settings by editing the file
65 MEL-CFG. Please read comments in it.
68 load-path (for Emacs or MULE)
69 =============================
71 If you are using Emacs or Mule, please add directory of MEL to
72 load-path. If you install by default setting, you can write
73 subdirs.el for example:
75 --------------------------------------------------------------------
76 (normal-top-level-add-to-load-path '("apel" "mel"))
77 --------------------------------------------------------------------
79 If you are using XEmacs, there are no need of setting about
89 Command mime-encode-region (START END ENCODING)
91 Encode region START to END of current buffer using ENCODING.
93 Command mime-decode-region (start end encoding)
95 Decode region START to END of current buffer using ENCODING.
97 Command base64-encode-region (start end)
99 Encode current region by base64.
100 START and END are buffer positions.
102 This function calls internal base64 encoder if size of region is
103 smaller than `base64-internal-encoding-limit', otherwise it calls
104 external base64 encoder specified by `base64-external-encoder'. In
105 this case, you must install the program (maybe mmencode included in
106 metamail or XEmacs package).
108 Command base64-decode-region (start end)
110 Decode current region by base64.
111 START and END are buffer positions.
113 This function calls internal base64 decoder if size of region is
114 smaller than `base64-internal-decoding-limit', otherwise it calls
115 external base64 decoder specified by `base64-external-decoder'. In
116 this case, you must install the program (maybe mmencode included in
117 metamail or XEmacs package).
119 Command quoted-printable-encode-region (start end)
121 Encode region START to END of current buffer using quoted-printable.
123 Command quoted-printable-decode-region (start end)
125 Decode region START to END of current buffer using quoted-printable.
127 Command uuencode-encode-region (start end)
129 Encode region START to END of current buffer using uuencode.
131 Command uuencode-decode-region (start end)
133 Decode region START to END of current buffer using uuencode.
135 Command gzip64-encode-region (start end)
137 Encode region START to END of current buffer using x-gzip64.
139 Command gzip64-decode-region (start end)
141 Decode region START to END of current buffer using x-gzip64.
143 Variable mime-encoding-method-alist
145 Alist of encoding vs. corresponding method to encode region.
146 Each element looks like (STRING . FUNCTION) or (STRING . nil).
147 STRING is content-transfer-encoding.
148 FUNCTION is region encoder and nil means not to encode.
150 Variable mime-decoding-method-alist
152 Alist of encoding vs. corresponding method to decode region.
153 Each element looks like (STRING . FUNCTION).
154 STRING is content-transfer-encoding.
155 FUNCTION is region decoder.
160 Command mime-insert-encoded-file (FILENAME ENCODING)
162 Insert file FILENAME encoded by ENCODING format.
164 Command base64-insert-encoded-file (FILENAME)
166 Insert base64 encoded file.
168 Command quoted-printable-insert-encoded-file (FILENAME)
170 Insert quoted-printable encoded file.
172 Command uuencode-insert-encoded-file (FILENAME)
174 Insert uuencode encoded file.
176 Command gzip64-insert-encoded-file (FILENAME)
178 Insert gzip64 encoded file.
180 Variable mime-file-encoding-method-alist
182 Alist of encoding vs. corresponding method to insert encoded file.
183 Each element looks like (STRING . FUNCTION).
184 STRING is content-transfer-encoding.
185 FUNCTION is function to insert encoded file.
190 Function base64-encode-string (STRING)
192 Encode STRING to base64, and return the result.
194 Function base64-decode-string (STRING)
196 Decode STRING which is encoded in base64, and return the result.
198 Function q-encoding-encode-string (STRING &optional MODE)
200 Encode STRING as Q-encoding of encoded-word.
201 MODE allows `text', `comment', `phrase' or nil. Default value is
204 Function q-encoding-decode-string (STRING)
206 Decode STRING as Q-encoding of encoded-word.
208 Function base64-encoded-length (STRING)
210 Return length of base64 encoded STRING.
212 Function q-encoded-length (STRING &optional MODE)
214 Return length of Q-encoding encoded STRING.
215 MODE allows `text', `comment', `phrase' or nil. Default value is
222 If you write bug-reports and/or suggestions for improvement, please
223 send them to the tm Mailing List:
225 bug-tm-en@chamonix.jaist.ac.jp (English)
226 bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
228 Via the tm ML, you can report tm bugs, obtain the latest release of
229 tm, and discuss future enhancements to tm. To join the tm ML, send
232 tm-ja-admin@chamonix.jaist.ac.jp (Japanese)
233 tm-en-admin@chamonix.jaist.ac.jp (English)
235 Since the user registration is done manually, please write the mail
236 body in human-recognizable language (^_^).