* test/lisp/progmodes/cc-mode-tests.el: Add a test with /***/ in #define lines
[emacs.git] / nextstep / INSTALL
blobf287eb77ffa698a793855e7b4c6a61166a8e14b6
1 Copyright (C) 2008-2019 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 Targeting different macOS versions
49 ----------------------------------
51 The Emacs build process automatically enables or disables macOS
52 features according to the version of macOS it is being built on.  It
53 is possible to override this automatic configuration if you are
54 targeting a different version of macOS, or wish to build one
55 executable that is able to enable or disable features at run-time.
57 To build a version compatible with an older version of macOS use this
58 flag:
60   -DMAC_OS_X_VERSION_MIN_REQUIRED=x
62 and to build for a newer version of macOS:
64   -DMAC_OS_X_VERSION_MAX_ALLOWED=x
66 For example, to enable run-time checks for features available between
67 macOS 10.6, and 10.12 inclusive:
69   ./configure --with-ns CFLAGS="-DMAC_OS_X_VERSION_MIN_REQUIRED=1060 \
70     -DMAC_OS_X_VERSION_MAX_ALLOWED=101200 -g3 -O2"
72 The macOS version numbers are formatted as 10x0 for macOS up to 10.10,
73 and 10xx00 for macOS 10.10 and above.  A full list is provided in
74 /usr/include/AvailabilityMacros.h.
77 Installation
78 ------------
80 Move nextstep/Emacs.app to any desired install location.
84 This file is part of GNU Emacs.
86 GNU Emacs is free software: you can redistribute it and/or modify
87 it under the terms of the GNU General Public License as published by
88 the Free Software Foundation, either version 3 of the License, or
89 (at your option) any later version.
91 GNU Emacs is distributed in the hope that it will be useful,
92 but WITHOUT ANY WARRANTY; without even the implied warranty of
93 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
94 GNU General Public License for more details.
96 You should have received a copy of the GNU General Public License
97 along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.