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 (1.1.0 or later) package.
  53   Please install them before installing it.  APEL package is available
  54   at:
  55
  56         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  57
  58   and FLIM package is available at:
  59
  60         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/flim/
  61
  62   PGP/MIME and application/pgp require mailcrypt or tiny-pgp package.
  63
  64   The package enriched.el is required to compose text/enriched, so if
  65   you use Emacs anything 19.28 or older (including official version of
  66   MULE 2.3), WYSIWYG composing for text/enriched is not available.
  67
  68
  69 Installation
  70 ------------
  71
  72         % make install
  73
  74   You can specify the emacs command name, for example
  75
  76         % make install EMACS=xemacs
  77
  78   If `EMACS=...' is omitted, EMACS=emacs is used.
  79
  80   You can specify the prefix of the directory tree for Emacs Lisp
  81   programs and shell scripts, for example:
  82
  83         % make install PREFIX=~/
  84
  85   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  86   specified emacs command is used (perhaps /usr/local).
  87
  88   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  89   will create the following directory tree:
  90
  91         /usr/local/share/emacs/19.34/site-lisp/  --- emu
  92         /usr/local/share/emacs/site-lisp/apel/   --- APEL
  93         /usr/local/share/emacs/site-lisp/flim/   --- FLIM
  94         /usr/local/share/emacs/site-lisp/semi/   --- SEMI
  95
  96   You can specify site-lisp directory, for example
  97
  98         % make install LISPDIR=~/share/emacs/lisp
  99
 100   If `LISPDIR=...' is omitted, site-lisp directory of the specified
 101   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
 102   /usr/local/lib/xemacs/site-lisp).
 103
 104   You can specify other optional settings by editing the file
 105   ${archive}/SEMI-CFG.  Please read ${archive}/README.en and comments
 106   in ${archive}/SEMI-CFG.
 107
 108
 109 Initialization
 110 --------------
 111
 112 (a) load-path
 113
 114   If you are using Emacs or Mule, please add directory of emu, apel,
 115   flim and semi to load-path.  If you install by default setting, you
 116   can write subdirs.el for example:
 117
 118   --------------------------------------------------------------------
 119   (normal-top-level-add-to-load-path
 120    '("apel" "flim" "semi"))
 121   --------------------------------------------------------------------
 122
 123   If you are using XEmacs, there are no need of setting about
 124   load-path.
 125
 126 (b) mime-setup
 127
 128   Please insert the following into your ~/.emacs:
 129
 130         (load "mime-setup")
 131
 132
 133 Documentation
 134 -------------
 135
 136   To get started, please read ${archive}/README.en.
 137
 138   RFC's 822, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and 2049
 139   are available via anonymous ftp:
 140   ftp://ds.internic.net/rfc/
 141
 142
 143 Bug reports
 144 -----------
 145
 146   If you write bug-reports and/or suggestions for improvement, please
 147   send them to the tm Mailing List:
 148
 149         bug-tm-en@chamonix.jaist.ac.jp  (English)
 150         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 151
 152   Via the tm ML, you can report WEMI bugs, obtain the latest release
 153   of WEMI, and discuss future enhancements to WEMI.  To join the tm
 154   ML, send an empty e-mail to
 155
 156         tm-en-help@chamonix.jaist.ac.jp (English)
 157         tm-ja-help@chamonix.jaist.ac.jp (Japanese)