README.en

   1 [README for MU (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.en,v 1.2 1998-03-08 22:44:35 shuhei-k Exp $
   4
   5 What's MU
   6 =========
   7
   8   MU stands for "Message Utilities".  It consists of following
   9   modules:
  10
  11         std11: std11 lexical-analyzer, parser and available utilities
  12           std11.el       --- main module
  13           std11-parse.el --- lexical-analyzer and parser
  14
  15         mu-cite: a citation utility
  16           mu-cite.el --- main module of mu-cite
  17           mu-bbdb.el --- mu-cite submodule for BBDB
  18
  19         latex-math-symbol.el --- translate mathematical symbols of
  20                                  LaTeX into MULE characters
  21
  22   It requires APEL package.  Please install it.
  23
  24
  25 Installation
  26 ============
  27
  28 (a) run in expanded place
  29
  30   If you don't want to install other directories, please do only
  31   following:
  32
  33         % make
  34
  35   You can specify the emacs command name, for example
  36
  37         % make install EMACS=xemacs
  38
  39   If `EMACS=...' is omitted, EMACS=emacs is used.
  40
  41 (b) make install
  42
  43   If you want to install other directories, please do following:
  44
  45         % make install
  46
  47   You can specify the emacs command name, for example
  48
  49         % make install EMACS=xemacs
  50
  51   If `EMACS=...' is omitted, EMACS=emacs is used.
  52
  53   You can specify the prefix of the directory tree for Emacs Lisp
  54   programs and shell scripts, for example:
  55
  56         % make install PREFIX=~/
  57
  58   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  59   specified emacs command is used (perhaps /usr/local).
  60
  61   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  62   will create the following directory tree:
  63
  64         /usr/local/share/emacs/site-lisp/mu/   --- MU
  65
  66   You can specify other optional settings by editing the file
  67   MU-CFG.  Please read comments in it.
  68
  69 make options about load-path
  70 ----------------------------
  71
  72
  73 load-path (for Emacs or MULE)
  74 =============================
  75
  76   If you are using Emacs or Mule, please add directory of mu to
  77   load-path.  If you install by default setting, you can write
  78   subdirs.el for example:
  79
  80   --------------------------------------------------------------------
  81   (normal-top-level-add-to-load-path '("APEL" "mu"))
  82   --------------------------------------------------------------------
  83
  84   If you are using XEmacs, there are no need of setting about
  85   load-path.
  86
  87
  88 How to use
  89 ==========
  90
  91 alist
  92 -----
  93
  94 Function put-alist (ITEM VALUE ALIST)
  95
  96   Modify ALIST to set VALUE to ITEM.  If there is a pair whose car is
  97   ITEM, replace its cdr by VALUE.  If there is not such pair, create
  98   new pair (ITEM . VALUE) and return new alist whose car is the new
  99   pair and cdr is ALIST.
 100
 101 Function del-alist (ITEM ALIST)
 102
 103   If there is a pair whose key is ITEM, delete it from ALIST.
 104
 105 Function set-alist (SYMBOL ITEM VALUE)
 106
 107   Modify a alist indicated by SYMBOL to set VALUE to ITEM.
 108
 109   Ex. (set-alist 'auto-mode-alist "\\.pln$" 'text-mode)
 110
 111 Function modify-alist (MODIFIER DEFAULT)
 112
 113   Modify alist DEFAULT into alist MODIFIER.
 114
 115 Function set-modified-alist (SYMBOL MODIFIER)
 116
 117   Modify a value of a SYMBOL into alist MODIFIER.  The SYMBOL should
 118   be alist. If it is not bound, its value regard as nil.
 119
 120 file-detect
 121 -----------
 122
 123 Function add-path (PATH &rest OPTIONS)
 124
 125   Add PATH to `load-path' if it exists under `default-load-path'
 126   directories and it does not exist in `load-path'.
 127
 128   You can use following PATH styles:
 129
 130     load-path relative: "PATH" (it is searched from
 131                                 `defaul-load-path')
 132
 133     home directory relative: "~/PATH" "~USER/PATH"
 134
 135     absolute path: "/FOO/BAR/BAZ"
 136
 137   You can specify following OPTIONS:
 138
 139     'all-paths --- search from `load-path' instead of
 140                    `default-load-path'
 141
 142     'append --- add PATH to the last of `load-path'
 143
 144 Function add-latest-path (PATTERN &optional ALL-PATHS)
 145
 146   Add latest path matched by regexp PATTERN to `load-path' if it
 147   exists under `default-load-path' directories and it does not exist
 148   in `load-path'.
 149
 150   For example, if there is bbdb-1.50 and bbdb-1.51 under site-lisp,
 151   and if bbdb-1.51 is newer than bbdb-1.50, and site-lisp is
 152   /usr/local/share/emacs/site-lisp,
 153
 154         (add-path "bbdb")
 155
 156   it adds "/usr/local/share/emacs/site-lisp/bbdb-1.51" to top of
 157   `load-path'.
 158
 159   If optional argument ALL-PATHS is specified, it is searched from all
 160   of `load-path' instead of `default-load-path'.
 161
 162 Function get-latest-path (PATTERN &optional ALL-PATHS)
 163
 164   Return latest directory in default-load-path which is matched to
 165   regexp PATTERN.  If optional argument ALL-PATHS is specified, it is
 166   searched from all of load-path instead of default-load-path.
 167
 168   Ex. (let ((gnus-path (get-latest-path "gnus")))
 169         (add-path (expand-file-name "lisp" gnus-path))
 170         (add-to-list 'Info-default-directory-list
 171                      (expand-file-name "texi" gnus-path))
 172         )
 173
 174 Function file-installed-p (FILE &optional PATHS)
 175
 176   Return absolute-path of FILE if FILE exists in PATHS.  If PATHS is
 177   omitted, `load-path' is used.
 178
 179 Function exec-installed-p (FILE &optional PATHS SUFFIXES)
 180
 181   Return absolute-path of FILE if FILE exists in PATHS.  If PATHS is
 182   omitted, `exec-path' is used.  If suffixes is omitted,
 183   `exec-suffix-list' is used.
 184
 185 Function module-installed-p (MODULE &optional PATHS)
 186
 187   Return non-nil if module is provided or exists in PATHS.  If PATHS
 188   is omitted, `load-path' is used.
 189
 190 filename
 191 --------
 192
 193 Function replace-as-filename (string)
 194
 195   Return safety file-name from STRING.
 196
 197   It refers variable `filename-filters'.  It is list of functions for
 198   file-name filter.  Default filter refers following variables:
 199
 200         Variable filename-limit-length
 201
 202           Limit size of file-name.
 203
 204         Variable filename-replacement-alist
 205
 206           Alist list of characters vs. string as replacement.  List of
 207           characters represents characters not allowed as file-name.
 208
 209
 210 Bug reports
 211 -----------
 212
 213   If you write bug-reports and/or suggestions for improvement, please
 214   send them to the tm Mailing List:
 215
 216         bug-tm-en@chamonix.jaist.ac.jp  (English)
 217         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 218
 219   Via the tm ML, you can report tm bugs, obtain the latest release of
 220   tm, and discuss future enhancements to tm. To join the tm ML, send
 221   an empty e-mail to
 222
 223         tm-en-help@chamonix.jaist.ac.jp (English)
 224         tm-ja-help@chamonix.jaist.ac.jp (Japanese)