code.delx.au - gnu-emacs/blob - 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 You can type `make bootstrap' instead of `make' to rebuild everything,
  37 including byte-compiling the Lisp files.
  38
  39 If you are compiling on Mac OS X versions before 10.2 and have not
  40 installed the GNU texinfo package on your system, the build will
  41 complain that makeinfo cannot be found.  Instructions for installing the
  42 GNU texinfo package are given below.  Alternatively, you can type `make
  43 -k' instead of `make' and safely ignore the error messages and use the
  44 existing info files.
  45
  46 After Emacs is installed, you can run it by typing `emacs -nw' from a
  47 terminal (make sure your path contains /usr/local/bin) or by
  48 double-clicking on /Applications/Emacs.app in the Finder.  To start
  49 Emacs as a GUI application from the terminal, the pathname to the
  50 executable in the bundle, i.e.,
  51
  52   /Application/Emacs.app/Contents/MacOS/Emacs
  53
  54 must be typed to the shell to enable Emacs to locate its resources
  55 correctly.  You may want to create a symlink or alias to this path to
  56 quickly access both the terminal and GUI versions.
  57
  58 If you are building Emacs to run on Mac OS X and X Window System,
  59 instead of typing `./configure' above, type
  60
  61   ./configure --with-x
  62
  63
  64 To use colors in a terminal, put the following lines in the file
  65 ~/.termcap and log in again.
  66
  67 -----
  68 # added ANSI color
  69 vt100|vt100-am|vt100am|dec vt100:\
  70     :pa#64:Co#8:Sf=\E[3%dm:Sb=\E[4%dm:op=\E[m:AF=\E[3%dm:AB=\E[4%dm:\
  71     :do=^J:co#80:li#24:cl=\E[;H\E[2J:sf=2*\ED:\
  72     :le=^H:bs:am:cm=5\E[%i%d;%dH:nd=2\E[C:up=2\E[A:\
  73     :ce=3\E[K:cd=50\E[J:so=2\E[7m:se=2\E[m:us=2\E[4m:ue=2\E[m:\
  74     :md=2\E[1m:mr=2\E[7m:mb=2\E[5m:me=2\E[m:\
  75     :rf=/usr/share/tabset/vt100:\
  76     :rs=\E>\E[?3l\E[?4l\E[?5l\E[?7h\E[?8h\E[;r\E[0m\E(B\E)B\E[2J:\
  77     :ks=\E[?1h\E=:ke=\E[?1l\E>:\
  78     :ku=\EOA:kd=\EOB:kr=\EOC:kl=\EOD:kb=^H:\
  79     :ho=\E[H:k1=\EOP:k2=\EOQ:k3=\EOR:k4=\EOS:pt:sr=2*\EM:vt#3:xn:\
  80     :sc=\E7:rc=\E8:cs=\E[%i%d;%dr:
  81 -----
  82
  83 To build the `info' files in versions prior to Mac OS X 10.2, you need
  84 to install the texinfo software.
  85
  86 To install from source, obtain texinfo-4.2.tar.gz from ftp.gnu.org or
  87 a mirror.  Un-tar it, enter its directory and type
  88
  89   ./configure
  90   make
  91   make install
  92
  93 The last step may need to be performed as root (sudo make install).
  94
  95 You may also like to install ispell, which will allow you to use
  96 ispell and flyspell-mode.  To install ispell from source, you first
  97 need to install GNU textutils.
  98
  99 To do so, download textutils-2.0.tar.gz from ftp.gnu.org or a mirror.
 100 Un-tar it, enter its directory, type
 101
 102   ./configure --host=powerpc-apple-bsd
 103   make
 104   make install
 105
 106 Again, the last step may need to be performed as root.  Note that if you
 107 run `make check', the test for `pr' will fail.
 108
 109 Get and un-tar ispell-3.2.06.tar.gz.  Look for it here:
 110
 111   http://fmg-www.cs.ucla.edu/geoff/ispell.html
 112
 113 Go into its directory, type
 114
 115   cp local.h.samp local.h
 116
 117 Add a line `#define TERMLIB ""' to the end of local.h.
 118
 119 Set the environment variable TMPDIR to an existing directory.  For
 120 example since `/tmp' exists on my machine and I am using `bash', I
 121 typed
 122
 123   export TMPDIR=/tmp
 124
 125 Run `make' and `make install', the latter as root.
 126
 127 * BUILDING BINARY DISTRIBUTIONS FOR MAC OS X
 128
 129 If you are intending to build a binary distribution of Emacs, there is
 130 a script that will greatly simplify the process.  It is called
 131 make-package and it is contained in this directory.  It will generate
 132 a disc image containing a installer bundle.  By default the installer
 133 will place the emacs common files in /usr/local/* and the carbon
 134 application in /Applications.  Typical usage would be
 135
 136 ./make-package
 137
 138 After running, an compressed disk image of the installer will be placed
 139 in a file called EmacsInstaller.dmg.  This file can be then distributed
 140 to whomever would like a binary distribution.  Here are the common
 141 options to user
 142
 143 --with-x         -  Use the X11 GUI instead of the Carbon GUI.
 144 --prefix=DIR     -  Place the common emacs files in the given DIR.  The
 145                     default is /usr/local.  See note below if placing
 146                     in /usr
 147 --self-contained -  Place the common emacs files inside the Emacs.app
 148                     itself.  This makes the application trivial to
 149                     uninstall and copy between computers.
 150 --app-symlink    -  Use a symlink inside the Application to the
 151                     $prefix/bin/emacs to reduce disk space.  Note, this
 152                     option may removed in the future.
 153
 154
 155 For usage of other options, use the --help option.
 156
 157 * BUILDING EMACS ON MAC OS Classic
 158
 159 You can use MPW-GM (Aug. 2001) to build Emacs.  MPW-GM can be
 160 downloaded free of charge from Apple.
 161
 162 ### IMPORTANT ### You can use StuffIt Expander to decompress and untar
 163 the distribution.  However, you *must* set the radio button in the
 164 Preferences->Cross Platform->Convert text files to Macintosh format to
 165 "Never".  Otherwise the compiled Lisp files will be corrupted.
 166
 167 (Optional) A subset of the fonts from the GNU intlfonts-1.2
 168 distribution converted to NFNT format can be obtained from
 169
 170   http://members.shaw.ca/akochoi-emacs/stories/Resources/GNU-Fonts.smi.bin
 171
 172 To build Emacs in the MPW Shell, simply set the directory to
 173 ...:emacs:mac: and build the target Emacs of the make file
 174 makefile.MPW.  I.e., execute the commands
 175
 176   make Emacs -f makefile.MPW > Emacs.MakeScript
 177   Emacs.MakeScript
 178
 179 The above commands create an executable that uses the Carbon API.
 180 The non-Carbon version can also be created by replacing all the
 181 occurrences of `Emacs' above with `NonCarbon'.  Not that the
 182 non-Carbon version does not support some features such as file
 183 dialogs, drag-and-drop, and Unicode menus.
 184
 185 Once built, the Emacs application (Emacs MPW) can be launched where it
 186 is created.
 187
 188 * NOTES
 189
 190 Emacs should build and run on a PowerMac running Mac OS 8.6 - 9.2 (but
 191 only tested on 9.2.2), and Mac OS X 10.1 - 10.4.
 192
 193 You will need around 100 MB of disk space for the source files and
 194 intermediate files.
 195
 196 Under Mac OS Classic, there is no support for building the LEIM
 197 directory.  However, it can be built on Mac OS X or another platform
 198 and transferred to the Mac.
 199
 200 On Mac OS X, installing the emacs files in /usr can cause issues with
 201 system software updates possibly overwriting the distribution.  If this
 202 is a concern, as it should be in normal binary distributions, please
 203 use /usr/local as the prefix for installation.
 204
 205 Emacs supports both PowerPC and Intel-based Macintoshes.  However,
 206 due to the unexec process that Emacs uses to dump core, it is not
 207 possible at this time to generate a universal binary that supports both
 208 architectures.  In addition, Rosetta doesn't appear to work correctly
 209 with PowerPC builds of Emacs; you will have to recompile for Intel.
 210 Therefore, builds of Emacs are architecture specific.
 211
 212 Enjoy!