README.en

   1 [README for SEMI kernel package (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.en,v 1.1 1997-04-30 17:39:28 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.1 or later with mule, and Emacs/mule (mule
  41   merged EMACS; it will become Emacs 20.0).
  42
  43   SEMI does not support EMACS 19.28 or later, XEmacs 19.14 or later,
  44   XEmacs 20.1 or later without mule, but SEMI may work with them.
  45
  46   If you use beta versions of XEmacs 20.1, please use the latest
  47   version and compile with mule support, i.e. use the configure flag
  48   `--with-mule'.
  49
  50   If you use EMACS/mule, please use the latest version (GNU MULE
  51   19.34.91-delta or later).
  52
  53   SEMI requires APEL and MEL package.  Please install them before
  54   installing it.  APEL package
  55   is available at:
  56
  57         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  58
  59   and MEL package is available at:
  60
  61         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/libs/
  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 other optional settings by editing the file
 100   semi/SEMI-CFG.  Please read semi/README.en and comments in
 101   semi/TM-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   bitmap, mu, mel and semi to load-path.  If you install by default
 111   setting, you can write subdirs.el for example:
 112
 113   --------------------------------------------------------------------
 114   (normal-top-level-add-to-load-path
 115    '("apel" "bitmap" "mu" "mel" "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 semi/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 tm bugs, obtain the latest release of
 148   tm, and discuss future enhancements to tm. To join the tm ML, send
 149   e-mail to
 150
 151         tm-ja-admin@chamonix.jaist.ac.jp        (Japanese)
 152         tm-en-admin@chamonix.jaist.ac.jp        (English)
 153
 154   Since the user registration is done manually, please write the mail
 155   body in human-recognizable language (^_^).