1 [README for APEL (English Version)]
6 APEL stands for "A Portable Emacs Library". It consists of
9 poe.el --- emulation module mainly for basic functions and special
10 forms/macros of latest emacsen
11 poe-xemacs.el --- for XEmacs
12 poe-18.el --- for Emacs 18/Nemacs
13 env.el --- env.el for Emacs 18
14 localhook.el --- hook functions for Emacs 19.28 and earlier.
16 poem.el --- provide basic functions to write portable MULE
18 poem-nemacs.el --- for Nemacs
19 poem-ltn1.el --- for Emacs 19/XEmacs without MULE
20 poem-om.el --- for MULE 1.*, 2.*
21 poem-20.el --- shared module between Emacs 20 and XEmacs-MULE
22 poem-e20_2.el --- for Emacs 20.1/20.2
23 poem-e20_3.el --- for Emacs 20.3
24 poem-xm.el --- for XEmacs-MULE
26 invisible.el --- provide features about invisible region
27 inv-18.el --- for Emacs 18
28 inv-19.el --- for Emacs 19
29 inv-xemacs.el --- for XEmacs
31 mcharset.el --- provide MIME charset related features
32 mcs-nemacs.el --- for Nemacs
33 mcs-ltn1.el --- for Emacs 19/XEmacs without MULE
34 mcs-om.el --- for MULE 1.*, 2.*
35 mcs-20.el --- shared module between Emacs 20 and XEmacs-MULE
36 mcs-e20.el --- for Emacs 20
37 mcs-xm.el --- for XEmacs-MULE
38 mcs-xmu.el --- for XEmacs-MULE to unify ISO646 characters
40 static.el --- utility for static evaluation
42 broken.el --- provide information of broken facilities of Emacs
44 pccl.el --- utility to write portable CCL program
45 pccl-om.el --- for MULE 2.*
46 pccl-20.el --- for Emacs 20/XEmacs-21-MULE
48 alist.el: utility for Association-list
50 calist.el: utility for condition tree and
51 condition/situation-alist
53 path-util.el: utility for path management or file detection
55 filename.el: utility to make file-name
57 install.el: utility to install emacs-lisp package
59 mule-caesar.el: ROT 13-47-48 Caesar rotation utility
61 emu.el --- (emu bundled in tm-7.106 compatibility module; it
62 required poe, poem and mcharset)
63 emu-mule: for MULE 1.*, 2.*
64 richtext.el --- text/richtext module
65 for Emacs 19.29 or later,
67 tinyrich.el --- text/richtext module for old emacsen
69 pcustom.el --- provide portable custom environment
71 tinycustom.el --- emulation module of custom.el
77 (a) run in expanded place
79 If you don't want to install other directories, please do only
84 You can specify the emacs command name, for example
88 If `EMACS=...' is omitted, EMACS=emacs is used.
92 If you want to install other directories, please do following:
96 You can specify the emacs command name, for example
98 % make install EMACS=xemacs
100 If `EMACS=...' is omitted, EMACS=emacs is used.
102 You can specify the prefix of the directory tree for Emacs Lisp
103 programs and shell scripts, for example:
105 % make install PREFIX=~/
107 If `PREFIX=...' is omitted, the prefix of the directory tree of the
108 specified emacs command is used (perhaps /usr/local).
110 For example, if PREFIX=/usr/local and Emacs 20.2 is specified, it
111 will create the following directory tree:
113 /usr/local/share/emacs/20.2/site-lisp/ --- emu
114 /usr/local/share/emacs/site-lisp/apel/ --- APEL
116 You can specify the lisp directory for Emacs Lisp programs,
119 % make install LISPDIR=~/elisp
121 You can also specify the version specific lisp directory where the
122 emu modules will be installed in, for example:
124 % make install VERSION_SPECIFIC_LISPDIR=~/elisp
126 If you would like to know what files belong to the emu modules or
127 the apel modules, or where they will be installed in, for example,
128 please type the following command.
130 % make what-where LISPDIR=~/elisp VERSION_SPECIFIC_LISPDIR=~/elisp
132 You can specify other optional settings by editing the file
133 APEL-CFG. Please read comments in it.
135 (c) install as a XEmacs package
137 If you want to install to XEmacs package directory, please do
140 % make install-package
142 You can specify the emacs command name, for example
144 % make install-package XEMACS=xemacs-21
146 If `XEMACS=...' is omitted, XEMACS=xemacs is used.
148 You can specify the package directory, for example:
150 % make install PACKAGEDIR=~/.xemacs
152 If `PACKAGEDIR=...' is omitted, the first existing package
155 Notice that XEmacs package system requires XEmacs 21.0 or later.
158 load-path (for Emacs or MULE)
159 =============================
161 If you are using Emacs or Mule, please add directory of apel to
162 load-path. If you install by default setting with Emacs 20.1/20.2,
163 you can write subdirs.el for example:
165 --------------------------------------------------------------------
166 (normal-top-level-add-to-load-path '("apel"))
167 --------------------------------------------------------------------
169 If you have installed the new CUSTOM library, e.g. custom-1.9962, to
170 specify the path as below before building this package is advised.
172 --------------------------------------------------------------------
173 (normal-top-level-add-to-load-path '("custom" "apel"))
174 --------------------------------------------------------------------
176 If you are using Emacs 20.3 or later or XEmacs, there are no need to
177 set up load-path with normal installation.
186 Function put-alist (ITEM VALUE ALIST)
188 Modify ALIST to set VALUE to ITEM. If there is a pair whose car is
189 ITEM, replace its cdr by VALUE. If there is not such pair, create
190 new pair (ITEM . VALUE) and return new alist whose car is the new
191 pair and cdr is ALIST.
193 Function del-alist (ITEM ALIST)
195 If there is a pair whose key is ITEM, delete it from ALIST.
197 Function set-alist (SYMBOL ITEM VALUE)
199 Modify a alist indicated by SYMBOL to set VALUE to ITEM.
201 Ex. (set-alist 'auto-mode-alist "\\.pln$" 'text-mode)
203 Function modify-alist (MODIFIER DEFAULT)
205 Modify alist DEFAULT into alist MODIFIER.
207 Function set-modified-alist (SYMBOL MODIFIER)
209 Modify a value of a SYMBOL into alist MODIFIER. The SYMBOL should
210 be alist. If it is not bound, its value regard as nil.
215 Function add-path (PATH &rest OPTIONS)
217 Add PATH to `load-path' if it exists under `default-load-path'
218 directories and it does not exist in `load-path'.
220 You can use following PATH styles:
222 load-path relative: "PATH" (it is searched from
225 home directory relative: "~/PATH" "~USER/PATH"
227 absolute path: "/FOO/BAR/BAZ"
229 You can specify following OPTIONS:
231 'all-paths --- search from `load-path' instead of
234 'append --- add PATH to the last of `load-path'
236 Function add-latest-path (PATTERN &optional ALL-PATHS)
238 Add latest path matched by regexp PATTERN to `load-path' if it
239 exists under `default-load-path' directories and it does not exist
242 For example, if there is bbdb-1.50 and bbdb-1.51 under site-lisp,
243 and if bbdb-1.51 is newer than bbdb-1.50, and site-lisp is
244 /usr/local/share/emacs/site-lisp,
246 (add-latest-path "bbdb")
248 it adds "/usr/local/share/emacs/site-lisp/bbdb-1.51" to top of
251 If optional argument ALL-PATHS is specified, it is searched from all
252 of `load-path' instead of `default-load-path'.
254 Function get-latest-path (PATTERN &optional ALL-PATHS)
256 Return latest directory in default-load-path which is matched to
257 regexp PATTERN. If optional argument ALL-PATHS is specified, it is
258 searched from all of load-path instead of default-load-path.
260 Ex. (let ((gnus-path (get-latest-path "gnus")))
261 (add-path (expand-file-name "lisp" gnus-path))
262 (add-to-list 'Info-default-directory-list
263 (expand-file-name "texi" gnus-path))
266 Function file-installed-p (FILE &optional PATHS)
268 Return absolute-path of FILE if FILE exists in PATHS. If PATHS is
269 omitted, `load-path' is used.
271 Function exec-installed-p (FILE &optional PATHS SUFFIXES)
273 Return absolute-path of FILE if FILE exists in PATHS. If PATHS is
274 omitted, `exec-path' is used. If SUFFIXES is omitted,
275 `exec-suffix-list' is used.
277 Function module-installed-p (MODULE &optional PATHS)
279 Return non-nil if MODULE is provided or exists in PATHS. If PATHS
280 is omitted, `load-path' is used.
285 Function replace-as-filename (string)
287 Return safety file-name from STRING.
289 It refers variable `filename-filters'. It is list of functions for
290 file-name filter. Default filter refers following variables:
292 Variable filename-limit-length
294 Limit size of file-name.
296 Variable filename-replacement-alist
298 Alist list of characters vs. string as replacement. List of
299 characters represents characters not allowed as file-name.
305 If you write bug-reports and/or suggestions for improvement, please
306 send them to the tm Mailing List:
308 bug-tm-en@chamonix.jaist.ac.jp (English)
309 bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
311 Via the tm ML, you can report APEL bugs, obtain the latest release
312 of APEL, and discuss future enhancements to APEL. To join the tm
313 ML, send an empty e-mail to
315 tm-en-help@chamonix.jaist.ac.jp (English)
316 tm-ja-help@chamonix.jaist.ac.jp (Japanese)
322 Latest release of APEL can be obtained from:
324 ftp://ftp.m17n.org/pub/mule/apel/
330 Development of APEL uses CVS. So latest developing version is
333 (0) cvs login (first time only)
335 % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \
338 CVS password: [CR] # NULL string
342 % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \
346 If you would like to join CVS based development, please send mail to
348 cvs@chamonix.jaist.ac.jp
350 with your account name and UNIX /etc/passwd style crypted password.
351 We hope you will join the open development.