src/README

   1 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
   2   Free Software Foundation, Inc.
   3 See the end of the file for license conditions.
   4
   5
   6 This directory contains the source files for the C component of GNU Emacs.
   7 Nothing in this directory is needed for using Emacs once it is built
   8 and installed, if the dumped Emacs (on Unix systems) or the Emacs
   9 executable and map files (on VMS systems) are copied elsewhere.
  10
  11 See the files ../README and then ../INSTALL for installation instructions.
  12
  13 Under GNU and Unix systems, the file `Makefile.in' is used as a
  14 template by the script `../configure' to produce `Makefile.c'.  The
  15 same script then uses `cpp' to produce the machine-dependent
  16 `Makefile' from `Makefile.c'; `Makefile' is the file which actually
  17 controls the compilation of Emacs.  Most of this should work
  18 transparently to the user; you should only need to run `../configure',
  19 and then type `make'.
  20
  21 See the file VMSBUILD in this directory for instructions on compiling,
  22 linking and building Emacs on VMS.
  23
  24 The files `*.com' and `temacs.opt' are used on VMS only.
  25 The files `vlimit.h', `ioclt.h' and `param.h' are stubs to
  26 allow compilation on VMS with the minimum amount of #ifdefs.
  27
  28 `uaf.h' contains VMS uaf structure definitions.  This is only needed if
  29 you define READ_SYSUAF.  This should only be done for single-user
  30 systems where you are not overly concerned with security, since it
  31 either requires that you install Emacs with SYSPRV or make SYSUAF.DAT
  32 world readable.  Otherwise, Emacs can determine information about the
  33 current user, but no one else.
  34
  35 \f
  36 This file is part of GNU Emacs.
  37
  38 GNU Emacs is free software; you can redistribute it and/or modify
  39 it under the terms of the GNU General Public License as published by
  40 the Free Software Foundation; either version 3, or (at your option)
  41 any later version.
  42
  43 GNU Emacs is distributed in the hope that it will be useful,
  44 but WITHOUT ANY WARRANTY; without even the implied warranty of
  45 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  46 GNU General Public License for more details.
  47
  48 You should have received a copy of the GNU General Public License
  49 along with GNU Emacs; see the file COPYING.  If not, write to the
  50 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  51 Boston, MA 02110-1301, USA.