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