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   If you use Emacs 20, don't set `enable-multibyte-characters' to
  44   nil. (Maybe non mule setting requires to modify emu.  In addition,
  45   it is better to use terminal-coding-system feature)
  46
  47   SEMI requires APEL (8.7 or later) and FLIM (1.2.0 or later) package.
  48   Please install them before installing it.  APEL package is available
  49   at:
  50
  51         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  52
  53   and FLIM package is available at:
  54
  55         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/flim/
  56
  57   PGP/MIME and application/pgp require mailcrypt or tiny-pgp package.
  58
  59   The package enriched.el is required to compose text/enriched, so if
  60   you use Emacs anything 19.28 or older (including official version of
  61   MULE 2.3), WYSIWYG composing for text/enriched is not available.
  62
  63
  64 Installation
  65 ============
  66
  67         % make install
  68
  69   You can specify the emacs command name, for example
  70
  71         % make install EMACS=xemacs
  72
  73   If `EMACS=...' is omitted, EMACS=emacs is used.
  74
  75   You can specify the prefix of the directory tree for Emacs Lisp
  76   programs and shell scripts, for example:
  77
  78         % make install PREFIX=~/
  79
  80   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  81   specified emacs command is used (perhaps /usr/local).
  82
  83   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  84   will create the following directory tree:
  85
  86         /usr/local/share/emacs/19.34/site-lisp/  --- emu
  87         /usr/local/share/emacs/site-lisp/apel/   --- APEL
  88         /usr/local/share/emacs/site-lisp/flim/   --- FLIM
  89         /usr/local/share/emacs/site-lisp/semi/   --- SEMI
  90
  91   You can specify site-lisp directory, for example
  92
  93         % make install LISPDIR=~/share/emacs/lisp
  94
  95   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  96   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  97   /usr/local/lib/xemacs/site-lisp).
  98
  99   You can specify other optional settings by editing the file
 100   ${archive}/SEMI-CFG.  Please read ${archive}/README.en and comments
 101   in ${archive}/SEMI-CFG.
 102
 103
 104 Initialization
 105 ==============
 106
 107 (a) load-path
 108
 109   If you are using Emacs or Mule, please add directory of emu, apel,
 110   flim and semi to load-path.  If you install by default setting, you
 111   can write subdirs.el for example:
 112
 113   --------------------------------------------------------------------
 114   (normal-top-level-add-to-load-path
 115    '("apel" "flim" "semi"))
 116   --------------------------------------------------------------------
 117
 118   If you are using XEmacs, there are no need of setting about
 119   load-path.
 120
 121 (b) mime-setup
 122
 123   Please insert the following into your ~/.emacs:
 124
 125         (load "mime-setup")
 126
 127
 128 Documentation
 129 =============
 130
 131   To get started, please read ${archive}/README.en.
 132
 133   RFC's 822, 1524, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and
 134   2049 are available via anonymous ftp:
 135
 136         ftp://ftp.merit.edu/internet/documents/rfc/
 137
 138
 139 Mailing lists
 140 =============
 141
 142   If you write bug-reports and/or suggestions for improvement, please
 143   send them to the tm Mailing List:
 144
 145         bug-tm-en@chamonix.jaist.ac.jp  (English)
 146         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 147
 148   Via the tm ML, you can report SEMI bugs, obtain the latest release
 149   of SEMI, and discuss future enhancements to SEMI.  To join the tm
 150   ML, send an empty e-mail to
 151
 152         tm-en-help@chamonix.jaist.ac.jp (English)
 153         tm-ja-help@chamonix.jaist.ac.jp (Japanese)
 154
 155   Notice that you should not send mail to author(s), such as
 156   morioka@jaist.ac.jp, directly.  Because your problem may occur in
 157   other environments (if not, it might be your problem, not bug of
 158   SEMI).  We should discuss in the tm mailing lists.  Anyway
 159   direct-mail for authors might be ignored.  Please send mail to the
 160   tm mailing lists.
 161
 162
 163 CVS based development
 164 =====================
 165
 166   If you would like to join CVS based development, please send mail to
 167
 168         cvs@chamonix.jaist.ac.jp
 169
 170   with your account name and UNIX style crypted password.  We hope you
 171   will join the open development.
 172
 173
 174 Authors
 175 =======
 176
 177 Original authors
 178
 179     MORIOKA Tomohiko <morioka@jaist.ac.jp>
 180         (the author of mime-view and various parts of SEMI)
 181     UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
 182         (the author of mime.el of emacs-mime-tools.  mime.el is the
 183         origin of mime-edit.el of SEMI)
 184
 185 Other authors
 186
 187     Shuhei KOBAYASHI  <shuhei-k@jaist.ac.jp>
 188         (a major author of signature.el and a lot of codes)
 189     MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
 190         (anonymous ftp codes of mime-play.el)
 191     OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
 192         (a major author of mime-partial.el and signature.el)
 193
 194     Steinar Bang <sb@metis.no>
 195     Steven L. Baur <steve@miranova.com>
 196     Kevin Broadey <KevinB@bartley.demon.co.uk>
 197     Alastair Burt <burt@dfki.uni-kl.de>
 198     Eric Ding <ericding@San-Jose.ate.slb.com>
 199     Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
 200     Simon Josefsson <jas@pdc.kth.se>
 201     Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
 202     Carsten Leonhardt <leo@arioch.tng.oche.de>
 203     Pekka Marjola <marjola@bilbo.ntc.nokia.com>
 204     Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
 205     Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
 206     Alexandre Oliva <oliva@dcc.unicamp.br>
 207     François Pinard <pinard@iro.umontreal.ca>
 208     Artur Pioro <artur@flugor.if.uj.edu.pl>
 209     Dan Rich <drich@morpheus.corp.sgi.com>
 210         (contribute to evolve mime-image.el with XEmacs)
 211     Katsumi Yamaoka <yamaoka@ga.sony.co.jp>