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