README.en

   1 What's EMY?
   2 ============
   3
   4   EMY is a library to provide MIME feature for GNU Emacs.
   5
   6   EMY implements SEMI API. You can use MUA conformant to SEMI API
   7   without any modification. This package will implements SEMI 1.14
   8   API when it is defined. Right now, there's no document defines
   9   SEMI 1.13 API. Until SEMI 1.14 API is defined, EMY tries to keep
  10   same API as much as possible but something might be changed.
  11
  12   MIME is a proposed internet standard for including content and
  13   headers other than (ASCII) plain text in messages.
  14
  15         RFC 2045 : Internet Message Bodies
  16         RFC 2046 : Media Types
  17         RFC 2047 : Message Header Extensions
  18         RFC 2048 : MIME Registration Procedures
  19         RFC 2049 : MIME Conformance
  20
  21   EMY has the following features:
  22
  23         - MIME message viewer   (mime-view-mode) (RFC 2045 .. 2049)
  24         - MIME message composer (mime-edit-mode) (RFC 2045 .. 2049)
  25
  26   MIME message viewer and composer also support following features:
  27
  28         - filename handling by Content-Disposition field (RFC 2183)
  29         - text/richtext (RFC 1521; obsolete; preview only)
  30         - text/enriched (RFC 1896)
  31         - External method configuration by mailcap (RFC 1524)
  32
  33   Notice that this package does not contain MIME extender for any
  34   MUAs.  They are released as separated packages.
  35
  36
  37 Required environment
  38 ====================
  39
  40   EMY supports XEmacs 21.1 or later with mule, and Emacs 20.4 or later.
  41
  42   EMY does not support any other version. If you write patches to
  43   support version, those might be applied.  It depends on the
  44   cleanliness of the patch.
  45
  46   EMY requires APEL (9.20 or later) and FLIM (1.13.1 or later)
  47   package.  Please install them before installing it.  APEL package is
  48   available at:
  49
  50         ftp://ftp.m17n.org/pub/mule/apel/
  51
  52   and FLIM package is available at:
  53
  54         ftp://ftp.m17n.org/pub/mule/flim/flim-1.13/
  55
  56   Note: FLIM is also package name and API name. There's some packges
  57   such as FLAM-DOODLE and SLIM which implements FLIM API. EMY
  58   does not require any specific implementation.
  59
  60
  61 Installation
  62 ============
  63
  64 (a) run in expanded place
  65
  66   If you don't want to install other directories, please do only
  67   following:
  68
  69         % make
  70
  71   You can specify the emacs command name, for example
  72
  73         % make EMACS=emacs-20.5
  74
  75   If `EMACS=...' is omitted, EMACS=emacs is used.
  76
  77 (b) make install
  78
  79   If you want to install other directories, please do following:
  80
  81         % make install
  82
  83   You can specify the emacs command name, for example
  84
  85         % make install EMACS=xemacs
  86
  87   If `EMACS=...' is omitted, EMACS=emacs is used.
  88
  89   You can specify the prefix of the directory tree for Emacs Lisp
  90   programs and shell scripts, for example:
  91
  92         % make install PREFIX=~/
  93
  94   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  95   specified emacs command is used (perhaps /usr/local).
  96
  97   For example, if PREFIX=/usr/local and Emacs 20.4 is specified, it
  98   will create the following directory tree:
  99
 100         /usr/local/share/emacs/20.4/site-lisp/  --- emu
 101         /usr/local/share/emacs/site-lisp/apel/   --- APEL
 102         /usr/local/share/emacs/site-lisp/flim/   --- FLIM
 103         /usr/local/share/emacs/site-lisp/semi/   --- SEMI
 104
 105   You can specify site-lisp directory, for example
 106
 107         % make install LISPDIR=~/share/emacs/lisp
 108
 109   If `LISPDIR=...' is omitted, site-lisp directory of the specified
 110   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
 111   /usr/local/lib/xemacs/site-lisp).
 112
 113   If the emu modules (included in APEL package) have been installed in
 114   the non-standard directory, you should specify where they will be
 115   found, for example:
 116
 117         % make install VERSION_SPECIFIC_LISPDIR=~/elisp
 118
 119 (c) install as a XEmacs package
 120
 121   If you want to install to XEmacs package directory, please do
 122   following:
 123
 124         % make install-package
 125
 126   You can specify the emacs command name, for example
 127
 128         % make install-package XEMACS=xemacs-21
 129
 130   If `XEMACS=...' is omitted, XEMACS=xemacs is used.
 131
 132   You can specify the package directory, for example:
 133
 134         % make install PACKAGEDIR=~/.xemacs
 135
 136   If `PACKAGEDIR=...' is omitted, the first existing package
 137   directory is used.
 138
 139   Notice that XEmacs package system requires XEmacs 21.0 or later.
 140
 141 (a,b,c)
 142
 143   You can specify other optional settings by editing the file
 144   ${archive}/SEMI-CFG.  Please read ${archive}/README.en and comments
 145   in ${archive}/SEMI-CFG.
 146
 147
 148 Initialization
 149 ==============
 150
 151 (a) load-path
 152
 153   If you are using Emacs or Mule, please add directory of emu, apel,
 154   flim and semi to load-path.  If you install by default setting, you
 155   can write subdirs.el for example:
 156
 157   --------------------------------------------------------------------
 158   (normal-top-level-add-to-load-path
 159    '("apel" "flim" "semi"))
 160   --------------------------------------------------------------------
 161
 162   If you are using XEmacs, there are no need of setting about
 163   load-path.
 164
 165 (b) mime-setup
 166
 167   Please insert the following into your ~/.emacs:
 168
 169         (load "mime-setup")
 170
 171
 172 Documentation
 173 =============
 174
 175   To get started, please read ${archive}/README.en.
 176
 177   RFC's 822, 1524, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and
 178   2049 are available via anonymous ftp:
 179
 180         ftp://ftp.merit.edu/internet/documents/rfc/
 181
 182
 183 Mailing lists
 184 =============
 185
 186   If you write bug-reports and/or suggestions for improvement, please
 187   send them to the EMACS-MIME Mailing List:
 188
 189         emacs-mime-en@m17n.org  (English)
 190         emacs-mime-ja@m17n.org  (Japanese)
 191
 192   Via the emacs-mime ML, you can report EMY bugs, obtain the latest
 193   release of EMY, and discuss future enhancements to EMY.  To join the
 194   emacs-mime ML, send a e-mail with help in the body of your message to
 195
 196         emacs-mime-en-ctl@m17n.org      (English)
 197         emacs-mime-ja-ctl@m17n.org      (Japanese)
 198
 199   Notice that you should not send mail to author(s), such as
 200   morioka@jaist.ac.jp, directly.  Because your problem may occur in
 201   other environments (if not, it might be your problem, not bug of
 202   EMY).  We should discuss in the emacs-mime mailing lists.  Anyway
 203   direct-mail for authors might be ignored.  Please send mail to the
 204   EMACS-MIME mailing lists.
 205
 206
 207 CVS based development
 208 =====================
 209
 210   If you would like to join CVS based development, please send mail to
 211
 212         cvs@cvs.m17n.org
 213
 214   with your account name and your public key for ssh.  cvsroot is
 215   :ext:cvs@cvs.m17n.org:/cvs/root.
 216
 217   If you cannot use ssh, please send UNIX /etc/passwd style crypted
 218   password.  you can commit with the cvsroot
 219   :pserver:<accountname>@cvs.m17n.org:/cvs/root.
 220
 221   We hope you will join the open development.
 222
 223
 224 Authors
 225 =======
 226
 227 Original authors
 228
 229     MORIOKA Tomohiko <morioka@jaist.ac.jp>
 230         (the author of mime-view and various parts of SEMI)
 231     UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
 232         (the author of mime.el of emacs-mime-tools.  mime.el is the
 233         origin of mime-edit.el of SEMI)
 234
 235 Other authors
 236
 237     Shuhei KOBAYASHI  <shuhei-k@jaist.ac.jp>
 238         (a major author of signature.el and a lot of codes)
 239     MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
 240         (anonymous ftp codes of mime-play.el)
 241     OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
 242         (a major author of mime-partial.el and signature.el)
 243
 244     Steinar Bang <sb@metis.no>
 245     Steven L. Baur <steve@miranova.com>
 246     Kevin Broadey <KevinB@bartley.demon.co.uk>
 247     Alastair Burt <burt@dfki.uni-kl.de>
 248     Eric Ding <ericding@San-Jose.ate.slb.com>
 249     Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
 250     Simon Josefsson <jas@pdc.kth.se>
 251     Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
 252     Carsten Leonhardt <leo@arioch.tng.oche.de>
 253     Pekka Marjola <marjola@bilbo.ntc.nokia.com>
 254     Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
 255     Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
 256     Alexandre Oliva <oliva@dcc.unicamp.br>
 257     François Pinard <pinard@iro.umontreal.ca>
 258     Artur Pioro <artur@flugor.if.uj.edu.pl>
 259     Dan Rich <drich@morpheus.corp.sgi.com>
 260         (contribute to evolve mime-image.el with XEmacs)
 261     Katsumi Yamaoka <yamaoka@jpl.org>