annotate src/README @ 61899:b5bac1f892c0

*** empty log message ***
author Nick Roberts <nickrob@snap.net.nz>
date Thu, 28 Apr 2005 06:50:20 +0000
parents 7ca787d18982
children 68cfc1db0d26
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25843
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
1 This directory contains the source files for the C component of GNU Emacs.
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
2 Nothing in this directory is needed for using Emacs once it is built
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
3 and installed, if the dumped Emacs (on Unix systems) or the Emacs
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
4 executable and map files (on VMS systems) are copied elsewhere.
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
5
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
6 See the files ../README and then ../INSTALL for installation instructions.
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
7
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
8 Under GNU and Unix systems, the file `Makefile.in' is used as a
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
9 template by the script `../configure' to produce `Makefile.c'. The
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
10 same script then uses `cpp' to produce the machine-dependent
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
11 `Makefile' from `Makefile.c'; `Makefile' is the file which actually
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
12 controls the compilation of Emacs. Most of this should work
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
13 transparently to the user; you should only need to run `../configure',
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
14 and then type `make'.
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
15
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
16 See the file VMSBUILD in this directory for instructions on compiling,
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
17 linking and building Emacs on VMS.
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
18
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
19 The files `*.com' and `temacs.opt' are used on VMS only.
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
20 The files `vlimit.h', `ioclt.h' and `param.h' are stubs to
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
21 allow compilation on VMS with the minimum amount of #ifdefs.
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
22
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
23 `uaf.h' contains VMS uaf structure definitions. This is only needed if
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
24 you define READ_SYSUAF. This should only be done for single-user
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
25 systems where you are not overly concerned with security, since it
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
26 either requires that you install Emacs with SYSPRV or make SYSUAF.DAT
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
27 world readable. Otherwise, Emacs can determine information about the
18e524802887 #ecrt0.c
Dave Love <fx@gnu.org>
parents:
diff changeset
28 current user, but no one else.