annotate lisp/README @ 152:4c132ee2d62b

Added tag r20-3b2 for changeset 59463afc5666
author cvs
date Mon, 13 Aug 2007 09:37:21 +0200
parents cca96a509cfe
children eb5470882647
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 The subdirectories of this directory contain source code for the XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 facilities written in Emacs Lisp. *.el files are Elisp source, and *.elc
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 files are byte-compiled versions of the corresponding *.el files.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 Byte-compiled files are architecture-independent.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 When XEmacs starts up, it adds all subdirectories of the site-lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 directory. The site-lisp directory normally exists only in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 installation trees. For more information about the site-lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 directory see the NEWS file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 After XEmacs adds all subdirectories of the site-lisp directory, it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 adds all subdirectories of this directory to the load-path (the list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 of directories to be searched when loading files.) To speed up this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 process, this directory has been rearranged to have very few files at
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 the top-level, so that emacs doesn't have to stat() several hundred
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 files to find the dozen or so which are actually subdirectories.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 Directories whose names begin with "-" or "." are not added to the default
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 load-path.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 The only files which remain at top-level are those which you might
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 reasonably want to alter when installing or customizing XEmacs at your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 site. The files which may appear at top level are:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 paths.el You may need to change the default pathnames here,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 but probably not. This is loaded before XEmacs is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 dumped.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 site-init.el To pre-load additional libraries into XEmacs and dump
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 them in the executable, load them from this file.
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
32 Read the instructions in this file for a description
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
33 of how to do this.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 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
36 docstrings of your preloaded libraries to be kept in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 the DOC file instead of in the executable, you should
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 load them from this file instead. To do this, you must
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 also cause them to be scanned when the DOC file is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 generated by editing ../src/Makefile.in.in and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 rerunning configure.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 site-start.el This is loaded each time XEmacs starts up, before the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 user's .emacs file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 default.el This is loaded each time XEmacs starts up, after the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 user's .emacs file, unless .emacs sets the variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 inhibit-default-init to t.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 version.el This contains the version information for XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 These are the main subdirectories:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 prim Fundamental XEmacs functionality. Some of this is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 pre-dumped with XEmacs, some is autoloaded.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 utils Various utility functions that some other XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 packages build on. These are not user commands.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 modes Text-editing and programming-language-sensitive modes.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 emulators XEmacs can emulate a few different editors. These are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 a bit more than what `modes' generally are.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 term Terminal-specific customization files. When XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 starts, it checks the $TERM environment variable to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 see what type of terminal the user is running on, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 loads a file named $TERM.el from this directory, if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 that file exists.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 x11 X Window System-specific code.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 games Various ways to waste time.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 packages Random other utilities that are not primarily about
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 editing text. For example, code for automatically
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 uncompressing .Z files would be here. This is an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 `everything else' sort of directory.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 Some packages are fairly large; those have been given their own directories:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
83 auctex A package for editing TeX documents.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
84
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 bytecomp The XEmacs-lisp compiler.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 calendar A calendar and appointment manager.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
89 cl Common Lisp compatibility code.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
90
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 comint General code for interacting with inferior processes,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 like shell buffers and lisp interpreters.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
94 custom User environment customization code.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 edebug A source-level debugger for Elisp.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 ediff A comprehensive visual interface to diff and patch.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
100 efs The directory editor, remote FTP frontend.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
101
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
102 egg MULE Input Method.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
103
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 electric The "electric" commands; these implement temporary
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 windows for help, list-buffers, etc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 energize An interface to the Lucid Energize system.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 eos An interface to Sun's SparcWorks product.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 eterm A merge of the comint shell mode with an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112 ANSI-compatible terminal-emulator.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
114 gnats Interface to XEmacs bug reporting system based on
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
115 Cygnus GNATS.
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
116
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
117 gnus A network news and mail reader.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 hm--html-menus Menu interface to html-mode.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 hyperbole An information management and hypertext system.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123 ilisp A comint-based package for interacting with inferior
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124 lisp processes.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
126 iso ISO Latin language support.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
127
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
128 its MULE Input Method.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
129
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
130 locale IE18N stuff.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
131
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
132 mailcrypt Package for dealing with PGP encrypted messages.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
133
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
134 mel MIME encoding library (part of the Tools for MIME).
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
135
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136 mh-e An interface to the MH-E mail handling system.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
138 mu Message Utilities library (part of the Tools for
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
139 MIME).
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
140
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
141 mule Multi-lingual extensions for XEmacs.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
142
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 oobr An Object-Oriented class browser.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 pcl-cvs An interface to the Concurrent Version System.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
147 psgml General purpose SGML editing support with extra
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
148 support for editing HTML.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
149
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 116
diff changeset
150 quail MULE Input Method. [NOT WORKING IN 20.1]
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
151
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152 rmail A BABYL-format mail reader.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 sunpro Additional code for interfacing with SunPro products.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
156 tl Tiny Library (Part of the Tools for MIME).
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
157
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
158 tm Tools for MIME. MIME support for emacs lisp based
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
159 news and mail readers.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 70
diff changeset
160
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 tooltalk An inteface to the ToolTalk communication protocol.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163 viper A full-featured VI emulator.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165 vm View Mail, an UNIX-format alternative to RMAIL.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167 w3 A World Wide Web interface.