mac/INSTALL

   1 * BUILDING EMACS ON MAC OS Classic AND MAC OS X     -*- outline -*-
   2
   3 Copyright (C) 2001, 2002, 2003, 2004, 2005,
   4    2006 Free Software Foundation, Inc.
   5
   6    Permission is granted to anyone to make or distribute verbatim
   7    copies of this document as received, in any medium, provided that
   8    the copyright notice and permission notice are preserved, and that
   9    the distributor grants the recipient permission for further
  10    redistribution as permitted by this notice.
  11
  12    Permission is granted to distribute modified versions of this
  13    document, or of portions of it, under the above conditions,
  14    provided also that they carry prominent notices stating who last
  15    changed them.
  16
  17 * BUILDING EMACS ON MAC OS X
  18
  19 You should be able to build Emacs on Mac OS X by typing the following
  20 commands at the top-level directory after the source distribution is
  21 un-tarred.
  22
  23   ./configure --enable-carbon-app
  24   make
  25   make install
  26
  27 The last step may fail if you do not have permissions to install.  If
  28 you try to install into /usr (with ./configure --prefix=/usr), then you
  29 must install as root using the sudo command.  However, it is not
  30 recommended; see the notes section below for more details.
  31
  32 The --enable-carbon-app specifies that the carbon GUI application
  33 should be installed into /Application.  If you want it to install in a
  34 different location, specify --enable-carbon-app=<mydir>
  35
  36 If you have X Window installed on your Mac and you are building Emacs
  37 to run under Carbon and not X Window, you need to type `./configure
  38 --without-x' instead of `./configure'.
  39
  40 You can type `make bootstrap' instead of `make' to rebuild everything,
  41 including byte-compiling the Lisp files.
  42
  43 If you are compiling on Mac OS X versions before 10.2 and have not
  44 installed the GNU texinfo package on your system, the build will
  45 complain that makeinfo cannot be found.  Instructions for installing the
  46 GNU texinfo package are given below.  Alternatively, you can type `make
  47 -k' instead of `make' and safely ignore the error messages and use the
  48 existing info files.
  49
  50 After Emacs is installed, you can run it by typing `emacs -nw' from a
  51 terminal (make sure your path contains /usr/local/bin) or by
  52 double-clicking on /Applications/Emacs.app in the Finder.  To start
  53 Emacs as a GUI application from the terminal, the pathname to the
  54 executable in the bundle, i.e.,
  55
  56   /Application/Emacs.app/Contents/MacOS/Emacs
  57
  58 must be typed to the shell to enable Emacs to locate its resources
  59 correctly.  You may want to create a symlink or alias to this path to
  60 quickly access both the terminal and GUI versions.
  61
  62 If you are building Emacs to run on Mac OS X and X Window,
  63 instead of typing `./configure' above, type
  64
  65   ./configure --without-carbon --with-x
  66
  67
  68 To use colors in a terminal, put the following lines in the file
  69 ~/.termcap and log in again.
  70
  71 -----
  72 # added ANSI color
  73 vt100|vt100-am|vt100am|dec vt100:\
  74     :pa#64:Co#8:Sf=\E[3%dm:Sb=\E[4%dm:op=\E[m:AF=\E[3%dm:AB=\E[4%dm:\
  75     :do=^J:co#80:li#24:cl=\E[;H\E[2J:sf=2*\ED:\
  76     :le=^H:bs:am:cm=5\E[%i%d;%dH:nd=2\E[C:up=2\E[A:\
  77     :ce=3\E[K:cd=50\E[J:so=2\E[7m:se=2\E[m:us=2\E[4m:ue=2\E[m:\
  78     :md=2\E[1m:mr=2\E[7m:mb=2\E[5m:me=2\E[m:\
  79     :rf=/usr/share/tabset/vt100:\
  80     :rs=\E>\E[?3l\E[?4l\E[?5l\E[?7h\E[?8h\E[;r\E[0m\E(B\E)B\E[2J:\
  81     :ks=\E[?1h\E=:ke=\E[?1l\E>:\
  82     :ku=\EOA:kd=\EOB:kr=\EOC:kl=\EOD:kb=^H:\
  83     :ho=\E[H:k1=\EOP:k2=\EOQ:k3=\EOR:k4=\EOS:pt:sr=2*\EM:vt#3:xn:\
  84     :sc=\E7:rc=\E8:cs=\E[%i%d;%dr:
  85 -----
  86
  87 To build the `info' files in versions prior to Mac OS X 10.2, you need
  88 to install the texinfo software.
  89
  90 To install from source, obtain texinfo-4.2.tar.gz from ftp.gnu.org or
  91 a mirror.  Un-tar it, enter its directory and type
  92
  93   ./configure
  94   make
  95   make install
  96
  97 The last step may need to be performed as root (sudo make install).
  98
  99 You may also like to install ispell, which will allow you to use
 100 ispell and flyspell-mode.  To install ispell from source, you first
 101 need to install GNU textutils.
 102
 103 To do so, download textutils-2.0.tar.gz from ftp.gnu.org or a mirror.
 104 Un-tar it, enter its directory, type
 105
 106   ./configure --host=powerpc-apple-bsd
 107   make
 108   make install
 109
 110 Again, the last step may need to be performed as root.  Note that if you
 111 run `make check', the test for `pr' will fail.
 112
 113 Get and un-tar ispell-3.2.06.tar.gz.  Look for it here:
 114
 115   http://fmg-www.cs.ucla.edu/geoff/ispell.html
 116
 117 Go into its directory, type
 118
 119   cp local.h.samp local.h
 120
 121 Add a line `#define TERMLIB ""' to the end of local.h.
 122
 123 Set the environment variable TMPDIR to an existing directory.  For
 124 example since `/tmp' exists on my machine and I am using `bash', I
 125 typed
 126
 127   export TMPDIR=/tmp
 128
 129 Run `make' and `make install', the latter as root.
 130
 131 * BUILDING BINARY DISTRIBUTIONS FOR MAC OS X
 132
 133 If you are intending to build a binary distribution of Emacs, there is
 134 a script that will greatly simplify the process.  It is called
 135 make-package and it is contained in this directory.  It will generate
 136 a disc image containing a installer bundle.  By default the installer
 137 will place the emacs common files in /usr/local/* and the carbon
 138 application in /Applications.  Typical usage would be
 139
 140 ./make-package
 141
 142 After running, an compressed disk image of the installer will be placed
 143 in a file called EmacsInstaller.dmg.  This file can be then distributed
 144 to whomever would like a binary distribution.  Here are the common
 145 options to user
 146
 147 --with-x         -  Use the X11 GUI instead of the Carbon GUI.
 148 --prefix=DIR     -  Place the common emacs files in the given DIR.  The
 149                     default is /usr/local.  See note below if placing
 150                     in /usr
 151 --self-contained -  Place the common emacs files inside the Emacs.app
 152                     itself.  This makes the application trivial to
 153                     uninstall and copy between computers.
 154 --app-symlink    -  Use a symlink inside the Application to the
 155                     $prefix/bin/emacs to reduce disk space.  Note, this
 156                     option may removed in the future.
 157
 158
 159 For usage of other options, use the --help option.
 160
 161 * BUILDING EMACS ON MAC OS Classic
 162
 163 FIXME: You can use either Metrowerks CodeWarrior Pro 6 or MPW-GM
 164 (Aug. 2001) to build Emacs.  MPW-GM can be downloaded free of charge
 165 from Apple.
 166
 167 In either case, you will need MPW-GM to build the make-docfile utility
 168 and to generate the doc string file DOC.
 169
 170 ### IMPORTANT ### You can use StuffIt Expander to decompress and untar
 171 the distribution.  However, you *must* set the radio button in the
 172 Preferences->Cross Platform->Convert text files to Macintosh format to
 173 "Never".  Otherwise the compiled Lisp files will be corrupted.
 174
 175 FIXME: (Optional) A subset of the fonts from the GNU intlfonts-1.2
 176 distribution converted to NFNT format can be obtained from
 177
 178   ftp://mac-emacs.sourceforge.net/pub/mac-emacs/GNU-fonts.smi.bin
 179
 180 To build Emacs in the MPW Shell, simply set the directory to
 181 ...:emacs:mac: and build the target Emacs of the make file
 182 makefile.MPW.  I.e., execute the commands
 183
 184   make Emacs -f makefile.MPW > Emacs.MakeScript
 185   Emacs.MakeScript
 186
 187 The above commands create an executable that uses the Carbon API.  The
 188 non-Carbon version can also be created by replacing all the
 189 occurrences of `Emacs' above with `NonCarbon'.  Not that the
 190 non-Carbon version does not support some features such as file
 191 dialogs, drag-and-drop, and Unicode menus.
 192
 193 FIXME: To build Emacs using CodeWarrior, start up the CodeWarrior IDE,
 194 choose File->Import Project...  and select the file cw6-mcp.xml.  When
 195 prompted to save the project, navigate to same directory as the file
 196 cw6-mcp.xml, name the project emacs-cw6.mcp, and save it there.  Then
 197 choose Project->Make.  Note that this does not build the DOC file.  To
 198 do so, use MPW and build the target "Doc" in makefile.MPW.
 199
 200 FIXME: Once built, the Emacs application (Emacs CW or Emacs MPW) can
 201 be launched where it is created.
 202
 203 FIXME: To build an optimized version of Emacs in CodeWarrior, change
 204 the value in the Emacs Settings->Code Generation->Global Optimization
 205 dialog.  To build a version for profiling, check the Profiler
 206 Information box in the Emacs Settings->Code Generation->PPC Processor
 207 dialog and include the Profiler PPC.Lib library.
 208
 209 * NOTES
 210
 211 Emacs should build and run on a PowerMac running Mac OS 8.6 - 9.2 (but
 212 only tested on 9.2.2), and Mac OS X 10.1 - 10.4.
 213
 214 You will need around 100 MB of disk space for the source files and
 215 intermediate files.
 216
 217 Under Mac OS Classic, there is no support for building the LEIM
 218 directory.  However, it can be built on Mac OS X or another platform
 219 and transferred to the Mac.
 220
 221 On Mac OS X, installing the emacs files in /usr can cause issues with
 222 system software updates possibly overwriting the distribution.  If this
 223 is a concern, as it should be in normal binary distributions, please
 224 use /usr/local as the prefix for installation.
 225
 226 Emacs supports both PowerPC and Intel-based Macintoshes.  However,
 227 due to the unexec process that Emacs uses to dump core, it is not
 228 possible at this time to generate a universal binary that supports both
 229 architectures.  In addition, Rosetta doesn't appear to work correctly
 230 with PowerPC builds of Emacs; you will have to recompile for Intel.
 231 Therefore, builds of Emacs are architecture specific.
 232
 233 There are some compile-time flags that enable experimental features.
 234 Please use them at your own risk after reading the corresponding
 235 threads in the emacs-devel@gnu.org archive.
 236
 237   USE_ATSUI: Enable ATSUI (Apple Type Services for Unicode Imaging)
 238   support.  Available on Mac OS 9/Carbon and Mac OS X.
 239   http://lists.gnu.org/archive/html/emacs-devel/2005-10/msg00005.html
 240
 241   SELECT_USE_CFSOCKET: Avoid polling in sys_select (in src/mac.c).
 242   Available on Mac OS X.
 243   http://lists.gnu.org/archive/html/emacs-devel/2004-12/msg00789.html
 244
 245 Enjoy!