Mercurial > hg > xemacs-beta

comparison README @ 623:3e13cd716cff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2001-06-22 01:51:40 by ben] update README
author ben
date Fri, 22 Jun 2001 01:51:40 +0000
parents 9d177e8d4150
children eba92770173a
comparison
equal deleted inserted replaced
622:11502791fc1c 623:3e13cd716cff
1 This directory tree holds version 21.2 of XEmacs, the extensible, 1 This directory tree holds version 21.5 of XEmacs.
2 customizable, self-documenting real-time display editor. This version 2
3 of XEmacs also runs on various Microsoft Windows platforms including 3
4 MS Windows '95 and MS Windows NT and Cygwin. 4
5 *** What is XEmacs?
6
7 XEmacs is a powerful, highly customizable open source text editor and
8 application development system, with full GUI support. It is protected
9 under the GNU Public License and related to other versions of Emacs, in
10 particular GNU Emacs. Its emphasis is on modern graphical user
11 interface support and an open software development model, similar to
12 Linux. XEmacs has an active development community numbering in the
13 hundreds (and thousands of active beta testers on top of this), and runs
14 on all versions of MS Windows, on Linux, and on nearly every other
15 version of Unix in existence. Support for XEmacs has been supplied by
16 Sun Microsystems, University of Illinois, Lucid, ETL/Electrotechnical
17 Laboratory, Amdahl Corporation, BeOpen, and others, as well as the
18 unpaid time of a great number of individual developers.
19
20
21
22 *** What platforms does it run on?
23
24 -- MS Windows (It has been tested on NT, 2000, 95, 98, and ME; you
25 can also compile Cygwin and MinGW versions.)
26 -- Unix (It is regularly tested on Linux, Solaris, SunOS, HP/UX,
27 FreeBSD, OpenBSD, BSD/OS aka BSDI, Tru64 aka DEC/OSF, SCO5,
28 and probably others. It should work on all versions of Unix
29 created in the last 10 years or so, perhaps with a bit of
30 work on more obscure platforms to correct bit-rot. It uses
31 a sophisticated configuration system to auto-detect zillions
32 of features that are implemented differently in different
33 versions of Unix, so it will probably work on your vendor's
34 version, possibly with a bit of tweaking, even if we've
35 never heard of it.)
36 -- MacOS/X (As an X Windows application. Unfortunately there is no
37 support currently for MacOS-specific features.)
38
39 There is also a port of XEmacs 19.14 (an older version, circa 1996)
40 for all versions of MacOS, with extensive support for MacOS-specific
41 features. See the FAQ for more details.
42
43 There are rumors of an in-progress port to OS/2. See the FAQ.
44
45 XEmacs will probably never work on MS/DOS or Windows 3.1, and we're
46 not particularly interested in patches for these platforms, as they
47 would introduce huge amounts of code clutter due to the woefully
48 underfeatured nature of these systems. (See GNU Emacs for a port to
49 MS/DOS.)
50
51
52
53 *** Where's the FAQ?
54
55 Look at `man/xemacs-faq.texi'.
56
57 For the very latest version, see
58 http://cvs.xemacs.org/cgi-bin/cvswebxe/xemacs/man/xemacs-faq.texi.
59
60
61
62 *** Where's the latest version?
63
64 For up-to-date information on XEmacs, see http://www.xemacs.org.
65
66 To download XEmacs, see http://ftp.xemacs.org/ or
67 ftp://ftp.xemacs.org/pub/xemacs/.
68
69 For the latest experimental sources, see http://cvs.xemacs.org/, which
70 gives instructions on how to get started with CVS access.
71
72 There are numerous mailing lists for discussion of XEmacs. The
73 current description of these lists can be found at
74 http://www.xemacs.org/Lists/, or see `etc/MAILINGLISTS'. General
75 discussion of bugs, new features, etc. takes place on
76 xemacs-beta@xemacs.org.
77
78
79
80 *** How do I build and install XEmacs?
5 81
6 See the file `etc/NEWS' for information on new features and other 82 See the file `etc/NEWS' for information on new features and other
7 user-visible changes since the last version of XEmacs. 83 user-visible changes since the last version of XEmacs.
8 84
9 The file `INSTALL' in this directory says how to bring up XEmacs on 85 The file `INSTALL' in this directory says how to bring up XEmacs on
10 Unix and Cygwin, once you have loaded the entire subtree of this 86 Unix and Cygwin, once you have loaded the entire subtree of this
11 directory. 87 directory.
12 88
13 The file `PROBLEMS' contains information on many common problems that
14 occur in building, installing and running XEmacs.
15
16 See the file `nt/README' for instructions on building XEmacs for 89 See the file `nt/README' for instructions on building XEmacs for
17 Microsoft Windows. 90 Microsoft Windows.
18 91
19 The file 'README.packages' will guide you in the installation of 92 The file 'README.packages' will guide you in the installation of
20 (essential) add on packages. 93 (essential) add on packages.
21 94
22 Reports of bugs in XEmacs should be posted to the newsgroup 95
23 comp.emacs.xemacs or sent to the mailing list xemacs@xemacs.org. See 96
24 the "Bugs" section of the XEmacs manual for more information on how to 97 *** How do I deal with bugs or with problems building, installing, or running?
25 report bugs. (The file `BUGS' in this directory explains how you can 98
26 find and read that section using the Info files that come with 99 The file `PROBLEMS' contains information on many common problems that
27 XEmacs.) See `etc/MAILINGLISTS' for more information on mailing lists 100 occur in building, installing and running XEmacs.
28 relating to XEmacs and other GNU products. 101
102 Reports of bugs in XEmacs should be sent to xemacs-beta@xemacs.org.
103 You can also post to the newsgroup comp.emacs.xemacs (or equivalentlt,
104 send to the mailing list xemacs@xemacs.org), but it is less likely
105 that the developers will see it in a timely fashion. See the "Bugs"
106 section of the XEmacs manual for more information on how to report
107 bugs. (The file `BUGS' in this directory explains how you can find
108 and read that section using the Info files that come with XEmacs.)
109 See `etc/MAILINGLISTS' for more information on mailing lists relating
110 to XEmacs.
111
112
113 *** What's the basic layout of the code?
29 114
30 The file `configure' is a shell script to acclimate XEmacs to the 115 The file `configure' is a shell script to acclimate XEmacs to the
31 oddities of your processor and operating system. It will create a 116 oddities of your processor and operating system. It will create a
32 file named `Makefile' (a script for the `make' program), which helps 117 file named `Makefile' (a script for the `make' program), which helps
33 automate the process of building and installing emacs. See INSTALL 118 automate the process of building and installing emacs. See INSTALL
43 The file `Makefile.in' is a template used by `configure' to create 128 The file `Makefile.in' is a template used by `configure' to create
44 `Makefile'. 129 `Makefile'.
45 130
46 There are several subdirectories: 131 There are several subdirectories:
47 132
48 `src' holds the C code for Emacs (the XEmacs Lisp interpreter and its 133 `src' holds the C code for XEmacs (the XEmacs Lisp interpreter and its
49 primitives, the redisplay code, and some basic editing functions). 134 primitives, the redisplay code, and some basic editing functions).
50 `lisp' holds the Emacs Lisp code for XEmacs (most everything else). 135 `lisp' holds the XEmacs Lisp code for XEmacs (most everything else).
51 `lib-src' holds the source code for some utility programs for use by 136 `lib-src' holds the source code for some utility programs for use by
52 or with XEmacs, like movemail and etags. 137 or with XEmacs, like movemail and etags.
53 `etc' holds miscellaneous architecture-independent data files 138 `etc' holds miscellaneous architecture-independent data files
54 XEmacs uses, like the tutorial text and the Zippy the Pinhead quote 139 XEmacs uses, like the tutorial text and the Zippy the Pinhead quote
55 database. The contents of the `lisp', `info' and `man' 140 database. The contents of the `lisp', `info' and `man'
56 subdirectories are architecture-independent too. 141 subdirectories are architecture-independent too.
57 `lwlib' holds the C code for the toolkit objects used by XEmacs. 142 `lwlib' holds the C code for the X toolkit objects used by XEmacs.
58
59 `info' holds the Info documentation tree for XEmacs. 143 `info' holds the Info documentation tree for XEmacs.
60 `man' holds the source code for the XEmacs info documentation tree. 144 `man' holds the source code for the XEmacs online documentation.
61 145 `nt' holds files used compiling XEmacs under Microsoft Windows.
62 `nt' holds configuration files for compiling XEmacs under Microsoft Windows
63 NT. The support for NT is very tentative right now.