README.en

   1 ;; -*- coding: utf-8; -*-
   2 [README for SEMI kernel package (English Version)]
   3
   4 What's SEMI?
   5 ============
   6
   7   SEMI is a library to provide MIME feature for GNU Emacs.  MIME is a
   8   proposed internet standard for including content and headers other
   9   than (ASCII) plain text in messages.
  10
  11         RFC 2045 : Internet Message Bodies
  12         RFC 2046 : Media Types
  13         RFC 2047 : Message Header Extensions
  14         RFC 2048 : MIME Registration Procedures
  15         RFC 2049 : MIME Conformance
  16
  17   SEMI has the following features:
  18
  19         - MIME message viewer   (mime-view-mode) (RFC 2045 .. 2049)
  20         - MIME message composer (mime-edit-mode) (RFC 2045 .. 2049)
  21
  22   MIME message viewer and composer also support following features:
  23
  24         - filename handling by Content-Disposition field (RFC 1806)
  25         - PGP/MIME security Multiparts (RFC 2015)
  26         - application/pgp (draft-kazu-pgp-mime-00.txt; obsolete)
  27         - text/richtext (RFC 1521; obsolete; preview only)
  28         - text/enriched (RFC 1896)
  29         - External method configuration by mailcap (RFC 1524)
  30
  31   Notice that this package does not contain MIME extender for any
  32   MUAs.  They are released as separated packages.
  33
  34
  35 Required environment
  36 ====================
  37
  38   SEMI supports XEmacs 21.1 or later, and GNU Emacs 20.4 or later.
  39
  40   SEMI does not support anything older than GNU Emacs 19.28 or XEmacs
  41   19.14.  In addition, SEMI does not word with byte-indexing Mule
  42   implementations, such as Mule 1, Mule 2 and GNU Emacs 20.1/20.2.
  43
  44   SEMI also does not support Emacs 19.29 to 19.34, XEmacs 19.15 or
  45   XEmacs 20.2, but SEMI may work with them.
  46
  47   SEMI requires APEL (10.7 or later) and FLIM (1.14.2 or later)
  48   package.  Please install them before installing it.  APEL package is
  49   available at:
  50
  51         http://git.chise.org/elisp/dist/apel/
  52
  53   and FLIM package is available at:
  54
  55         http://git.chise.org/elisp/dist/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 Lists:
 185
 186         emacs-mime-en@lists.chise.org   (English)
 187         emacs-mime-ja@lists.chise.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, please see the descriptions of the following
 192   pages:
 193
 194       http://lists.chise.org/mailman/listinfo/emacs-mime-en (English)
 195       http://lists.chise.org/mailman/listinfo/emacs-mime-ja (Japanese)
 196
 197
 198 Git based development
 199 =====================
 200
 201   The SEMI development sources can be accessed via Git repository.
 202   You can get the latest SEMI sources by the following:
 203
 204   % git clone http://git.chise.org/git/elisp/semi.git
 205
 206   Or you can view the SEMI repository via WWW at:
 207
 208     http://git.chise.org/gitweb/?p=elisp/semi.git
 209
 210   If you would like to join Git based development, please declare it
 211   in the Emacs-MIME mailing list at first.
 212
 213   We hope you will join the open development.
 214
 215
 216 Authors
 217 =======
 218
 219 Original authors
 220
 221     MORIOKA Tomohiko <morioka@jaist.ac.jp>
 222         (the author of mime-view and various parts of SEMI)
 223     UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
 224         (the author of mime.el of emacs-mime-tools.  mime.el is the
 225         origin of mime-edit.el of SEMI)
 226
 227 Other authors
 228
 229     Shuhei KOBAYASHI  <shuhei-k@jaist.ac.jp>
 230         (a major author of signature.el and a lot of codes)
 231     MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
 232         (anonymous ftp codes of mime-play.el)
 233     OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
 234         (a major author of mime-partial.el and signature.el)
 235
 236     Steinar Bang <sb@metis.no>
 237     Steven L. Baur <steve@miranova.com>
 238     Kevin Broadey <KevinB@bartley.demon.co.uk>
 239     Alastair Burt <burt@dfki.uni-kl.de>
 240     Eric Ding <ericding@San-Jose.ate.slb.com>
 241     Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
 242     Simon Josefsson <jas@pdc.kth.se>
 243     Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
 244     Carsten Leonhardt <leo@arioch.tng.oche.de>
 245     Pekka Marjola <marjola@bilbo.ntc.nokia.com>
 246     Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
 247     Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
 248     Alexandre Oliva <oliva@dcc.unicamp.br>
 249     François Pinard <pinard@iro.umontreal.ca>
 250     Artur Pioro <artur@flugor.if.uj.edu.pl>
 251     Dan Rich <drich@morpheus.corp.sgi.com>
 252         (contribute to evolve mime-image.el with XEmacs)
 253     Katsumi Yamaoka <yamaoka@jpl.org>