README.en

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