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