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