Document reserved keys
[emacs.git] / nextstep / INSTALL
blob64f8f8fcf70739724d5c0e6f96542418edad411a
1 Copyright (C) 2008-2018 Free Software Foundation, Inc.
2 See the end of the file for license conditions.
5 Requirements
6 ------------
7 Mac OS X 10.6 or later
9 - or -
11 GNUstep "Startup 0.23" or later
12 Tested on GNU/Linux, may work on other systems.
15 Compilation
16 -----------
18 In the top-level directory, use:
20   ./configure --with-ns
22 (On macOS, --with-ns is enabled by default.)
24 Then run:
26   make
28 This will compile all the files.
30 In order to run Emacs, you must run:
32   src/emacs
34 In order to install Emacs, you must run:
36   make install
38 This will assemble the app in nextstep/Emacs.app (i.e., the --prefix
39 argument has no effect in this case).  You can then move the Emacs.app
40 bundle to a location of your choice.
42 If you pass the --disable-ns-self-contained option to configure, the lisp
43 files will be installed under whatever 'prefix' is set to (defaults to
44 /usr/local).  The bundle will be smaller, but depend on these resources (may
45 require 'sudo' for "make install").
48 Installation
49 ------------
51 Move nextstep/Emacs.app to any desired install location.
55 This file is part of GNU Emacs.
57 GNU Emacs is free software: you can redistribute it and/or modify
58 it under the terms of the GNU General Public License as published by
59 the Free Software Foundation, either version 3 of the License, or
60 (at your option) any later version.
62 GNU Emacs is distributed in the hope that it will be useful,
63 but WITHOUT ANY WARRANTY; without even the implied warranty of
64 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
65 GNU General Public License for more details.
67 You should have received a copy of the GNU General Public License
68 along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.