README.en

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