README.en

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