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