1 [README for FLIM (English Version)]
6 FLIM is a library to provide basic features about message
7 representation or encoding. It consists of following
10 std11.el --- STD 11 (RFC 822) parser and utility
12 mime-def.el --- Definitions about MIME format
14 MEL: MIME encoder/decoder
15 mel.el --- main module
16 mel-dl.el --- base64 (b-encoding) encoder/decoder
17 (for Emacs 20 with dynamic loading support)
18 mel-b.el --- base64 (b-encoding) encoder/decoder
20 mel-q.el --- quoted-printable and q-encoding encoder/decoder
21 mel-u.el --- unofficial module for uuencode
22 mel-g.el --- unofficial module for gzip64
24 eword: encoded-word encoder/decoder
25 eword-decode.el --- encoded-word decoder
26 eword-encode.el --- encoded-word encoder
28 mime-lib.el --- MIME entity library
30 mime-parse.el --- MIME parser
32 mailcap.el --- mailcap parser and utility
38 (0) before installing it, please install APEL package. APEL package
41 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
43 (1-a) run in expanded place
45 If you don't want to install other directories, please do only
50 You can specify the emacs command name, for example
52 % make install EMACS=xemacs
54 If `EMACS=...' is omitted, EMACS=emacs is used.
58 If you want to install other directories, please do following:
62 You can specify the emacs command name, for example
64 % make install EMACS=xemacs
66 If `EMACS=...' is omitted, EMACS=emacs is used.
68 You can specify the prefix of the directory tree for Emacs Lisp
69 programs and shell scripts, for example:
71 % make install PREFIX=~/
73 If `PREFIX=...' is omitted, the prefix of the directory tree of the
74 specified emacs command is used (perhaps /usr/local).
76 For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
77 will create the following directory tree:
79 /usr/local/share/emacs/site-lisp/flim/ --- FLIM
81 You can specify site-lisp directory, for example
83 % make install LISPDIR=~/share/emacs/lisp
85 If `LISPDIR=...' is omitted, site-lisp directory of the specified
86 emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
87 /usr/local/lib/xemacs/site-lisp).
89 You can specify other optional settings by editing the file
90 FLIM-CFG. Please read comments in it.
93 load-path (for Emacs or MULE)
94 =============================
96 If you are using Emacs or Mule, please add directory of FLIM to
97 load-path. If you install by default setting, you can write
98 subdirs.el for example:
100 --------------------------------------------------------------------
101 (normal-top-level-add-to-load-path '("apel" "flim"))
102 --------------------------------------------------------------------
104 If you are using XEmacs, there are no need of setting about
114 Command mime-encode-region (START END ENCODING)
116 Encode region START to END of current buffer using ENCODING.
118 Command mime-decode-region (start end encoding)
120 Decode region START to END of current buffer using ENCODING.
122 Command base64-encode-region (start end)
124 Encode current region by base64.
125 START and END are buffer positions.
127 This function calls internal base64 encoder if size of region is
128 smaller than `base64-internal-encoding-limit', otherwise it calls
129 external base64 encoder specified by `base64-external-encoder'. In
130 this case, you must install the program (maybe mmencode included in
131 metamail or XEmacs package).
133 Command base64-decode-region (start end)
135 Decode current region by base64.
136 START and END are buffer positions.
138 This function calls internal base64 decoder if size of region is
139 smaller than `base64-internal-decoding-limit', otherwise it calls
140 external base64 decoder specified by `base64-external-decoder'. In
141 this case, you must install the program (maybe mmencode included in
142 metamail or XEmacs package).
144 Command quoted-printable-encode-region (start end)
146 Encode current region by quoted-printable.
147 START and END are buffer positions.
149 This function calls internal quoted-printable encoder if size of
150 region is smaller than `quoted-printable-internal-encoding-limit',
151 otherwise it calls external quoted-printable encoder specified by
152 `quoted-printable-external-encoder'. In this case, you must install
153 the program (maybe mmencode included in metamail or XEmacs package).
155 Command quoted-printable-decode-region (start end)
157 Decode current region by quoted-printable.
158 START and END are buffer positions.
160 This function calls internal quoted-printable decoder if size of
161 region is smaller than `quoted-printable-internal-decoding-limit',
162 otherwise it calls external quoted-printable decoder specified by
163 `quoted-printable-external-decoder'. In this case, you must install
164 the program (maybe mmencode included in metamail or XEmacs package).
166 Command uuencode-encode-region (start end)
168 Encode region START to END of current buffer using uuencode.
170 Command uuencode-decode-region (start end)
172 Decode region START to END of current buffer using uuencode.
174 Command gzip64-encode-region (start end)
176 Encode region START to END of current buffer using x-gzip64.
178 Command gzip64-decode-region (start end)
180 Decode region START to END of current buffer using x-gzip64.
182 Variable mime-encoding-method-alist
184 Alist of encoding vs. corresponding method to encode region.
185 Each element looks like (STRING . FUNCTION) or (STRING . nil).
186 STRING is content-transfer-encoding.
187 FUNCTION is region encoder and nil means not to encode.
189 Variable mime-decoding-method-alist
191 Alist of encoding vs. corresponding method to decode region.
192 Each element looks like (STRING . FUNCTION).
193 STRING is content-transfer-encoding.
194 FUNCTION is region decoder.
199 Command mime-insert-encoded-file (FILENAME ENCODING)
201 Insert file FILENAME encoded by ENCODING format.
203 Command base64-insert-encoded-file (FILENAME)
205 Encode contents of file FILENAME to base64, and insert the result.
207 It calls external base64 encoder specified by
208 `base64-external-encoder'. So you must install the program (maybe
209 mmencode included in metamail or XEmacs package).
211 Command quoted-printable-insert-encoded-file (FILENAME)
213 Insert quoted-printable encoded file.
215 Command uuencode-insert-encoded-file (FILENAME)
217 Insert uuencode encoded file.
219 Command gzip64-insert-encoded-file (FILENAME)
221 Insert gzip64 encoded file.
223 Variable mime-file-encoding-method-alist
225 Alist of encoding vs. corresponding method to insert encoded file.
226 Each element looks like (STRING . FUNCTION).
227 STRING is content-transfer-encoding.
228 FUNCTION is function to insert encoded file.
233 Function base64-encode-string (STRING)
235 Encode STRING to base64, and return the result.
237 Function base64-decode-string (STRING)
239 Decode STRING which is encoded in base64, and return the result.
241 Function q-encoding-encode-string (STRING &optional MODE)
243 Encode STRING to Q-encoding of encoded-word, and return the result.
244 MODE allows `text', `comment', `phrase' or nil. Default value is
247 Function q-encoding-decode-string (STRING)
249 Decode STRING which is encoded in Q-encoding and return the result.
251 Function base64-encoded-length (STRING)
253 Return length of base64 encoded STRING.
255 Function q-encoded-length (STRING &optional MODE)
257 Return length of Q-encoding encoded STRING.
258 MODE allows `text', `comment', `phrase' or nil. Default value is
265 If you write bug-reports and/or suggestions for improvement, please
266 send them to the tm Mailing List:
268 bug-tm-en@chamonix.jaist.ac.jp (English)
269 bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
271 Via the tm ML, you can report FLIM bugs, obtain the latest release
272 of FLIM, and discuss future enhancements to FLIM. To join the tm ML,
273 send an empty e-mail to
275 tm-en-help@chamonix.jaist.ac.jp (English)
276 tm-ja-help@chamonix.jaist.ac.jp (Japanese)