src/README

   1 This directory contains the source files for the C component of GNU Emacs.
   2 Nothing in this directory is needed for using Emacs once it is built
   3 and installed, if the dumped Emacs (on Unix systems) or the Emacs
   4 executable and map files (on VMS systems) are copied elsewhere.
   5
   6 See the files ../README and then ../INSTALL for installation instructions.
   7
   8 Under GNU and Unix systems, the file `Makefile.in' is used as a
   9 template by the script `../configure' to produce `Makefile.c'.  The
  10 same script then uses `cpp' to produce the machine-dependent
  11 `Makefile' from `Makefile.c'; `Makefile' is the file which actually
  12 controls the compilation of Emacs.  Most of this should work
  13 transparently to the user; you should only need to run `../configure',
  14 and then type `make'.
  15
  16 See the file VMSBUILD in this directory for instructions on compiling,
  17 linking and building Emacs on VMS.
  18
  19 The files `*.com' and `temacs.opt' are used on VMS only.
  20 The files `vlimit.h', `ioclt.h' and `param.h' are stubs to
  21 allow compilation on VMS with the minimum amount of #ifdefs.
  22
  23 `uaf.h' contains VMS uaf structure definitions.  This is only needed if
  24 you define READ_SYSUAF.  This should only be done for single-user
  25 systems where you are not overly concerned with security, since it
  26 either requires that you install Emacs with SYSPRV or make SYSUAF.DAT
  27 world readable.  Otherwise, Emacs can determine information about the
  28 current user, but no one else.
  29
  30 `pwd.h' contains definitions for VMS to be able to correctly simulate
  31 `getpwdnam' and `getpwduid'.