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