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