Synch with EMIKO 1.13.12
[elisp/semi.git] / README.en
index fb71c26..249dd36 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,11 +1,16 @@
-[README for SEMI kernel package (English Version)]
-
-What's SEMI?
+What's EMY?
 ============
 
-  SEMI is a library to provide MIME feature for GNU Emacs.  MIME is a
-  proposed internet standard for including content and headers other
-  than (ASCII) plain text in messages.
+  EMY is a library to provide MIME feature for GNU Emacs.
+
+  EMY implements SEMI API. You can use MUA conformant to SEMI API
+  without any modification. This package will implements SEMI 1.14
+  API when it is defined. Right now, there's no document defines
+  SEMI 1.13 API. Until SEMI 1.14 API is defined, EMY tries to keep
+  same API as much as possible but something might be changed.
+
+  MIME is a proposed internet standard for including content and
+  headers other than (ASCII) plain text in messages.
 
        RFC 2045 : Internet Message Bodies
        RFC 2046 : Media Types
@@ -13,16 +18,14 @@ What's SEMI?
        RFC 2048 : MIME Registration Procedures
        RFC 2049 : MIME Conformance
 
-  SEMI has the following features:
+  EMY has the following features:
 
        - MIME message viewer   (mime-view-mode) (RFC 2045 .. 2049)
        - MIME message composer (mime-edit-mode) (RFC 2045 .. 2049)
 
   MIME message viewer and composer also support following features:
 
-       - filename handling by Content-Disposition field (RFC 1806)
-       - PGP/MIME security Multiparts (RFC 2015)
-       - application/pgp (draft-kazu-pgp-mime-00.txt; obsolete)
+       - filename handling by Content-Disposition field (RFC 2183)
        - text/richtext (RFC 1521; obsolete; preview only)
        - text/enriched (RFC 1896)
        - External method configuration by mailcap (RFC 1524)
@@ -34,32 +37,47 @@ What's SEMI?
 Required environment
 ====================
 
-  SEMI supports XEmacs 20.2 or later with mule, and Emacs 20.
+  EMY supports XEmacs 21.1 or later with mule, and Emacs 20.4 or later.
 
-  SEMI does not support anything older than Emacs 19.28 or XEmacs
-  19.14.  SEMI also does not support Emacs 19.29 to 19.34, XEmacs
-  19.15 or XEmacs 20.2 without mule, but SEMI may work with them.
+  EMY does not support any other version. If you write patches to
+  support version, those might be applied.  It depends on the
+  cleanliness of the patch.
 
-  SEMI requires APEL (8.17 or later) and FLIM (1.9.2 or later)
+  EMY requires APEL (9.20 or later) and FLIM (1.13.1 or later)
   package.  Please install them before installing it.  APEL package is
   available at:
 
-       ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
+       ftp://ftp.m17n.org/pub/mule/apel/
 
   and FLIM package is available at:
 
-       ftp://ftp.jaist.ac.jp/pub/GNU/elisp/flim/
-
-  PGP/MIME and application/pgp require mailcrypt or tiny-pgp package.
+       ftp://ftp.m17n.org/pub/mule/flim/flim-1.13/
 
-  The package enriched.el is required to compose text/enriched, so if
-  you use Emacs anything 19.28 or older (including official version of
-  MULE 2.3), WYSIWYG composing for text/enriched is not available.
+  Note: FLIM is also package name and API name. There's some packges
+  such as FLAM-DOODLE and SLIM which implements FLIM API. EMY
+  does not require any specific implementation.
 
 
 Installation
 ============
 
+(a) run in expanded place
+
+  If you don't want to install other directories, please do only
+  following:
+
+       % make
+
+  You can specify the emacs command name, for example
+
+       % make EMACS=emacs-20.5
+
+  If `EMACS=...' is omitted, EMACS=emacs is used.
+
+(b) make install
+
+  If you want to install other directories, please do following:
+
        % make install
 
   You can specify the emacs command name, for example
@@ -76,10 +94,10 @@ Installation
   If `PREFIX=...' is omitted, the prefix of the directory tree of the
   specified emacs command is used (perhaps /usr/local).
 
