annotate lisp/README @ 593:5fd7ba8b56e7

[xemacs-hg @ 2001-05-31 12:45:27 by ben] xemacs-faq.texi: Major rewrite. Update all MS Windows info to current. Redo section 6.1 almost completely. Incorporate sections 1 and 2 of Hrvoje's FAQ. etags.el: Fix infloop when going up to the root. s\cygwin32.h: Don't unilaterally include ntplay, but only when we're compiling with native sound (look in configure now). event-msw.c: Fix yet more problems with C-g handling. Implement debug-mswindows-events. event-stream.c, events.h, signal.c, sysdep.h: Rearrange the signal-handling code to eliminate the former spaghetti logic paths in it. Document clearly what "low-level" and "high-level" timeouts are. Rename some functions with unclear names (e.g. "...alarm...") to names that reflect what they actually do (e.g. "...async_timeout..."). Fix numerous bugs discovered in the process. console-x.h, event-Xt.c, event-msw.c, frame-x.c: Hopefully make XEmacs properly maintain the "iconified" state on frames at all times. This should fix the "can't delete a frame with C-x 5 0 when there's another iconified frame out there" bug. Put a notice in of further changes that should probably be made to clean up the frame-visibility support. (especially directed at Jan Vroonhof) lisp.h, miscplay.c: Rename SBufbyte to CBufbyte to avoid a misleading name. Eliminate UChar, which is not used anywhere and contributes no semantic info. Add a comment about the documentation-only properties of the char/unsigned char typedefs. Add SChar_Binary as an explicitly `signed' version of Char_Binary and put back the `signed' declarations in miscplay.c. alloc.c: Use char typedefs. console-msw.c, device-msw.c, dialog-msw.c, editfns.c, fileio.c, glyphs-eimage.c, menubar-msw.c, ntplay.c, objects-msw.c, realpath.c, redisplay-msw.c, select-msw.c, syswindows.h, win32.c: Eliminate numerous C++ errors. frame-msw.c: Eliminate numerous C++ errors and Mule-ize. glyphs-msw.c: Eliminate numerous C++ errors and use char typedefs. configure.in: Fix problems detecting both native and Linux sound on Cygwin when compiled with --with-msw=no. Rearrange file-coding handling a bit to avoid warning when compiling with Mule. configure.in, configure.usage, INSTALL: Document XEMACS_CC and corresponding compiler option --xemacs-compiler. Explain how to build xemacs using a C++ compiler.
author ben
date Thu, 31 May 2001 12:45:41 +0000
parents 3ecd8885ac67
children 2cf5d151eeb9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 The files in this directory contain source code for the XEmacs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 facilities written in Emacs Lisp. *.el files are Elisp source, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 *.elc files are byte-compiled versions of the corresponding *.el
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 files. Byte-compiled files are architecture-independent.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 #### Someone please update this.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 bogus> When XEmacs starts up, it adds all subdirectories of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 bogus> site-lisp directory. The site-lisp directory normally exists
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 bogus> only in installation trees. For more information about the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 bogus> site-lisp directory see the NEWS file.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 bogus> After XEmacs adds all subdirectories of the site-lisp
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 bogus> directory, it adds all subdirectories of this directory to the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 bogus> load-path (the list of directories to be searched when loading
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 bogus> files.) To speed up this process, this directory has been
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 bogus> rearranged to have very few files at the top-level, so that
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 bogus> emacs doesn't have to stat() several hundred files to find the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 bogus> dozen or so which are actually subdirectories.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 bogus> Directories whose names begin with "-" or "." are not added to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 bogus> the default load-path.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 The only files which remain at top-level are those which you might
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 reasonably want to alter when installing or customizing XEmacs at your
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 site. The files which may appear at top level are:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 paths.el You may need to change the default pathnames here,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 but probably not. This is loaded before XEmacs is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 dumped.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 site-init.el To pre-load additional libraries into XEmacs and dump
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 them in the executable, load them from this file.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 Read the instructions in this file for a description
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 of how to do this.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 site-load.el This is like site-init.el, but if you want the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 docstrings of your preloaded libraries to be kept in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 the DOC file instead of in the executable, you should
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 load them from this file instead. To do this, you must
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 also cause them to be scanned when the DOC file is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 generated by editing ../src/Makefile.in.in and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 rerunning configure.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 site-start.el This is loaded each time XEmacs starts up, before the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 user's .emacs file.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 default.el This is loaded each time XEmacs starts up, after the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 user's .emacs file, unless .emacs sets the variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 inhibit-default-init to t.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 version.el This contains the version information for XEmacs.