If we don't have any of the pcap_datalink_XXX_to_YYY routines,
[obnox/wireshark/wip.git] / 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 In order to build Wireshark, you must have X11 and the X11 developer
7 headers and libraries installed; otherwise, you will not be able to
8 build or install GTK+, and will only be able to build TShark.  The X11
9 and X11 SDK that come with Mac OS X Panther and Tiger are sufficient to
10 build and run Wireshark.
11
12 The changes to enable libwiretap and libwireshark being built as shared
13 libraries have broken shared gtk1 builds on Mac OS X.  The GLib 1.x and
14 GTK+ 1.x release tarballs were built with an older version of libtool
15 that didn't support shared libraries on Mac OS X, so you can't build and
16 install them as shared libraries, but the shared-library build of
17 Wireshark requires GLib and GTK+, on Mac OS X, to be shared libraries. 
18 The alternative to build Wireshark as one big statically linked binary
19 isn't working either (and may never have worked on this OS).
20
21 The way out of this situation is to use gtk2 and associated libraries
22 which is known to work in this constellation:
23
24         GLib 2.4.0
25         Pango 1.4.0
26         GTK+ 2.4.0
27         ATK 1.6.0
28
29 and the corresponding dependency, which you can download from the
30 "dependencies" subdirectory of the GTK+ download directory on the GTK+
31 FTP site:
32
33         pkg-config
34
35 as well as GNU gettext, which isn't included in the directory of
36 dependencies on the GTK+ FTP site.
37
38 GTK+ can also be configured to include code to load various sorts of
39 images.  To do so, you would also need the following dependencies, also
40 available from the "dependencies" subdirectory of the GTK+ download
41 directory:
42
43         jpegsrc
44         libpng
45         tiff
46
47 However, on Tiger, it appears that the libraries built and installed by
48 those packages collide with libraries that come with the OS, so you
49 might have to configure GTK+ not to support loading those images
50 (Wireshark doesn't use the ability to load JPEG, PNG, or TIFF images), by
51 using the "--without-libpng", "--without-libjpeg", and
52 "---without-libtiff" flags when running "configure" in the GTK+ source
53 directory.
54
55 NOTE: you must set the PKG_CONFIG_PATH environment variable to include
56 "/usr/X11R6/lib/pkgconfig" (unless you've already set it, set it to
57 "/usr/X11R6/lib/pkgconfig") before running the Pango configuration
58 script, so that it can be configured to use the version of fontconfig
59 that comes with Mac OS X's X11. This is also needed for the GTK+
60 configuration.
61
62 NOTE: you must install the pkg-config dependency first; unless it is
63 installed, you cannot configure GLib or GTK+.  After that, you must
64 install GNU gettext; only after both of those have been built and
65 installed will you be able to configure GLib.  After configuring and
66 installing GLib, configure, build, and install Pango, ATK, jpegsrc,
67 libpng, tiff, and GTK+, in order.  (The exact order might not be
68 important, but you must configure, build, and install Pango and ATK
69 before configuring GTK+ and, if you want GTK+ to be able to use the
70 capabilities from the other libraries, you must configure, build, and
71 install them before configuring GTK+.)
72
73 You will need to do "make install-lib" for the JPEG library to install
74 its libraries - "make install" does not suffice.  You will also have to
75 do "sudo ranlib /usr/local/lib/libjpeg.a" after "make install-lib".
76
77 For libpng, use scripts/makefile.darwin, not scripts/makefile.macosx.
78
79 Finally run the configure script. By default it will use
80 the Glib2 and GTK+2 libraries. If you run Wireshark's configure script
81 with the "--disable-gtk2" argument it'll try to configure with GLib
82 1.2[.x] and GTK+ 1.2[.x], in which case:
83
84         if they're not installed, the configure script will fail;
85
86         if they are installed, the configure script will configure
87         Wireshark to build with them.