mac/INSTALL

   1 * BUILDING EMACS ON MAC OS 8/9 AND MAC OS X     -*- outline -*-
   2
   3 Copyright (c) 2001, 2002 Free Software Foundation, Inc.
   4
   5    Permission is granted to anyone to make or distribute verbatim
   6    copies of this document as received, in any medium, provided that
   7    the copyright notice and permission notice are preserved, and that
   8    the distributor grants the recipient permission for further
   9    redistribution as permitted by this notice.
  10
  11    Permission is granted to distribute modified versions of this
  12    document, or of portions of it, under the above conditions,
  13    provided also that they carry prominent notices stating who last
  14    changed them.
  15
  16 * BUILDING EMACS ON MAC OS X
  17
  18 You should be able to build Emacs on Mac OS X by typing the following
  19 commands at the top-level directory after the source distribution is
  20 un-tarred.
  21
  22   ./configure
  23   make
  24   make install
  25
  26 The last step must be performed as root.
  27
  28 You can type `make bootstrap' instead of `make' to rebuild everything,
  29 including byte-compiling the Lisp files.
  30
  31 If you have not installed the GNU texinfo package on your system, the
  32 build will complain that makeinfo cannot be found.  Instructions for
  33 installing the GNU texinfo package are given below.  Alternatively,
  34 you can type `make -k' instead of `make' and safely ignore the error
  35 messages and use the existing info files.
  36
  37 After Emacs is installed, you can run it by typing `emacs -nw' from a
  38 terminal (make sure your path contains /usr/local/bin) or by
  39 double-clicking on mac/Emacs.app in the Finder.  At present,
  40 command-line options cannot be passed to Emacs running under the Aqua
  41 GUI.  This should soon be fixed.
  42
  43 If you are building Emacs to run on Mac OS X and X Window, you need to
  44 create a directory containing statically-linked X libraries.
  45
  46   sudo mkdir /usr/X11R6/libstatic
  47   cd /usr/X11R6/libstatic
  48   sudo ln -s ../lib/lib*.a ../lib/X11 .
  49
  50 Instead of typing `./configure' above, type
  51
  52   ./configure --without-carbon --with-x --x-libraries=/usr/X11R6/libstatic
  53
  54 To use colors in a terminal, put the following lines in the file
  55 ~/.termcap and log in again.
  56
  57 -----
  58 # added ANSI color
  59 vt100|vt100-am|vt100am|dec vt100:\
  60     :pa#64:Co#8:Sf=\E[3%dm:Sb=\E[4%dm:op=\E[m:AF=\E[3%dm:AB=\E[4%dm:\
  61     :do=^J:co#80:li#24:cl=\E[;H\E[2J:sf=2*\ED:\
  62     :le=^H:bs:am:cm=5\E[%i%d;%dH:nd=2\E[C:up=2\E[A:\
  63     :ce=3\E[K:cd=50\E[J:so=2\E[7m:se=2\E[m:us=2\E[4m:ue=2\E[m:\
  64     :md=2\E[1m:mr=2\E[7m:mb=2\E[5m:me=2\E[m:\
  65     :rf=/usr/share/tabset/vt100:\
  66     :rs=\E>\E[?3l\E[?4l\E[?5l\E[?7h\E[?8h\E[;r\E[0m\E(B\E)B\E[2J:\
  67     :ks=\E[?1h\E=:ke=\E[?1l\E>:\
  68     :ku=\EOA:kd=\EOB:kr=\EOC:kl=\EOD:kb=^H:\
  69     :ho=\E[H:k1=\EOP:k2=\EOQ:k3=\EOR:k4=\EOS:pt:sr=2*\EM:vt#3:xn:\
  70     :sc=\E7:rc=\E8:cs=\E[%i%d;%dr:
  71 -----
  72
  73 To build a binary distribution of Emacs for Mac OS X, run the shell
  74 script make-bin-dist in the `mac' directory.  This will create a file
  75 emacs-21.xx.yy-mac-bin.tar.gz.
  76
  77 To install the binary distribution, untar the file and run the shell
  78 script osx-install in its top-level directory.
  79
  80 To build the `info' files, you need to install the texinfo software.
  81
  82 To install from source, obtain texinfo-4.2.tar.gz from ftp.gnu.org or
  83 a mirror.  Un-tar it, enter its directory and type
  84
  85   ./configure
  86   make
  87   make install
  88
  89 The last step needs to be performed as root.
  90
  91 You may also like to install ispell, which will allow you to use
  92 ispell and flyspell-mode.  To install ispell from source, you first
  93 need to install GNU textutils.
  94
  95 To do so, download textutils-2.0.tar.gz from ftp.gnu.org or a mirror.
  96 Un-tar it, enter its directory, type
  97
  98   ./configure --host=powerpc-apple-bsd
  99   make
 100   make install
 101
 102 Again, the last step needs to be performed as root.  Note that if you
 103 run `make check', the test for `pr' will fail.
 104
 105 Get and un-tar ispell-3.2.06.tar.gz.  Look for it here:
 106
 107   http://fmg-www.cs.ucla.edu/geoff/ispell.html
 108
 109 Go into its directory, type
 110
 111   cp local.h.samp local.h
 112
 113 Add a line `#define TERMLIB ""' to the end of local.h.
 114
 115 Set the environment variable TMPDIR to an existing directory.  For
 116 example since `/tmp' exists on my machine and I am using `bash', I
 117 typed
 118
 119   export TMPDIR=/tmp
 120
 121 Run `make' and `make install', the latter as root.
 122
 123
 124 * BUILDING EMACS ON MAC OS 8/9
 125
 126 You can use either Metrowerks CodeWarrior Pro 6 or MPW-GM (Aug. 2001)
 127 to build Emacs.  MPW-GM can be downloaded free of charge from Apple.
 128
 129 In either case, you will need MPW-GM to build the make-docfile utility
 130 and to generate the doc string file DOC.
 131
 132 ### IMPORTANT ### You can use StuffIf Expander to decompress and untar
 133 the distribution.  However, you *must* set the radio button in the
 134 Preferences->Cross Platform->Convert text files to Macintosh format to
 135 "Never".  Otherwise the compiled Lisp files will be corrupted.
 136
 137 (Optional) A subset of the fonts from the GNU intlfonts-1.2
 138 distribution converted to NFNT format can be obtained from
 139
 140   ftp://mac-emacs.sourceforge.net/pub/mac-emacs/GNU-fonts.smi.bin
 141
 142 To build Emacs in the MPW Shell, simply set the directory to
 143 ...:emacs:mac: and build the target Emacs of the make file
 144 makefile.mpw.  I.e., execute the commands
 145
 146   make Emacs -f makefile.MPW > Emacs.MakeScript
 147   Emacs.MakeScript
 148
 149 To build Emacs using CodeWarrior, start up the CodeWarrior IDE, choose
 150 File->Import Project...  and select the file cw6-mcp.xml.  When
 151 prompted to save the project, navigate to same directory as the file
 152 cw6-mcp.xml, name the project emacs-cw6.mcp, and save it there.  Then
 153 choose Project->Make.  Note that this does not build the DOC file.  To
 154 do so, use MPW and build the target "Doc" in makefile.MPW.
 155
 156 Once built, the Emacs application (Emacs CW or Emacs MPW) can be
 157 launched where it is created.
 158
 159 To build an optimized version of Emacs in CodeWarrior, change the
 160 value in the Emacs Settings->Code Generation->Global Optimization
 161 dialog.  To build a version for profiling, check the Profiler
 162 Information box in the Emacs Settings->Code Generation->PPC Processor
 163 dialog and include the Profiler PPC.Lib library.
 164
 165 * NOTES
 166
 167 Emacs should build and run on a PowerMac running Mac OS 8.6 - 10.1.
 168
 169 You will need around 100 MB of disk space for the source files and
 170 intermediate files.
 171
 172 It will not run on machines running Mac OS 8/9 with more than 256 MB
 173 of physical or virtual memory.  It does not have this restriction when
 174 it is run under Mac OS X.  But the usual 128MB buffer limit of a
 175 32-bit Emacs still exists.
 176
 177 Under Mac OS 8/9, there is no support for building the LEIM directory.
 178 However, it can be built on Mac OS X or another platform and
 179 transferred to the Mac.
 180
 181 On Mac OS 8/9, to use the same icon as when Emacs is built on Windows
 182 NT, define GNU_ICON in mac/src/Emacs.r.  Currently Emacs uses a
 183 generic application icon on the Mac OS X.  A better looking one is
 184 coming soon.
 185
 186
 187 Enjoy!
 188
 189 Andrew.
 190 <akochoi@mac.com>