Merge from emacs--rel--22
[bpt/emacs.git] / mac / INSTALL
index 477f9b3..302317b 100644 (file)
@@ -1,18 +1,9 @@
 * BUILDING EMACS ON MAC OS Classic AND MAC OS X     -*- outline -*-
 
 Copyright (C) 2001, 2002, 2003, 2004, 2005,
-   2006 Free Software Foundation, Inc.
+   2006, 2007 Free Software Foundation, Inc.
+See the end of the file for license conditions.
 
-   Permission is granted to anyone to make or distribute verbatim
-   copies of this document as received, in any medium, provided that
-   the copyright notice and permission notice are preserved, and that
-   the distributor grants the recipient permission for further
-   redistribution as permitted by this notice.
-
-   Permission is granted to distribute modified versions of this
-   document, or of portions of it, under the above conditions,
-   provided also that they carry prominent notices stating who last
-   changed them.
 
 * BUILDING EMACS ON MAC OS X
 
@@ -29,9 +20,9 @@ you try to install into /usr (with ./configure --prefix=/usr), then you
 must install as root using the sudo command.  However, it is not
 recommended; see the notes section below for more details.
 
-The --enable-carbon-app specifies that the carbon GUI application
-should be installed into /Application.  If you want it to install in a
-different location, specify --enable-carbon-app=<mydir>
+The --enable-carbon-app specifies that the Carbon GUI application
+should be installed into /Applications.  If you want it to install in
+different location, specify --enable-carbon-app=<mydir>
 
 You can type `make bootstrap' instead of `make' to rebuild everything,
 including byte-compiling the Lisp files.
@@ -43,26 +34,34 @@ GNU texinfo package are given below.  Alternatively, you can type `make
 -k' instead of `make' and safely ignore the error messages and use the
 existing info files.
 
-After Emacs is installed, you can run it by typing `emacs -nw' from a
-terminal (make sure your path contains /usr/local/bin) or by
-double-clicking on /Applications/Emacs.app in the Finder.  To start
-Emacs as a GUI application from the terminal, the pathname to the
-executable in the bundle, i.e.,
+After Emacs is installed, you can run a text-only terminal version by
+typing `emacs' from a terminal (make sure your path contains
+/usr/local/bin) or a GUI application by double-clicking on
+/Applications/Emacs.app in the Finder.  Even in the terminal version,
+some Carbon-specific functions such as `mac-set-file-creator' are
+still meaningful.
+
+To start Emacs as a GUI application from the terminal, the pathname to
+the executable in the bundle, i.e.,
 
-  /Application/Emacs.app/Contents/MacOS/Emacs
+  /Applications/Emacs.app/Contents/MacOS/Emacs
 
 must be typed to the shell to enable Emacs to locate its resources
-correctly.  You may want to create a symlink or alias to this path to
-quickly access both the terminal and GUI versions.
+correctly.  You may want to create an alias to this path to quickly
+access both the terminal and GUI versions.  You can specify some
+standard Emacs options when invoking Emacs in this way.
 
-If you are building Emacs to run on Mac OS X and X Window System,
-instead of typing `./configure' above, type
+Emacs on Mac OS X is not configured to use X11 unless either it is
+requested or the use of Carbon is disabled explicitly.  So, if you are
+building Emacs to run on X Window System, you need to specify like:
 
   ./configure --with-x
 
+Note that the Carbon-specific functions mentioned above are not
+available on the X11-enabled build.
 
-To use colors in a terminal, put the following lines in the file
-~/.termcap and log in again.
+To use colors in Terminal.app on Mac OS X 10.1, put the following
+lines in the file ~/.termcap and log in again.
 
 -----
 # added ANSI color
@@ -130,7 +129,7 @@ If you are intending to build a binary distribution of Emacs, there is
 a script that will greatly simplify the process.  It is called
 make-package and it is contained in this directory.  It will generate
 a disc image containing a installer bundle.  By default the installer
-will place the emacs common files in /usr/local/* and the carbon
+will place the emacs common files in /usr/local/* and the Carbon
 application in /Applications.  Typical usage would be
 
 ./make-package
@@ -154,6 +153,11 @@ options to user
 
 For usage of other options, use the --help option.
 
+Note: due to the problem "Installing to a directory with non-ASCII
+characters in the name fails" mentioned in etc/PROBLEMS, you may not
+move a self-contained Emacs.app application bundle to a non-ASCII
+directory.
+
 * BUILDING EMACS ON MAC OS Classic
 
 You can use MPW-GM (Aug. 2001) to build Emacs.  MPW-GM can be
@@ -210,3 +214,21 @@ with PowerPC builds of Emacs; you will have to recompile for Intel.
 Therefore, builds of Emacs are architecture specific.
 
 Enjoy!
+
+\f
+This file is part of GNU Emacs.
+
+GNU Emacs is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Emacs is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Emacs; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.