Mercurial > hg > xemacs-beta

comparison lisp/README @ 276:6330739388db r21-0b36

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-0b36
author cvs
date Mon, 13 Aug 2007 10:30:37 +0200
parents eb5470882647
children
comparison
equal deleted inserted replaced
275:a68ae4439f57 276:6330739388db
1 The files in this directory contain source code for the XEmacs
2 facilities written in Emacs Lisp. *.el files are Elisp source, and
3 *.elc files are byte-compiled versions of the corresponding *.el
4 files. Byte-compiled files are architecture-independent.
1 5
2 The subdirectories of this directory contain source code for the XEmacs 6 #### Someone please update this.
3 facilities written in Emacs Lisp. *.el files are Elisp source, and *.elc
4 files are byte-compiled versions of the corresponding *.el files.
5 Byte-compiled files are architecture-independent.
6 7
7 When XEmacs starts up, it adds all subdirectories of the site-lisp 8 bogus> When XEmacs starts up, it adds all subdirectories of the
8 directory. The site-lisp directory normally exists only in 9 bogus> site-lisp directory. The site-lisp directory normally exists
9 installation trees. For more information about the site-lisp 10 bogus> only in installation trees. For more information about the
10 directory see the NEWS file. 11 bogus> site-lisp directory see the NEWS file.
11 12
12 After XEmacs adds all subdirectories of the site-lisp directory, it 13 bogus> After XEmacs adds all subdirectories of the site-lisp
13 adds all subdirectories of this directory to the load-path (the list 14 bogus> directory, it adds all subdirectories of this directory to the
14 of directories to be searched when loading files.) To speed up this 15 bogus> load-path (the list of directories to be searched when loading
15 process, this directory has been rearranged to have very few files at 16 bogus> files.) To speed up this process, this directory has been
16 the top-level, so that emacs doesn't have to stat() several hundred 17 bogus> rearranged to have very few files at the top-level, so that
17 files to find the dozen or so which are actually subdirectories. 18 bogus> emacs doesn't have to stat() several hundred files to find the
19 bogus> dozen or so which are actually subdirectories.
18 20
19 Directories whose names begin with "-" or "." are not added to the default 21 bogus> Directories whose names begin with "-" or "." are not added to
20 load-path. 22 bogus> the default load-path.
21 23
22 The only files which remain at top-level are those which you might 24 The only files which remain at top-level are those which you might
23 reasonably want to alter when installing or customizing XEmacs at your 25 reasonably want to alter when installing or customizing XEmacs at your
24 site. The files which may appear at top level are: 26 site. The files which may appear at top level are:
25 27
46 default.el This is loaded each time XEmacs starts up, after the 48 default.el This is loaded each time XEmacs starts up, after the
47 user's .emacs file, unless .emacs sets the variable 49 user's .emacs file, unless .emacs sets the variable
48 inhibit-default-init to t. 50 inhibit-default-init to t.
49 51
50 version.el This contains the version information for XEmacs. 52 version.el This contains the version information for XEmacs.
51
52
53 These are the main subdirectories:
54
55 prim Fundamental XEmacs functionality. Some of this is
56 pre-dumped with XEmacs, some is autoloaded.
57
58 utils Various utility functions that some other XEmacs
59 packages build on. These are not user commands.
60
61 modes Text-editing and programming-language-sensitive modes.
62
63 emulators XEmacs can emulate a few different editors. These are
64 a bit more than what `modes' generally are.
65
66 term Terminal-specific customization files. When XEmacs
67 starts, it checks the $TERM environment variable to
68 see what type of terminal the user is running on, and
69 loads a file named $TERM.el from this directory, if
70 that file exists.
71
72 x11 X Window System-specific code.
73
74 games Various fun sorts of things.
75
76 packages Random other utilities that are not primarily about
77 editing text. For example, code for automatically
78 uncompressing .Z files would be here. This is an
79 `everything else' sort of directory.
80
81 Some packages are fairly large; those have been given their own directories:
82
83 auctex A package for editing TeX documents. [Available as
84 installable package]
85
86 bytecomp The XEmacs-lisp compiler.
87
88 calendar A calendar and appointment manager.
89
90 cl Common Lisp compatibility code.
91
92 comint General code for interacting with inferior processes,
93 like shell buffers and lisp interpreters.
94
95 custom User environment customization code.
96
97 edebug A source-level debugger for Elisp.
98
99 ediff A comprehensive visual interface to diff and patch.
100
101 efs The directory editor, remote FTP frontend.
102
103 egg MULE Input Method.
104
105 electric The "electric" commands; these implement temporary
106 windows for help, list-buffers, etc.
107
108 eos An interface to Sun's SparcWorks product.
109
110 eterm A merge of the comint shell mode with an
111 ANSI-compatible terminal-emulator.
112
113 gnats Interface to XEmacs bug reporting system based on
114 Cygnus GNATS.
115
116 gnus A network news and mail reader. [Available as
117 installable package]
118
119 hm--html-menus Menu interface to html-mode.
120
121 hyperbole An information management and hypertext system.
122
123 ilisp A comint-based package for interacting with inferior
124 lisp processes.
125
126 iso ISO Latin language support.
127
128 its MULE Input Method. [Requires installing LEIM at
129 XEmacs build]
130
131 language MULE non-English language support. [Requires
132 installing LEIM at XEmacs build]
133
134 locale IE18N stuff.
135
136 mailcrypt Package for dealing with PGP encrypted messages.
137
138 mel MIME encoding library (part of the Tools for MIME).
139
140 mh-e An interface to the MH-E mail handling system.
141
142 mu Message Utilities library (part of the Tools for
143 MIME).
144
145 mule Multi-lingual extensions for XEmacs. [Requires
146 installing LEIM at XEmacs build]
147
148 oobr An Object-Oriented class browser.
149
150 pcl-cvs An interface to the Concurrent Version System.
151
152 psgml General purpose SGML editing support with extra
153 support for editing HTML.
154
155 quail MULE Input Method. [Requires installing LEIM at
156 XEmacs build]
157
158 rmail A BABYL-format mail reader.
159
160 sunpro Additional code for interfacing with SunPro products.
161
162 tl Tiny Library (Part of the Tools for MIME).
163
164 tm Tools for MIME. MIME support for emacs lisp based
165 news and mail readers.
166
167 tooltalk An inteface to the ToolTalk communication protocol.
168
169 viper A full-featured VI emulator.
170
171 vm View Mail, an UNIX-format alternative to RMAIL.
172
173 w3 A World Wide Web interface. [Available as installable
174 package]