README.en

   1 [README for SEMI kernel package (English Version)]
   2
   3 What's SEMI?
   4 ============
   5
   6   SEMI is a library to provide MIME feature for GNU Emacs.  MIME is a
   7   proposed internet standard for including content and headers other
   8   than (ASCII) plain text in messages.
   9
  10         RFC 2045 : Internet Message Bodies
  11         RFC 2046 : Media Types
  12         RFC 2047 : Message Header Extensions
  13         RFC 2048 : MIME Registration Procedures
  14         RFC 2049 : MIME Conformance
  15
  16   SEMI has the following features:
  17
  18         - MIME message viewer   (mime-view-mode) (RFC 2045 .. 2049)
  19         - MIME message composer (mime-edit-mode) (RFC 2045 .. 2049)
  20
  21   MIME message viewer and composer also support following features:
  22
  23         - filename handling by Content-Disposition field (RFC 1806)
  24         - PGP/MIME security Multiparts (RFC 2015)
  25         - application/pgp (draft-kazu-pgp-mime-00.txt; obsolete)
  26         - text/richtext (RFC 1521; obsolete; preview only)
  27         - text/enriched (RFC 1896)
  28         - External method configuration by mailcap (RFC 1524)
  29
  30   Notice that this package does not contain MIME extender for any
  31   MUAs.  They are released as separated packages.
  32
  33
  34 Required environment
  35 ====================
  36
  37   SEMI supports XEmacs 20.2 or later with mule, and Emacs 20.
  38
  39   SEMI does not support anything older than Emacs 19.28 or XEmacs
  40   19.14.  SEMI also does not support Emacs 19.29 to 19.34, XEmacs
  41   19.15 or XEmacs 20.2 without mule, but SEMI may work with them.
  42
  43   SEMI requires APEL (8.17 or later) and FLIM (1.9.2 or later)
  44   package.  Please install them before installing it.  APEL package is
  45   available at:
  46
  47         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  48
  49   and FLIM package is available at:
  50
  51         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/flim/
  52
  53   PGP/MIME and application/pgp require mailcrypt or tiny-pgp package.
  54
  55   The package enriched.el is required to compose text/enriched, so if
  56   you use Emacs anything 19.28 or older (including official version of
  57   MULE 2.3), WYSIWYG composing for text/enriched is not available.
  58
  59
  60 Installation
  61 ============
  62
  63         % make install
  64
  65   You can specify the emacs command name, for example
  66
  67         % make install EMACS=xemacs
  68
  69   If `EMACS=...' is omitted, EMACS=emacs is used.
  70
  71   You can specify the prefix of the directory tree for Emacs Lisp
  72   programs and shell scripts, for example:
  73
  74         % make install PREFIX=~/
  75
  76   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  77   specified emacs command is used (perhaps /usr/local).
  78
  79   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  80   will create the following directory tree:
  81
  82         /usr/local/share/emacs/19.34/site-lisp/  --- emu
  83         /usr/local/share/emacs/site-lisp/apel/   --- APEL
  84         /usr/local/share/emacs/site-lisp/flim/   --- FLIM
  85         /usr/local/share/emacs/site-lisp/semi/   --- SEMI
  86
  87   You can specify site-lisp directory, for example
  88
  89         % make install LISPDIR=~/share/emacs/lisp
  90
  91   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  92   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  93   /usr/local/lib/xemacs/site-lisp).
  94
  95   You can specify other optional settings by editing the file
  96   ${archive}/SEMI-CFG.  Please read ${archive}/README.en and comments
  97   in ${archive}/SEMI-CFG.
  98
  99
 100 Initialization
 101 ==============
 102
 103 (a) load-path
 104
 105   If you are using Emacs or Mule, please add directory of emu, apel,
 106   flim and semi to load-path.  If you install by default setting, you
 107   can write subdirs.el for example:
 108
 109   --------------------------------------------------------------------
 110   (normal-top-level-add-to-load-path
 111    '("apel" "flim" "semi"))
 112   --------------------------------------------------------------------
 113
 114   If you are using XEmacs, there are no need of setting about
 115   load-path.
 116
 117 (b) mime-setup
 118
 119   Please insert the following into your ~/.emacs:
 120
 121         (load "mime-setup")
 122
 123
 124 Documentation
 125 =============
 126
 127   To get started, please read ${archive}/README.en.
 128
 129   RFC's 822, 1524, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and
 130   2049 are available via anonymous ftp:
 131
 132         ftp://ftp.merit.edu/internet/documents/rfc/
 133
 134
 135 Mailing lists
 136 =============
 137
 138   If you write bug-reports and/or suggestions for improvement, please
 139   send them to the tm Mailing List:
 140
 141         bug-tm-en@chamonix.jaist.ac.jp  (English)
 142         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 143
 144   Via the tm ML, you can report SEMI bugs, obtain the latest release
 145   of SEMI, and discuss future enhancements to SEMI.  To join the tm
 146   ML, send an empty e-mail to
 147
 148         tm-en-help@chamonix.jaist.ac.jp (English)
 149         tm-ja-help@chamonix.jaist.ac.jp (Japanese)
 150
 151   Notice that you should not send mail to author(s), such as
 152   morioka@jaist.ac.jp, directly.  Because your problem may occur in
 153   other environments (if not, it might be your problem, not bug of
 154   SEMI).  We should discuss in the tm mailing lists.  Anyway
 155   direct-mail for authors might be ignored.  Please send mail to the
 156   tm mailing lists.
 157
 158
 159 CVS based development
 160 =====================
 161
 162   If you would like to join CVS based development, please send mail to
 163
 164         cvs@chamonix.jaist.ac.jp
 165
 166   with your account name and UNIX style crypted password.  We hope you
 167   will join the open development.
 168
 169
 170 Authors
 171 =======
 172
 173 Original authors
 174
 175     MORIOKA Tomohiko <morioka@jaist.ac.jp>
 176         (the author of mime-view and various parts of SEMI)
 177     UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
 178         (the author of mime.el of emacs-mime-tools.  mime.el is the
 179         origin of mime-edit.el of SEMI)
 180
 181 Other authors
 182
 183     Shuhei KOBAYASHI  <shuhei-k@jaist.ac.jp>
 184         (a major author of signature.el and a lot of codes)
 185     MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
 186         (anonymous ftp codes of mime-play.el)
 187     OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
 188         (a major author of mime-partial.el and signature.el)
 189
 190     Steinar Bang <sb@metis.no>
 191     Steven L. Baur <steve@miranova.com>
 192     Kevin Broadey <KevinB@bartley.demon.co.uk>
 193     Alastair Burt <burt@dfki.uni-kl.de>
 194     Eric Ding <ericding@San-Jose.ate.slb.com>
 195     Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
 196     Simon Josefsson <jas@pdc.kth.se>
 197     Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
 198     Carsten Leonhardt <leo@arioch.tng.oche.de>
 199     Pekka Marjola <marjola@bilbo.ntc.nokia.com>
 200     Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
 201     Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
 202     Alexandre Oliva <oliva@dcc.unicamp.br>
 203     François Pinard <pinard@iro.umontreal.ca>
 204     Artur Pioro <artur@flugor.if.uj.edu.pl>
 205     Dan Rich <drich@morpheus.corp.sgi.com>
 206         (contribute to evolve mime-image.el with XEmacs)
 207     Katsumi Yamaoka <yamaoka@ga.sony.co.jp>