annotate lisp/README @ 305:18920a7e9a86

Added tag r21-0b50 for changeset c6de09ad3017
author cvs
date Mon, 13 Aug 2007 10:41:13 +0200
parents 6330739388db
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
1 The files in this directory contain source code for the XEmacs
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
2 facilities written in Emacs Lisp. *.el files are Elisp source, and
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
3 *.elc files are byte-compiled versions of the corresponding *.el
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
4 files. Byte-compiled files are architecture-independent.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
6 #### Someone please update this.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
8 bogus> When XEmacs starts up, it adds all subdirectories of the
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
9 bogus> site-lisp directory. The site-lisp directory normally exists
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
10 bogus> only in installation trees. For more information about the
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
11 bogus> site-lisp directory see the NEWS file.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
13 bogus> After XEmacs adds all subdirectories of the site-lisp
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
14 bogus> directory, it adds all subdirectories of this directory to the
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
15 bogus> load-path (the list of directories to be searched when loading
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
16 bogus> files.) To speed up this process, this directory has been
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
17 bogus> rearranged to have very few files at the top-level, so that
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
18 bogus> emacs doesn't have to stat() several hundred files to find the
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
19 bogus> dozen or so which are actually subdirectories.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
21 bogus> Directories whose names begin with "-" or "." are not added to
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 201
diff changeset
22 bogus> the default load-path.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 The only files which remain at top-level are those which you might
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 reasonably want to alter when installing or customizing XEmacs at your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 site. The files which may appear at top level are:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 paths.el You may need to change the default pathnames here,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 but probably not. This is loaded before XEmacs is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 dumped.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 site-init.el To pre-load additional libraries into XEmacs and dump
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 them in the executable, load them from this file.
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
34 Read the instructions in this file for a description
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
35 of how to do this.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 site-load.el This is like site-init.el, but if you want the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 docstrings of your preloaded libraries to be kept in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 the DOC file instead of in the executable, you should
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 load them from this file instead. To do this, you must
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 also cause them to be scanned when the DOC file is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 generated by editing ../src/Makefile.in.in and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 rerunning configure.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 site-start.el This is loaded each time XEmacs starts up, before the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 user's .emacs file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 default.el This is loaded each time XEmacs starts up, after the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 user's .emacs file, unless .emacs sets the variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 inhibit-default-init to t.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 version.el This contains the version information for XEmacs.