(mime-content-disposition-parameter): Don't strip quoted-string.
[elisp/flim.git] / README.en
index af302da..195ab83 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,18 +1,33 @@
-[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)]
 
-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    --- MIME library
+
+        mime-def.el --- Definitions about MIME format
+
+       mime-parse.el --- MIME parser
+
+       mel.el --- MIME encoder/decoder
+           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
+
+       eword-decode.el --- encoded-word decoder
+       eword-encode.el --- encoded-word encoder
+
+    mailcap.el --- mailcap parser and utility
 
 
 Installation
@@ -59,21 +74,29 @@ Installation
   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
+       /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).
 
   You can specify other optional settings by editing the file
-  MEL-CFG.  Please read comments in it.
+  FLIM-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
+  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" "mel"))
+  (normal-top-level-add-to-load-path '("apel" "flim"))
   --------------------------------------------------------------------
 
   If you are using XEmacs, there are no need of setting about
@@ -96,19 +119,47 @@ Command mime-decode-region (start end encoding)
 
 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)
 
@@ -149,7 +200,11 @@ Command mime-insert-encoded-file (FILENAME ENCODING)
 
 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)
 
@@ -175,21 +230,21 @@ String
 
 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)
 
@@ -211,12 +266,9 @@ Bug reports
        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 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
 
-  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)