From: yamaoka Date: Wed, 28 Jul 1999 08:56:14 +0000 (+0000) Subject: (How to use): Remove the part. X-Git-Tag: mu-cite-8_0~17 X-Git-Url: http://git.chise.org/gitweb/?a=commitdiff_plain;h=e6e23b5146043d58933e5ccb14cd6388a9e18cd2;p=elisp%2Fmu-cite.git (How to use): Remove the part. (load-path): Document that FLIM should be included in `load-path'. (Installation): Add expositions how to use make options LISPDIR and VERSION_SPECIFIC_LISPDIR; add the clause for installing as a XEmacs package. (What's MU): Remove the clause for std11; add description about mu-register.el; update required packages. (TopLevel):Remove RCS magic cookie. --- diff --git a/README.en b/README.en index 314418c..205e0ce 100644 --- a/README.en +++ b/README.en @@ -1,6 +1,5 @@ [README for MU (English Version)] by MORIOKA Tomohiko -$Id: README.en,v 1.2 1998-03-08 22:44:35 shuhei-k Exp $ What's MU ========= @@ -8,18 +7,16 @@ What's MU MU stands for "Message Utilities". It consists of following modules: - std11: std11 lexical-analyzer, parser and available utilities - std11.el --- main module - std11-parse.el --- lexical-analyzer and parser - mu-cite: a citation utility - mu-cite.el --- main module of mu-cite - mu-bbdb.el --- mu-cite submodule for BBDB + mu-cite.el --- main module of mu-cite + mu-bbdb.el --- mu-cite submodule for BBDB + mu-register.el --- mu-cite submodule for registration latex-math-symbol.el --- translate mathematical symbols of LaTeX into MULE characters - It requires APEL package. Please install it. + It requires two packages APEL 9.20 or later and FLIM 1.12.2 or later. + Please install them. Installation @@ -63,148 +60,59 @@ Installation /usr/local/share/emacs/site-lisp/mu/ --- MU - You can specify other optional settings by editing the file - MU-CFG. Please read comments in it. - -make options about load-path ----------------------------- - - -load-path (for Emacs or MULE) -============================= - - If you are using Emacs or Mule, please add directory of mu to - load-path. If you install by default setting, you can write - subdirs.el for example: - - -------------------------------------------------------------------- - (normal-top-level-add-to-load-path '("APEL" "mu")) - -------------------------------------------------------------------- - - If you are using XEmacs, there are no need of setting about - load-path. - - -How to use -========== - -alist ------ - -Function put-alist (ITEM VALUE ALIST) - - Modify ALIST to set VALUE to ITEM. If there is a pair whose car is - ITEM, replace its cdr by VALUE. If there is not such pair, create - new pair (ITEM . VALUE) and return new alist whose car is the new - pair and cdr is ALIST. - -Function del-alist (ITEM ALIST) - - If there is a pair whose key is ITEM, delete it from ALIST. - -Function set-alist (SYMBOL ITEM VALUE) - - Modify a alist indicated by SYMBOL to set VALUE to ITEM. - - Ex. (set-alist 'auto-mode-alist "\\.pln$" 'text-mode) - -Function modify-alist (MODIFIER DEFAULT) + You can specify site-lisp directory, for example: - Modify alist DEFAULT into alist MODIFIER. + % make install LISPDIR=~/share/emacs/lisp -Function set-modified-alist (SYMBOL MODIFIER) + If `LISPDIR=...' is omitted, site-lisp directory of the specified + emacs command is used (perhaps /usr/local/share/emacs/site-lisp or + /usr/local/lib/xemacs/site-lisp). - Modify a value of a SYMBOL into alist MODIFIER. The SYMBOL should - be alist. If it is not bound, its value regard as nil. + If the emu modules (included in APEL package) have been installed in + the non-standard directory, you should specify where they will be + found, for example: -file-detect ------------ - -Function add-path (PATH &rest OPTIONS) - - Add PATH to `load-path' if it exists under `default-load-path' - directories and it does not exist in `load-path'. - - You can use following PATH styles: - - load-path relative: "PATH" (it is searched from - `defaul-load-path') - - home directory relative: "~/PATH" "~USER/PATH" - - absolute path: "/FOO/BAR/BAZ" - - You can specify following OPTIONS: - - 'all-paths --- search from `load-path' instead of - `default-load-path' - - 'append --- add PATH to the last of `load-path' - -Function add-latest-path (PATTERN &optional ALL-PATHS) - - Add latest path matched by regexp PATTERN to `load-path' if it - exists under `default-load-path' directories and it does not exist - in `load-path'. - - For example, if there is bbdb-1.50 and bbdb-1.51 under site-lisp, - and if bbdb-1.51 is newer than bbdb-1.50, and site-lisp is - /usr/local/share/emacs/site-lisp, - - (add-path "bbdb") - - it adds "/usr/local/share/emacs/site-lisp/bbdb-1.51" to top of - `load-path'. + % make install VERSION_SPECIFIC_LISPDIR=~/elisp - If optional argument ALL-PATHS is specified, it is searched from all - of `load-path' instead of `default-load-path'. - -Function get-latest-path (PATTERN &optional ALL-PATHS) - - Return latest directory in default-load-path which is matched to - regexp PATTERN. If optional argument ALL-PATHS is specified, it is - searched from all of load-path instead of default-load-path. + You can specify other optional settings by editing the file + MU-CFG. Please read comments in it. - Ex. (let ((gnus-path (get-latest-path "gnus"))) - (add-path (expand-file-name "lisp" gnus-path)) - (add-to-list 'Info-default-directory-list - (expand-file-name "texi" gnus-path)) - ) +(c) install as a XEmacs package -Function file-installed-p (FILE &optional PATHS) + If you want to install to XEmacs package directory, please do + following: - Return absolute-path of FILE if FILE exists in PATHS. If PATHS is - omitted, `load-path' is used. + % make install-package -Function exec-installed-p (FILE &optional PATHS SUFFIXES) + You can specify the XEmacs command name, for example - Return absolute-path of FILE if FILE exists in PATHS. If PATHS is - omitted, `exec-path' is used. If suffixes is omitted, - `exec-suffix-list' is used. + % make install-package XEMACS=xemacs-21 -Function module-installed-p (MODULE &optional PATHS) + If `XEMACS=...' is omitted, XEMACS=xemacs is used. - Return non-nil if module is provided or exists in PATHS. If PATHS - is omitted, `load-path' is used. + You can specify the package directory, for example: -filename --------- + % make install PACKAGEDIR=~/.xemacs -Function replace-as-filename (string) + If `PACKAGEDIR=...' is omitted, the first existing package + directory is used. - Return safety file-name from STRING. + Notice that XEmacs package system requires XEmacs 21.0 or later. - It refers variable `filename-filters'. It is list of functions for - file-name filter. Default filter refers following variables: - Variable filename-limit-length +load-path (for Emacs or MULE) +============================= - Limit size of file-name. + If you are using Emacs or Mule, please add directory of mu to + load-path. If you install by default setting, you can write + subdirs.el for example: - Variable filename-replacement-alist + -------------------------------------------------------------------- + (normal-top-level-add-to-load-path '("apel" "flim" "mu")) + -------------------------------------------------------------------- - Alist list of characters vs. string as replacement. List of - characters represents characters not allowed as file-name. + If you are using XEmacs, there are no need of setting about + load-path. Bug reports