README.en

   1 [README for MU (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3
   4 What's MU
   5 =========
   6
   7   MU stands for "Message Utilities".  It consists of following
   8   modules:
   9
  10         mu-cite: a citation utility
  11           mu-cite.el     --- main module of mu-cite
  12           mu-bbdb.el     --- mu-cite submodule for BBDB
  13           mu-register.el --- mu-cite submodule for registration
  14
  15         latex-math-symbol.el --- translate mathematical symbols of
  16                                  LaTeX into MULE characters
  17
  18   It requires two packages APEL 10.7 or later and FLIM 1.12.2 or later.
  19   Please install them.
  20
  21
  22 Installation
  23 ============
  24
  25 (a) run in expanded place
  26
  27   If you don't want to install other directories, please do only
  28   following:
  29
  30         % make
  31
  32   You can specify the emacs command name, for example
  33
  34         % make install EMACS=xemacs
  35
  36   If `EMACS=...' is omitted, EMACS=emacs is used.
  37
  38 (b) make install
  39
  40   If you want to install other directories, please do following:
  41
  42         % make install
  43
  44   You can specify the emacs command name, for example
  45
  46         % make install EMACS=xemacs
  47
  48   If `EMACS=...' is omitted, EMACS=emacs is used.
  49
  50   You can specify the prefix of the directory tree for Emacs Lisp
  51   programs and shell scripts, for example:
  52
  53         % make install PREFIX=~/
  54
  55   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  56   specified emacs command is used (perhaps /usr/local).
  57
  58   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  59   will create the following directory tree:
  60
  61         /usr/local/share/emacs/site-lisp/mu/   --- MU
  62
  63   You can specify site-lisp directory, for example:
  64
  65         % make install LISPDIR=~/share/emacs/lisp
  66
  67   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  68   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  69   /usr/local/lib/xemacs/site-lisp).
  70
  71   If the emu modules (included in APEL package) have been installed in
  72   the non-standard directory, you should specify where they will be
  73   found, for example:
  74
  75         % make install VERSION_SPECIFIC_LISPDIR=~/elisp
  76
  77   You can specify other optional settings by editing the file
  78   MU-CFG.  Please read comments in it.
  79
  80 (c) install as a XEmacs package
  81
  82   If you want to install to XEmacs package directory, please do
  83   following:
  84
  85         % make install-package
  86
  87   You can specify the XEmacs command name, for example
  88
  89         % make install-package XEMACS=xemacs-21
  90
  91   If `XEMACS=...' is omitted, XEMACS=xemacs is used.
  92
  93   You can specify the package directory, for example:
  94
  95         % make install PACKAGEDIR=~/.xemacs
  96
  97   If `PACKAGEDIR=...' is omitted, the first existing package
  98   directory is used.
  99
 100   Notice that XEmacs package system requires XEmacs 21.0 or later.
 101
 102
 103 load-path (for Emacs or MULE)
 104 =============================
 105
 106   If you are using Emacs or Mule, please add directory of mu to
 107   load-path.  If you install by default setting, you can write
 108   subdirs.el for example:
 109
 110   --------------------------------------------------------------------
 111   (normal-top-level-add-to-load-path '("apel" "flim" "mu"))
 112   --------------------------------------------------------------------
 113
 114   If you are using XEmacs, there are no need of setting about
 115   load-path.
 116
 117
 118 Bug reports
 119 ===========
 120
 121   If you write bug-reports and/or suggestions for improvement, please
 122   send them to Elips Mailing List:
 123
 124         Elips@eos.hokudai.ac.jp
 125
 126   Elips mailing list is for discussing all sorts of Emacsen, mainly in
 127   Japanese.  To join Elips ML, please introduce yourself briefly in an
 128   e-mail to
 129
 130         Elips-request@eos.hokudai.ac.jp
 131
 132   Via Elips ML, you can report MU-CITE related bugs, obtain the latest
 133   release of MU-CITE, and discuss future enhancements to MU-CITE.
 134
 135
 136 CVS based development
 137 =====================
 138
 139   If you would like to join CVS based development, please send mail to
 140
 141         cvs@cvs.m17n.org
 142
 143   with your account name and your public key for ssh.  cvsroot is
 144   :ext:cvs@cvs.m17n.org:/cvs/root.
 145
 146   If you cannot use ssh, please send UNIX /etc/passwd style crypted
 147   password.  you can commit with the cvsroot
 148   :pserver:<accountname>@cvs.m17n.org:/cvs/root.
 149
 150   We hope you will join the open development.