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