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