-[README for SEMI kernel package (English Version)]
-by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-$Id: README.en,v 1.4 1997-09-28 20:41:57 morioka Exp $
+What's EMY?
+============
-What's SEMI?
-------------
+ EMY is a library to provide MIME feature for GNU Emacs.
- SEMI is a library to provide MIME feature for GNU Emacs. It stands
- for "SEMI is Emacs MIME Interfaces". MIME is a proposed internet
- standard for including content and headers other than (ASCII) plain
- text in messages.
+ 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
RFC 2048 : MIME Registration Procedures
RFC 2049 : MIME Conformance
- SEMI has the following features:
+ EMY has the following features:
- - MIME style multilingual header (RFC 2047)
- 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)
Notice that this package does not contain MIME extender for any
- MUAs and external methods. They are released as separated packages.
+ MUAs. They are released as separated packages.
Required environment
---------------------
+====================
+
+ EMY supports XEmacs 21.1 or later with mule, and Emacs 20.4 or later.
- SEMI supports XEmacs 20.2 or later with mule, and Emacs 20.
+ 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 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 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:
- If you use Emacs 20, don't set `enable-multibyte-characters' to
- nil. (Maybe non mule setting requires to modify emu. In addition,
- it is better to use terminal-coding-system feature)
+ ftp://ftp.m17n.org/pub/mule/apel/
- SEMI requires APEL and MEL package. Please install them before
- installing it. APEL package
- is available at:
+ and FLIM package is available at:
- ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
+ ftp://ftp.m17n.org/pub/mule/flim/flim-1.13/
- and MEL package is available at:
+ 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.
- ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/libs/
- Notice that latest version of XEmacs may have latest version of APEL
- and MEL, so you should not install them.
+Installation
+============
- PGP/MIME and application/pgp require mailcrypt or tiny-pgp package.
+(a) run in expanded place
- 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.
+ If you don't want to install other directories, please do only
+ following:
+ % make
-Installation
-------------
+ 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
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/bitmap/ --- BITMAP-MULE
- /usr/local/share/emacs/site-lisp/mu/ --- MU
- /usr/local/share/emacs/site-lisp/mel/ --- MEL
+ /usr/local/share/emacs/site-lisp/flim/ --- FLIM
/usr/local/share/emacs/site-lisp/semi/ --- SEMI
You can specify site-lisp directory, for example
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
- semi/SEMI-CFG. Please read semi/README.en and comments in
- semi/SEMI-CFG.
+ ${archive}/SEMI-CFG. Please read ${archive}/README.en and comments
+ in ${archive}/SEMI-CFG.
Initialization
---------------
+==============
(a) load-path
If you are using Emacs or Mule, please add directory of emu, apel,
- bitmap, mu, mel and semi to load-path. If you install by default
- setting, you can write subdirs.el for example:
+ flim and semi to load-path. If you install by default setting, you
+ can write subdirs.el for example:
--------------------------------------------------------------------
(normal-top-level-add-to-load-path
- '("apel" "bitmap" "mu" "mel" "semi"))
+ '("apel" "flim" "semi"))
--------------------------------------------------------------------
If you are using XEmacs, there are no need of setting about
Documentation
--------------
+=============
- To get started, please read semi/README.en.
+ To get started, please read ${archive}/README.en.
- RFC's 822, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and 2049
- are available via anonymous ftp:
- ftp://ds.internic.net/rfc/
+ RFC's 822, 1524, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and
+ 2049 are available via anonymous ftp:
+ ftp://ftp.merit.edu/internet/documents/rfc/
-Bug reports
------------
-
- If you write bug-reports and/or suggestions for improvement, please
- send them to the tm Mailing List:
- bug-tm-en@chamonix.jaist.ac.jp (English)
- bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
+Mailing lists
+=============
- 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)
-
- Since the user registration is done manually, please write the mail
- body in human-recognizable language (^_^).
+ If you write bug-reports and/or suggestions for improvement, please
+ send them to the EMACS-MIME Mailing List:
+
+ emacs-mime-en@m17n.org (English)
+ emacs-mime-ja@m17n.org (Japanese)
+
+ 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
+
+ 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
+ EMY). We should discuss in the emacs-mime mailing lists. Anyway
+ direct-mail for authors might be ignored. Please send mail to the
+ EMACS-MIME mailing lists.
+
+
+CVS based development
+=====================
+
+ If you would like to join CVS based development, please send mail to
+
+ cvs@cvs.m17n.org
+
+ with your account name and UNIX style crypted password. We hope you
+ will join the open development.
+
+
+Authors
+=======
+
+Original authors
+
+ MORIOKA Tomohiko <morioka@jaist.ac.jp>
+ (the author of mime-view and various parts of SEMI)
+ UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
+ (the author of mime.el of emacs-mime-tools. mime.el is the
+ origin of mime-edit.el of SEMI)
+
+Other authors
+
+ Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
+ (a major author of signature.el and a lot of codes)
+ MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
+ (anonymous ftp codes of mime-play.el)
+ OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
+ (a major author of mime-partial.el and signature.el)
+
+ Steinar Bang <sb@metis.no>
+ Steven L. Baur <steve@miranova.com>
+ Kevin Broadey <KevinB@bartley.demon.co.uk>
+ Alastair Burt <burt@dfki.uni-kl.de>
+ Eric Ding <ericding@San-Jose.ate.slb.com>
+ Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
+ Simon Josefsson <jas@pdc.kth.se>
+ Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
+ Carsten Leonhardt <leo@arioch.tng.oche.de>
+ Pekka Marjola <marjola@bilbo.ntc.nokia.com>
+ Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
+ Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
+ Alexandre Oliva <oliva@dcc.unicamp.br>
+ François Pinard <pinard@iro.umontreal.ca>
+ 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@jpl.org>