README.en

   1 [README for WEMI kernel package (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3
   4 What's WEMI?
   5 ------------
   6
   7   WEMI is a branch of SEMI kernel package using widget.  It is a
   8   library to provide MIME feature for GNU Emacs based on SEMI API.
   9   Namely it contains whole features of SEMI thus it is a replacement
  10   of SEMI.
  11
  12   MIME is a proposed internet standard for including content and
  13   headers other than (ASCII) plain text in messages.
  14
  15         RFC 2045 : Internet Message Bodies
  16         RFC 2046 : Media Types
  17         RFC 2047 : Message Header Extensions
  18         RFC 2048 : MIME Registration Procedures
  19         RFC 2049 : MIME Conformance
  20
  21   WEMI has the following features:
  22
  23         - MIME style multilingual header (RFC 2047)
  24         - MIME message viewer   (mime-view-mode) (RFC 2045 .. 2049)
  25         - MIME message composer (mime-edit-mode) (RFC 2045 .. 2049)
  26
  27   MIME message viewer and composer also support following features:
  28
  29         - filename handling by Content-Disposition field (RFC 1806)
  30         - PGP/MIME security Multiparts (RFC 2015)
  31         - application/pgp (draft-kazu-pgp-mime-00.txt; obsolete)
  32         - text/richtext (RFC 1521; obsolete; preview only)
  33         - text/enriched (RFC 1896)
  34
  35   Notice that this package does not contain MIME extender for any
  36   MUAs and external methods.  They are released as separated packages.
  37
  38
  39 Required environment
  40 --------------------
  41
  42   WEMI supports XEmacs 20.3 or later with mule, and Emacs 20.2.
  43
  44   WEMI does not support anything older than Emacs 19.28 or XEmacs
  45   19.14.  WEMI also does not support Emacs 19.29 to 19.34, XEmacs
  46   19.15 or XEmacs 20.2 without mule, but WEMI may work with them.
  47
  48   If you use Emacs 20, don't set `enable-multibyte-characters' to
  49   nil. (Maybe non mule setting requires to modify emu.  In addition,
  50   it is better to use terminal-coding-system feature)
  51
  52   SEMI requires APEL (8.7 or later) and FLIM package.  Please install
  53   them before installing it.  APEL package is available at:
  54
  55         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  56
  57   and FLIM package is available at:
  58
  59         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/flim/
  60
  61   PGP/MIME and application/pgp require mailcrypt or tiny-pgp package.
  62
  63   The package enriched.el is required to compose text/enriched, so if
  64   you use Emacs anything 19.28 or older (including official version of
  65   MULE 2.3), WYSIWYG composing for text/enriched is not available.
  66
  67
  68 Installation
  69 ------------
  70
  71         % make install
  72
  73   You can specify the emacs command name, for example
  74
  75         % make install EMACS=xemacs
  76
  77   If `EMACS=...' is omitted, EMACS=emacs is used.
  78
  79   You can specify the prefix of the directory tree for Emacs Lisp
  80   programs and shell scripts, for example:
  81
  82         % make install PREFIX=~/
  83
  84   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  85   specified emacs command is used (perhaps /usr/local).
  86
  87   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  88   will create the following directory tree:
  89
  90         /usr/local/share/emacs/19.34/site-lisp/  --- emu
  91         /usr/local/share/emacs/site-lisp/apel/   --- APEL
  92         /usr/local/share/emacs/site-lisp/flim/   --- FLIM
  93         /usr/local/share/emacs/site-lisp/semi/   --- SEMI
  94
  95   You can specify site-lisp directory, for example
  96
  97         % make install LISPDIR=~/share/emacs/lisp
  98
  99   If `LISPDIR=...' is omitted, site-lisp directory of the specified
 100   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
 101   /usr/local/lib/xemacs/site-lisp).
 102
 103   You can specify other optional settings by editing the file
 104   ${archive}/SEMI-CFG.  Please read ${archive}/README.en and comments
 105   in ${archive}/SEMI-CFG.
 106
 107
 108 Initialization
 109 --------------
 110
 111 (a) load-path
 112
 113   If you are using Emacs or Mule, please add directory of emu, apel,
 114   flim and semi to load-path.  If you install by default setting, you
 115   can write subdirs.el for example:
 116
 117   --------------------------------------------------------------------
 118   (normal-top-level-add-to-load-path
 119    '("apel" "flim" "semi"))
 120   --------------------------------------------------------------------
 121
 122   If you are using XEmacs, there are no need of setting about
 123   load-path.
 124
 125 (b) mime-setup
 126
 127   Please insert the following into your ~/.emacs:
 128
 129         (load "mime-setup")
 130
 131
 132 Documentation
 133 -------------
 134
 135   To get started, please read ${archive}/README.en.
 136
 137   RFC's 822, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and 2049
 138   are available via anonymous ftp:
 139   ftp://ds.internic.net/rfc/
 140
 141
 142 Bug reports
 143 -----------
 144
 145   If you write bug-reports and/or suggestions for improvement, please
 146   send them to the tm Mailing List:
 147
 148         bug-tm-en@chamonix.jaist.ac.jp  (English)
 149         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 150
 151   Via the tm ML, you can report WEMI bugs, obtain the latest release
 152   of WEMI, and discuss future enhancements to WEMI.  To join the tm
 153   ML, send an empty e-mail to
 154
 155         tm-en-help@chamonix.jaist.ac.jp (English)
 156         tm-ja-help@chamonix.jaist.ac.jp (Japanese)