aboutsummaryrefslogtreecommitdiffstats
path: root/README.macos
diff options
context:
space:
mode:
Diffstat (limited to 'README.macos')
-rw-r--r--README.macos64
1 files changed, 48 insertions, 16 deletions
diff --git a/README.macos b/README.macos
index 63acd5111d..2059cfcf27 100644
--- a/README.macos
+++ b/README.macos
@@ -1,3 +1,40 @@
+MacOS Quick Start (Using Homebrew)
+-----------------------------------
+
+> Note that this method is particularly recommended for M1 and later Macs.
+
+1. Install the latest Xcode from the MacOS app store.
+ See https://guide.macports.org/#installing.xcode for details.
+
+2. Install Homebrew (https://brew.sh/)
+
+3. From the top-level source directory, run tools/macos-setup-brew.sh and wait
+ for it to complete.
+
+ Note: You may set the environment variable HOMEBREW_NO_AUTO_UPDATE=1 if you
+ do not want the script to update homebrew.
+
+4. Create a build directory and enter it:
+ mkdir build && cd build
+
+5. Configure the build:
+ cmake ..
+
+6. Build wireshark!
+ make -j
+
+The wireshark binary will be found at run/wireshark under your build directory.
+
+Note that for subsequent builds, you will only need to enter the build
+directory and run "make -j".
+
+Note that if you cannot use homebrew, or otherwise need to manually install
+prerequisites, you cannot use this method; continue reading for more detailed
+instructions.
+
+
+Non-Homebrew Setup and Build of Wireshark for macOS
+----------------------------------------------------
This file tries to help building Wireshark for macOS (The Operating
System Formerly Known As Mac OS X And Then OS X) (Wireshark does not
work on the classic Mac OS).
@@ -14,6 +51,7 @@ for details. For Xcode 4, you will need to install the command-line
tools; select Preferences from the Xcode menu, select Downloads in the
Preferences window, and install Command Line Tools.
+
You must also have GLib and, if you want to build Wireshark as well as
TShark, you must have also Qt installed. You can download precompiled
Qt packages and source code from
@@ -43,18 +81,12 @@ directory.
After you have installed those libraries:
- 1. If you have installed Qt into some non-standard place, as is
- distinctly possible with the build included with
- macos-setup.sh, you must inform cmake by either including its
- "bin" directory as part of the PATH environment variable or
- setting CMAKE_PREFIX_PATH to the directory above Qt's "lib"
- directory. For Qt 5.8 installed into one's home directory,
- for instance:
-
- % export CMAKE_PREFIX_PATH=~/Qt5.8.0/5.8/clang_64
+ 1. It is generally recommended to install Qt with the online installer
+ provided by Qt - see https://www.qt.io/download
- This step is unnecessary if you've used a recent version of
- Homebrew, as the CMake build scripts will find Qt.
+ If you are building on an Apple Silicon machine, it is highly recommended
+ to use at least Qt 6.2.4, as this architecture is not fully supported
+ with Qt 5.15
2. Make a directory in which Wireshark is to be built, separate
from the top-level source directory for Wireshark - it can be a
@@ -75,24 +107,24 @@ directory;
make
It is also possible to use the Xcode IDE to build and debug Wireshark
-using cmake's Xcode generator. Create a separate build directory, as
-described above and run cmake with the "-G Xcode" argument to create
+using cmake's Xcode generator. Create a separate build directory, as
+described above and run cmake with the "-G Xcode" argument to create
a Xcode project file in the current directory.
cmake -G Xcode ..
- 1. Double click Wireshark.xcodeproj
+ 1. Double click Wireshark.xcodeproj
2. Choose to create schemes manually
3. Create a scheme for the ALL_BUILD target
- 4. Edit the scheme, go to the run configuration and select Wireshark.app
+ 4. Edit the scheme, go to the run configuration and select Wireshark.app
as executable
If you upgrade the major release of macOS on which you are building
Wireshark, we advise that, before you do any builds after the upgrade,
-you remove the build directory and all its subdiretories, and repeat the
+you remove the build directory and all its subdirectories, and repeat the
above process, re-running CMake and rebuilding from scratch.
On Snow Leopard (10.6) and later releases, if you are building on a