README.macos

   1 $Id$
   2
   3 This file tries to help building Wireshark for Mac OS X (Wireshark does
   4 not work on earlier versions of Mac OS).
   5
   6 You must have the developer tools (called Xcode) installed. Xcode 3 should
   7 be available on the install DVD; Xcode 4 is available for download from
   8 developer.apple.com and, for Lion, from the Mac App Store. See
   9
  10         http://guide.macports.org/chunked/installing.xcode.html
  11
  12 for details.
  13
  14 You must have X11 and the X11 developer headers and libraries installed;
  15 otherwise, you will not be able to build or install GTK+, and will only
  16 be able to build TShark.  The X11 and X11 SDK that come with Mac OS X
  17 releases starting with Panther can be used to build and run Wireshark.
  18
  19 You must also have GLib and, if you want to build Wireshark as well as
  20 TShark, GTK+.  The macosx-setup.sh script can be used to download, patch
  21 as necessary, build, and install those libraries and the libraries on
  22 which they depend; it will, by default, also install other libraries
  23 that can be used by Wireshark and TShark.  The versions of libraries to
  24 download are specified by variables set early in the script; you can
  25 comment out the settings of optional libraries if you don't want them
  26 downloaded and installed.  Before running the macosx-setup.sh script,
  27 and before attempting to build Wireshark, make sure your PKG_CONFIG_PATH
  28 environment variable's setting includes both /usr/X11/lib/pkgconfig
  29 and /usr/local/lib/pkgconfig.
  30
  31 After you have installed those libraries:
  32
  33 If you are building from a Subversion tree, rather than from a source
  34 distribution tarball, run the autogen.sh script.  This should not be
  35 necessary if you're building from a source distribution tarball, unless
  36 you've added new source files to the Wireshark source.
  37
  38 Then run the configure script, and run make to build Wireshark.
  39
  40 If you upgrade the major release of Mac OS X on which you are building
  41 Wireshark, we advise that, before you do any builds after the upgrade,
  42 you do, in the build directory:
  43
  44     If you are building from a release tarball:
  45         make distclean
  46
  47     If you are building from SVN:
  48         make maintainer-clean
  49         ./autogen.sh
  50
  51 Then re-run the configure script and rebuild from scratch.
  52
  53 On Snow Leopard (10.6), if you are building on a machine with a 64-bit
  54 processor (with the exception of the early Intel Core Duo and Intel Core
  55 Solo machines, all Apple machines with Intel processors have 64-bit
  56 processors), the C/C++/Objective-C compiler will build 64-bit by
  57 default.
  58
  59 This means that you will, by default, get a 64-bit version of Wireshark.
  60
  61 One consequence of this is that, if you built and installed any required
  62 or optional libraries for Wireshark on an earlier release of Mac OS X,
  63 those are probably 32-bit versions of the libraries, and you will need
  64 to un-install them and rebuild them on Snow Leopard (10.6), to get 64-bit
  65 versions.
  66
  67 Some required and optional libraries require special attention if you
  68 install them by building from source code on Snow Leopard; the
  69 macosx-setup.sh script will handle that for you.
  70
  71 GLib - the GLib configuration script determines whether the system's
  72 libiconv is GNU iconv or not by checking whether it has libiconv_open(),
  73 and the compile will fail if that test doesn't correctly indicate
  74 whether libiconv is GNU iconv.  In Mac OS X, libiconv is GNU iconv, but
  75 the 64-bit version doesn't have libiconv_open(); a workaround for this
  76 is to replace all occurrences of "libiconv_open" with "iconv_open" in
  77 the configure script before running the script.  The macosx-setup.sh
  78 setup script will patch GLib to work around this.
  79
  80 libgcrypt - the libgcrypt configuration script attempts to determine
  81 which flavor of assembler-language routines to use based on the platform
  82 type determined by standard autoconf code.  That code uses uname to
  83 determine the processor type; however, in Mac OS X, uname always reports
  84 "i386" as the processor type on Intel machines, even Intel machines with
  85 64-bit processors, so it will attempt to assemble the 32-bit x86
  86 assembler-language routines, which will fail.  The workaround for this
  87 is to run the configure script with the --disable-asm argument, so that
  88 the assembler-language routines are not used.  The macosx-setup.sh will
  89 configure libgcrypt with that option.
  90
  91 PortAudio - when compiling on Mac OS X, the configure script for the
  92 pa_stable_v19_20071207 version of PortAudio will cause certain
  93 platform-dependent build environment #defines to be set in the
  94 Makefile rules, and to cause a universal build to be done; those
  95 #defines will be incorrect for all but one of the architectures for
  96 which the build is being done, and that will cause a compile-time error
  97 on Snow Leopard.  Newer versions don't have this problem; the
  98 macosx-setup.sh script downloads a newer version.