(make install): Add LISPDIR.
[elisp/flim.git] / README.en
index 8b4cfb5..f9d4e3c 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,6 +1,6 @@
 [README for MEL (English Version)]
 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-$Id: README.en,v 1.3 1997-04-30 12:59:46 morioka Exp $
+$Id: README.en,v 1.8 1997-05-15 05:43:48 morioka Exp $
 
 What's MEL
 ===========
@@ -61,6 +61,14 @@ Installation
 
        /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.
 
@@ -96,19 +104,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 +185,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)
 
@@ -183,13 +223,13 @@ Function base64-decode-string (STRING)
 
 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)