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