-  For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
+  For example, if PREFIX=/usr/local and Emacs 20.4 is specified, it
   will create the following directory tree:
 
-       /usr/local/share/emacs/19.34/site-lisp/  --- emu
+       /usr/local/share/emacs/20.4/site-lisp/  --- emu
        /usr/local/share/emacs/site-lisp/apel/   --- APEL
        /usr/local/share/emacs/site-lisp/flim/   --- FLIM
        /usr/local/share/emacs/site-lisp/semi/   --- SEMI
@@ -92,6 +110,36 @@ Installation
   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
   /usr/local/lib/xemacs/site-lisp).
 
+  If the emu modules (included in APEL package) have been installed in
+  the non-standard directory, you should specify where they will be
+  found, for example:
+
+       % make install VERSION_SPECIFIC_LISPDIR=~/elisp
+
+(c) install as a XEmacs package
+
+  If you want to install to XEmacs package directory, please do
+  following:
+
+       % make install-package
+
+  You can specify the emacs command name, for example
+
+       % make install-package XEMACS=xemacs-21
+
+  If `XEMACS=...' is omitted, XEMACS=xemacs is used.
+
+  You can specify the package directory, for example:
+
+       % make install PACKAGEDIR=~/.xemacs
+
+  If `PACKAGEDIR=...' is omitted, the first existing package
+  directory is used.
+
+  Notice that XEmacs package system requires XEmacs 21.0 or later.
+
+(a,b,c)
+
   You can specify other optional settings by editing the file
   ${archive}/SEMI-CFG.  Please read ${archive}/README.en and comments
   in ${archive}/SEMI-CFG.
@@ -136,24 +184,24 @@ Mailing lists
 =============
 
   If you write bug-reports and/or suggestions for improvement, please
-  send them to the tm Mailing List:
+  send them to the EMACS-MIME Mailing List:
 
-       bug-tm-en@chamonix.jaist.ac.jp  (English)
-       bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
+       emacs-mime-en@m17n.org  (English)
+       emacs-mime-ja@m17n.org  (Japanese)
 
-  Via the tm ML, you can report SEMI bugs, obtain the latest release
-  of SEMI, and discuss future enhancements to SEMI.  To join the tm
-  ML, send an empty e-mail to
+  Via the emacs-mime ML, you can report EMY bugs, obtain the latest
+  release of EMY, and discuss future enhancements to EMY.  To join the
+  emacs-mime ML, send a e-mail with help in the body of your message to
 
-       tm-en-help@chamonix.jaist.ac.jp (English)
-       tm-ja-help@chamonix.jaist.ac.jp (Japanese)
+       emacs-mime-en-ctl@m17n.org      (English)
+       emacs-mime-ja-ctl@m17n.org      (Japanese)
 
   Notice that you should not send mail to author(s), such as
   morioka@jaist.ac.jp, directly.  Because your problem may occur in
   other environments (if not, it might be your problem, not bug of
-  SEMI).  We should discuss in the tm mailing lists.  Anyway
+  EMY).  We should discuss in the emacs-mime mailing lists.  Anyway
   direct-mail for authors might be ignored.  Please send mail to the
-  tm mailing lists.
+  EMACS-MIME mailing lists.
 
 
 CVS based development
@@ -161,7 +209,7 @@ CVS based development
 
   If you would like to join CVS based development, please send mail to
 
-       cvs@chamonix.jaist.ac.jp
+       cvs@cvs.m17n.org
 
   with your account name and UNIX style crypted password.  We hope you 
   will join the open development.
@@ -204,4 +252,4 @@ Other authors
     Artur Pioro <artur@flugor.if.uj.edu.pl>
     Dan Rich <drich@morpheus.corp.sgi.com>
         (contribute to evolve mime-image.el with XEmacs)
-    Katsumi Yamaoka <yamaoka@ga.sony.co.jp>
+    Katsumi Yamaoka <yamaoka@jpl.org>