Merge from emacs--rel--22
[bpt/emacs.git] / mac / INSTALL
index 1c44aa5..302317b 100644 (file)
@@ -1,17 +1,9 @@
-* BUILDING EMACS ON MAC OS 8/9 AND MAC OS X     -*- outline -*-
+* BUILDING EMACS ON MAC OS Classic AND MAC OS X     -*- outline -*-
 
-Copyright (c) 2001, 2002 Free Software Foundation, Inc.
+Copyright (C) 2001, 2002, 2003, 2004, 2005,
+   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
 
@@ -28,13 +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>
-
-If you have X Window installed on your Mac and you are building Emacs
-to run under Carbon and not X Window, you need to type `./configure
---without-x' instead of `./configure'.
+The --enable-carbon-app specifies that the Carbon GUI application
+should be installed into /Applications.  If you want it to install in
+a different location, specify --enable-carbon-app=<mydir>
 
 You can type `make bootstrap' instead of `make' to rebuild everything,
 including byte-compiling the Lisp files.
@@ -46,31 +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.
 
-  /Application/Emacs.app/Contents/MacOS/Emacs
+To start Emacs as a GUI application from the terminal, the pathname to
+the executable in the bundle, i.e.,
 
-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.
+  /Applications/Emacs.app/Contents/MacOS/Emacs
 
-If you are building Emacs to run on Mac OS X and X Window, you need to
-create a directory containing statically-linked X libraries.
+must be typed to the shell to enable Emacs to locate its resources
+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.
 
-  sudo mkdir /usr/X11R6/libstatic
-  cd /usr/X11R6/libstatic
-  sudo ln -s ../lib/lib*.a ../lib/X11 .
+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:
 
-Instead of typing `./configure' above, type
+  ./configure --with-x
 
-  ./configure --without-carbon --with-x --x-libraries=/usr/X11R6/libstatic
+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
@@ -138,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
@@ -159,23 +150,20 @@ options to user
                    $prefix/bin/emacs to reduce disk space.  Note, this
                    option may removed in the future.
 
-If you are intending to build a binary distribution for X windows, you
-will probably want to follow the directions above to create static
-X11R6 libraries and run the make-package script like this
-
-./make-package --with-x -C,--x-libraries=/usr/X11R6/libstatic
 
 For usage of other options, use the --help option.
 
-* BUILDING EMACS ON MAC OS 8/9
+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.
 
-You can use either Metrowerks CodeWarrior Pro 6 or MPW-GM (Aug. 2001)
-to build Emacs.  MPW-GM can be downloaded free of charge from Apple.
+* BUILDING EMACS ON MAC OS Classic
 
-In either case, you will need MPW-GM to build the make-docfile utility
-and to generate the doc string file DOC.
+You can use MPW-GM (Aug. 2001) to build Emacs.  MPW-GM can be
+downloaded free of charge from Apple.
 
-### IMPORTANT ### You can use StuffIf Expander to decompress and untar
+### IMPORTANT ### You can use StuffIt Expander to decompress and untar
 the distribution.  However, you *must* set the radio button in the
 Preferences->Cross Platform->Convert text files to Macintosh format to
 "Never".  Otherwise the compiled Lisp files will be corrupted.
@@ -183,58 +171,64 @@ Preferences->Cross Platform->Convert text files to Macintosh format to
 (Optional) A subset of the fonts from the GNU intlfonts-1.2
 distribution converted to NFNT format can be obtained from
 
-  ftp://mac-emacs.sourceforge.net/pub/mac-emacs/GNU-fonts.smi.bin
+  http://members.shaw.ca/akochoi-emacs/stories/Resources/GNU-Fonts.smi.bin
 
 To build Emacs in the MPW Shell, simply set the directory to
 ...:emacs:mac: and build the target Emacs of the make file
-makefile.mpw.  I.e., execute the commands
+makefile.MPW.  I.e., execute the commands
 
   make Emacs -f makefile.MPW > Emacs.MakeScript
   Emacs.MakeScript
 
-To build Emacs using CodeWarrior, start up the CodeWarrior IDE, choose
-File->Import Project...  and select the file cw6-mcp.xml.  When
-prompted to save the project, navigate to same directory as the file
-cw6-mcp.xml, name the project emacs-cw6.mcp, and save it there.  Then
-choose Project->Make.  Note that this does not build the DOC file.  To
-do so, use MPW and build the target "Doc" in makefile.MPW.
-
-Once built, the Emacs application (Emacs CW or Emacs MPW) can be
-launched where it is created.
+The above commands create an executable that uses the Carbon API.
+The non-Carbon version can also be created by replacing all the
+occurrences of `Emacs' above with `NonCarbon'.  Not that the
+non-Carbon version does not support some features such as file
+dialogs, drag-and-drop, and Unicode menus.
 
-To build an optimized version of Emacs in CodeWarrior, change the
-value in the Emacs Settings->Code Generation->Global Optimization
-dialog.  To build a version for profiling, check the Profiler
-Information box in the Emacs Settings->Code Generation->PPC Processor
-dialog and include the Profiler PPC.Lib library.
+Once built, the Emacs application (Emacs MPW) can be launched where it
+is created.
 
 * NOTES
 
-Emacs should build and run on a PowerMac running Mac OS 8.6 - 10.2.
+Emacs should build and run on a PowerMac running Mac OS 8.6 - 9.2 (but
+only tested on 9.2.2), and Mac OS X 10.1 - 10.4.
 
 You will need around 100 MB of disk space for the source files and
 intermediate files.
 
-It will not run on machines running Mac OS 8/9 with more than 256 MB
-of physical or virtual memory.  It does not have this restriction when
-it is run under Mac OS X.  But the usual 128MB buffer limit of a
-32-bit Emacs still exists.
-
-Under Mac OS 8/9, there is no support for building the LEIM directory.
-However, it can be built on Mac OS X or another platform and
-transferred to the Mac.
-
-On Mac OS 8/9, to use the same icon as when Emacs is built on Windows
-NT, define GNU_ICON in mac/src/Emacs.r.  Currently Emacs uses a
-generic application icon on the Mac OS X.  A better looking one is
-coming soon.
+Under Mac OS Classic, there is no support for building the LEIM
+directory.  However, it can be built on Mac OS X or another platform
+and transferred to the Mac.
 
 On Mac OS X, installing the emacs files in /usr can cause issues with
-system sofware updates possibly overwriting the distribution.  If this
+system software updates possibly overwriting the distribution.  If this
 is a concern, as it should be in normal binary distributions, please
 use /usr/local as the prefix for installation.
 
+Emacs supports both PowerPC and Intel-based Macintoshes.  However,
+due to the unexec process that Emacs uses to dump core, it is not
+possible at this time to generate a universal binary that supports both
+architectures.  In addition, Rosetta doesn't appear to work correctly
+with PowerPC builds of Emacs; you will have to recompile for Intel.
+Therefore, builds of Emacs are architecture specific.
+
 Enjoy!
 
-Andrew.
-<akochoi@mac.com>
+\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.