packaging/macosx/Wireshark_read_me_first.adoc

   1 // Required attributes:
   2 // css_dir
   3 // min-macos-version
   4
   5 include::{css_dir}/attributes.adoc[]
   6 :stylesheet: {css_dir}/ws.css
   7
   8 == Before You Begin
   9
  10 This release of Wireshark requires macOS {min-macos-version} or later.
  11 If you are running an earlier version of macOS you can install using another packaging system such as Homebrew or MacPorts.
  12
  13 == Quick Setup
  14
  15 To install Wireshark, drag the _Wireshark_ application bundle to the _Applications_ folder.
  16
  17 In order to be able to capture packets, install the
  18 link:Wireshark.app/Contents/Resources/Extras/Install%20ChmodBPF.pkg[Install ChmodBPF]
  19 package.
  20
  21 If you would like to add the path to
  22 https://www.wireshark.org/docs/man-pages/wireshark.html[Wireshark],
  23 https://www.wireshark.org/docs/man-pages/tshark.html[TShark],
  24 https://www.wireshark.org/docs/man-pages/capinfos.html[capinfos],
  25 https://www.wireshark.org/docs/man-pages/editcap.html[editcap],
  26 and
  27 https://www.wireshark.org/docs/man-pages/[other command line utilities]
  28 to the system PATH, install the
  29 link:Wireshark.app/Contents/Resources/Extras/Add%20Wireshark%20to%20the%20system%20path.pkg[Add Wireshark to the system path]
  30 package.
  31
  32 == Package Installation Details
  33
  34 The ChmodBPF installer writes to the following locations:
  35
  36 * _/Library/LaunchDaemons/org.wireshark.ChmodBPF.plist_. A launch daemon that adjusts permissions on the system's packet capture devices (/dev/bpf*) when the system starts up.
  37 * _/Library/Application Support/Wireshark/ChmodBPF_. A copy of the launch daemon property list, and the script that the launch daemon runs.
  38
  39 The installer group named “access_bpf” is created. The user who opened the package is added to the group.
  40
  41 The system path installer writes to the following locations:
  42
  43 * _/etc/paths.d/Wireshark_. The folder name in this file is automatically added to PATH
  44 * _/etc/manpaths.d/Wireshark_. The folder name in this file is used by the man command.
  45
  46 It assumes that Wireshark is installed in _/Applications_.
  47
  48 == Uninstalling
  49
  50 To uninstall Wireshark, do the following:
  51
  52 . Remove _/Applications/Wireshark.app_
  53 . Remove _/Library/Application Support/Wireshark_
  54
  55 You can uninstall ChmodBPF via the
  56 link:Wireshark.app/Contents/Resources/Extras/Uninstall%20ChmodBPF.pkg[Uninstall ChmodBPF]
  57 package, which is available on this disk or via menu:Wireshark[About Wireshark,Folders,macOS Extras].
  58 You can also uninstall it manually by doing the following:
  59
  60 . Unload the “org.wireshark.ChmodBPF.plist” launchd job
  61 . Remove _/Library/LaunchDaemons/org.wireshark.ChmodBPF.plist_
  62 . Remove the “access_bpf” group.
  63
  64 You can uninstall the system path components via the
  65 link:Wireshark.app/Contents/Resources/Extras/Remove%20Wireshark%20from%20the%20system%20path.pkg[Remove Wireshark from the system path]
  66 package, which is available on this disk or via menu:Wireshark[About Wireshark,Folders,macOS Extras].
  67 You can also uninstall it manually by doing the following:
  68
  69 . Remove _/etc/paths.d/Wireshark_
  70 . Remove _/etc/manpaths.d/Wireshark_