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