diff options
Diffstat (limited to 'src/README')
-rw-r--r-- | src/README | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/README b/src/README new file mode 100644 index 00000000000..7ce61995353 --- /dev/null +++ b/src/README @@ -0,0 +1,26 @@ +This directory contains the source files for the C component of GNU Emacs. +Nothing in this directory is needed for using Emacs once it is built +and installed, if the dumped Emacs (on Unix systems) or the Emacs +executable and map files (on VMS systems) are copied elsewhere. + +On Unix, building is controlled by a makefile called `xmakefile' +that is generated with machine-dependent contents from `ymakefile' +using `cpp'. `Makefile' just invokes `cpp' to produce `xmakefile' +and then runs `make' on `xmakefile'. + +See the file VMSBUILD in this directory for instructions on compiling, +linking and building Emacs on VMS. + +The files `*.com' and `temacs.opt' are used on VMS only. +The files `vlimit.h', `ioclt.h' and `param.h' are stubs to +allow compilation on VMS with the minimum amount of #ifdefs. + +`uaf.h' contains VMS uaf structure definitions. This is only needed if +you define READ_SYSUAF. This should only be done for single-user +systems where you are not overly concerned with security, since it +either requires that you install Emacs with SYSPRV or make SYSUAF.DAT +world readable. Otherwise, Emacs can determine information about the +current user, but no one else. + +`pwd.h' contains definitions for VMS to be able to correctly simulate +`getpwdnam' and `getpwduid'. |