mac/INSTALL

   1 * BUILDING EMACS ON THE MAC OS     -*- outline -*-
   2
   3 You can use either Metrowerks CodeWarrior Pro 5 or 6 or MPW-GM
   4 (Aug. 2000) to build Emacs.  MPW-GM can be downloaded free of charge
   5 from Apple at
   6
   7   http://developer.apple.com/tools/mpw-tools/
   8
   9 You will need MPW-GM to build the make-docfile utility and to generate
  10 the doc string file DOC.
  11
  12 To decompress files, you can use MacGzip from
  13
  14   http://persephone.cps.unizar.es/~spd/gzip
  15
  16 and to untar them, you can use tar 4.0 from
  17
  18   http://hyperarchive.lcs.mit.edu/HyperArchive/Archive/cmp/tar-40b.hqx
  19
  20 (Optional) If you wish to fetch files from the Emacs CVS repository
  21 directly to your Mac, you can use the CVS client MacCVS, which can be
  22 downloaded from
  23
  24   http://www.wincvs.org/
  25
  26 (Optional) A subset of the fonts from the GNU intlfonts-1.2
  27 distribution converted to NFNT format can be obtained from
  28
  29   ftp://mac-emacs.sourceforge.net/pub/mac-emacs/GNU-fonts.smi.bin
  30
  31 * BUILDING EMACS
  32
  33 To build Emacs in the MPW Shell, simply set the directory to
  34 ...:emacs:mac: and build the target Emacs of the make file
  35 makefile.mpw.  I.e., execute the commands
  36
  37   make Emacs -f makefile.MPW > Emacs.MakeScript
  38   Emacs.MakeScript
  39
  40 To build Emacs using CodeWarrior, start up the CodeWarrior IDE, choose
  41 File->Import Project...  and select the file cw5-mcp.xml or
  42 cw6-mcp.xml, depending on which verison of CodeWarrior used.  When
  43 prompted to save the project, navigate to same directory as the file
  44 cw[56]-mcp.xml, name it emacs-cw5.mcp or emacs-cw6.mcp, and save it
  45 there.  Then choose Project->Make.  Note that this does not build the
  46 DOC file.  To do so, use MPW and build the target "Doc" in
  47 makefile.MPW.
  48
  49 Once built, the Emacs application (Emacs CW or Emacs MPW) can be
  50 launched where it is created.
  51
  52 To build an optimized version of Emacs in CodeWarrior, change the
  53 value in the Emacs Settings->Code Generation->Global Optimization
  54 dialog.  To build a version for profiling, check the Profiler
  55 Information box in the Emacs Settings->Code Generation->PPC Processor
  56 dialog and include the Profiler PPC.Lib library.
  57
  58 To build optimized or debugging version of Emacs in MPW, follow the
  59 comment in makefile.MPW to enable the -opt speed or -sym on option
  60 (see note below).
  61
  62 The Mac version requires compiled Lisp files to be present in the lisp
  63 directory to run properly.  It is cumbersome to bootstrap from only
  64 the Lisp source files.  One way of getting the compiled Lisp files is
  65 to build Emacs once on, say, a Unix system and transfer that directory
  66 to the Mac.  Note that linefeed conversion must be disabled when
  67 transferring compiled Lisp files.
  68
  69 An alternative is to unzip and untar the archive lisp-elc.tgz.  An
  70 older version of frame.elc in the archive may cause a problem when the
  71 Mac version starts up.  If this is the case, simply remove or rename
  72 that file.  Then once Emacs runs, you can invoke
  73 byte-recompile-directory on the lisp directory to byte-compile all
  74 out-of-date Lisp files.
  75
  76 You may also need to run update-autoloads-from-directories on the lisp
  77 directory to bring loaddefs.el up-to-date.
  78
  79 * NOTES
  80
  81 Emacs should build and run on a PowerMac running Mac OS 8.1 - 9.0.
  82
  83 You will need around 100 MB of disk space for the source files and
  84 intermediate files.
  85
  86 It will not run on machines with more than 256 MB of physical or
  87 virtual memory.
  88
  89 Currently there is no support for building the LEIM directory on the
  90 Mac.  However, it can be built on another platform and transferred to
  91 the Mac.
  92
  93 When Emacs is built with "-opt speed" enabled in makefile.MPW,
  94 optimization causes the functions reset_buffer_local_variables in
  95 buffer.c and syms_of_lread in lread.c to crash.  Avoid this by
  96 enclosing them in the following pragmas.
  97
  98   #pragma options opt off
  99
 100   <function definition...>
 101
 102   #pragma options opt reset
 103
 104 To use the same icon as when Emacs is built on Windows NT, define
 105 GNU_ICON in mac/src/Emacs.r.