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