annotate 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 9d177e8d4150
children 3e13cd716cff
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
371
cc15677e0335 Import from CVS: tag r21-2b1
cvs
parents: 359
diff changeset
1 This directory tree holds version 21.2 of XEmacs, the extensible,
253
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
2 customizable, self-documenting real-time display editor. This version
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
3 of XEmacs also runs on various Microsoft Windows platforms including
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
4 MS Windows '95 and MS Windows NT and Cygwin.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 See the file `etc/NEWS' for information on new features and other
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 user-visible changes since the last version of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8
253
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
9 The file `INSTALL' in this directory says how to bring up XEmacs on
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
10 Unix and Cygwin, once you have loaded the entire subtree of this
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
11 directory.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
253
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
13 The file `PROBLEMS' contains information on many common problems that
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 occur in building, installing and running XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15
253
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
16 See the file `nt/README' for instructions on building XEmacs for
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
17 Microsoft Windows.
157b30c96d03 Import from CVS: tag r20-5b25
cvs
parents: 227
diff changeset
18
424
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents: 412
diff changeset
19 The file 'README.packages' will guide you in the installation of
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents: 412
diff changeset
20 (essential) add on packages.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents: 412
diff changeset
21
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 Reports of bugs in XEmacs should be posted to the newsgroup
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 comp.emacs.xemacs or sent to the mailing list xemacs@xemacs.org. See
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 the "Bugs" section of the XEmacs manual for more information on how to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 report bugs. (The file `BUGS' in this directory explains how you can
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 find and read that section using the Info files that come with
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 XEmacs.) See `etc/MAILINGLISTS' for more information on mailing lists
70
131b0175ea99 Import from CVS: tag r20-0b30
cvs
parents: 50
diff changeset
28 relating to XEmacs and other GNU products.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 The file `configure' is a shell script to acclimate XEmacs to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 oddities of your processor and operating system. It will create a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 file named `Makefile' (a script for the `make' program), which helps
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 automate the process of building and installing emacs. See INSTALL
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 for more detailed information.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 The file `configure.in' is the input used by the autoconf program to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 construct the `configure' script. Since XEmacs has configuration
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 requirements that autoconf can't meet, `configure.in' uses an unholy
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 marriage of custom-baked configuration code and autoconf macros; it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 may be wise to avoid rebuilding `configure' from `configure.in' when
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 possible.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 The file `Makefile.in' is a template used by `configure' to create
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 `Makefile'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 There are several subdirectories:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 `src' holds the C code for Emacs (the XEmacs Lisp interpreter and its
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 primitives, the redisplay code, and some basic editing functions).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 `lisp' holds the Emacs Lisp code for XEmacs (most everything else).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 `lib-src' holds the source code for some utility programs for use by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 or with XEmacs, like movemail and etags.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 `etc' holds miscellaneous architecture-independent data files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 XEmacs uses, like the tutorial text and the Zippy the Pinhead quote
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 database. The contents of the `lisp', `info' and `man'
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 subdirectories are architecture-independent too.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 `lwlib' holds the C code for the toolkit objects used by XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 `info' holds the Info documentation tree for XEmacs.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
60 `man' holds the source code for the XEmacs info documentation tree.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 104
diff changeset
62 `nt' holds configuration files for compiling XEmacs under Microsoft Windows
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 104
diff changeset
63 NT. The support for NT is very tentative right now.