1 [README for APEL (English Version)]
2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
3 $Id: README.en,v 1.8 1998-02-12 11:59:06 morioka Exp $
8 APEL stands for "A Portable Emacs Library". It consists of
11 emu: A package to fill incompatibilities of emacsen
12 emu.el --- main module
14 emu-nemacs.el --- for NEmacs
15 emu-e19.el --- for Emacs 19 or XEmacs without mule
16 emu-mule.el --- for MULE 2.3
17 emu-20.el --- for Emacs 20 and XEmacs/mule
18 emu-e20.el --- for Emacs 20 and MULE 3
19 emu-x20.el --- for XEmacs/mule
21 emu-18.el --- for Emacs 18
22 emu-19.el --- for Emacs 19 or later
23 emu-xemacs.el --- for XEmacs
24 env.el --- env.el for Emacs 18
25 richtext.el --- text/richtext module
26 for Emacs 19.29 or later,
28 tinyrich.el --- text/richtext module for old emacsen
30 alist.el: utility for Association-list
32 atype.el: utility for atype
34 path-util.el: utility for path management or file detection
36 filename.el: utility to make file-name
38 install.el: utility to install emacs-lisp package
40 mule-caesar.el: ROT 13-47-48 Caesar rotation utility
42 std11: RFC 822/STD 11 parser and utility
43 std11.el --- main module
44 std11-parse.el --- parser
50 (a) run in expanded place
52 If you don't want to install other directories, please do only
57 You can specify the emacs command name, for example
59 % make install EMACS=xemacs
61 If `EMACS=...' is omitted, EMACS=emacs is used.
65 If you want to install other directories, please do following:
69 You can specify the emacs command name, for example
71 % make install EMACS=xemacs
73 If `EMACS=...' is omitted, EMACS=emacs is used.
75 You can specify the prefix of the directory tree for Emacs Lisp
76 programs and shell scripts, for example:
78 % make install PREFIX=~/
80 If `PREFIX=...' is omitted, the prefix of the directory tree of the
81 specified emacs command is used (perhaps /usr/local).
83 For example, if PREFIX=/usr/local and Emacs 20.2 is specified, it
84 will create the following directory tree:
86 /usr/local/share/emacs/20.2/site-lisp/ --- emu
87 /usr/local/share/emacs/site-lisp/apel/ --- APEL
89 You can specify other optional settings by editing the file
90 APEL-CFG. Please read comments in it.
93 load-path (for Emacs or MULE)
94 =============================
96 If you are using Emacs or Mule, please add directory of apel to
97 load-path. If you install by default setting, you can write
98 subdirs.el for example:
100 --------------------------------------------------------------------
101 (normal-top-level-add-to-load-path '("apel"))
102 --------------------------------------------------------------------
104 If you are using XEmacs, there are no need of setting about
114 Function put-alist (ITEM VALUE ALIST)
116 Modify ALIST to set VALUE to ITEM. If there is a pair whose car is
117 ITEM, replace its cdr by VALUE. If there is not such pair, create
118 new pair (ITEM . VALUE) and return new alist whose car is the new
119 pair and cdr is ALIST.
121 Function del-alist (ITEM ALIST)
123 If there is a pair whose key is ITEM, delete it from ALIST.
125 Function set-alist (SYMBOL ITEM VALUE)
127 Modify a alist indicated by SYMBOL to set VALUE to ITEM.
129 Ex. (set-alist 'auto-mode-alist "\\.pln$" 'text-mode)
131 Function modify-alist (MODIFIER DEFAULT)
133 Modify alist DEFAULT into alist MODIFIER.
135 Function set-modified-alist (SYMBOL MODIFIER)
137 Modify a value of a SYMBOL into alist MODIFIER. The SYMBOL should
138 be alist. If it is not bound, its value regard as nil.
143 Function add-path (PATH &rest OPTIONS)
145 Add PATH to `load-path' if it exists under `default-load-path'
146 directories and it does not exist in `load-path'.
148 You can use following PATH styles:
150 load-path relative: "PATH" (it is searched from
153 home directory relative: "~/PATH" "~USER/PATH"
155 absolute path: "/FOO/BAR/BAZ"
157 You can specify following OPTIONS:
159 'all-paths --- search from `load-path' instead of
162 'append --- add PATH to the last of `load-path'
164 Function add-latest-path (PATTERN &optional ALL-PATHS)
166 Add latest path matched by regexp PATTERN to `load-path' if it
167 exists under `default-load-path' directories and it does not exist
170 For example, if there is bbdb-1.50 and bbdb-1.51 under site-lisp,
171 and if bbdb-1.51 is newer than bbdb-1.50, and site-lisp is
172 /usr/local/share/emacs/site-lisp,
176 it adds "/usr/local/share/emacs/site-lisp/bbdb-1.51" to top of
179 If optional argument ALL-PATHS is specified, it is searched from all
180 of `load-path' instead of `default-load-path'.
182 Function get-latest-path (PATTERN &optional ALL-PATHS)
184 Return latest directory in default-load-path which is matched to
185 regexp PATTERN. If optional argument ALL-PATHS is specified, it is
186 searched from all of load-path instead of default-load-path.
188 Ex. (let ((gnus-path (get-latest-path "gnus")))
189 (add-path (expand-file-name "lisp" gnus-path))
190 (add-to-list 'Info-default-directory-list
191 (expand-file-name "texi" gnus-path))
194 Function file-installed-p (FILE &optional PATHS)
196 Return absolute-path of FILE if FILE exists in PATHS. If PATHS is
197 omitted, `load-path' is used.
199 Function exec-installed-p (FILE &optional PATHS SUFFIXES)
201 Return absolute-path of FILE if FILE exists in PATHS. If PATHS is
202 omitted, `exec-path' is used. If suffixes is omitted,
203 `exec-suffix-list' is used.
205 Function module-installed-p (MODULE &optional PATHS)
207 Return non-nil if module is provided or exists in PATHS. If PATHS
208 is omitted, `load-path' is used.
213 Function replace-as-filename (string)
215 Return safety file-name from STRING.
217 It refers variable `filename-filters'. It is list of functions for
218 file-name filter. Default filter refers following variables:
220 Variable filename-limit-length
222 Limit size of file-name.
224 Variable filename-replacement-alist
226 Alist list of characters vs. string as replacement. List of
227 characters represents characters not allowed as file-name.
233 If you write bug-reports and/or suggestions for improvement, please
234 send them to the tm Mailing List:
236 bug-tm-en@chamonix.jaist.ac.jp (English)
237 bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
239 Via the tm ML, you can report APEL bugs, obtain the latest release
240 of APEL, and discuss future enhancements to APEL. To join the tm
243 tm-ja-admin@chamonix.jaist.ac.jp (Japanese)
244 tm-en-admin@chamonix.jaist.ac.jp (English)
246 Since the user registration is done manually, please write the mail
247 body in human-recognizable language (^_^).