Update README.bsd, mainly to put just the primary dependencies that
[metze/wireshark/wip.git] / README.bsd
1 Installing Wireshark on FreeBSD/OpenBSD/NetBSD/DragonFly BSD
2 ========================================================================
3
4      1. Extra packages required
5      2. Compiling Wireshark 
6      3. Berkeley Packet Filter (BPF) requirement
7      4. Running Wireshark as a non-root user
8
9
10 1. Extra packages required
11 ---------------------------
12 Wireshark requires a number of additional programs to function.
13 Install the latest versions of the following programs before compiling:
14
15     glib (version 2.16.0 or later)
16     gtk2 (version 2.12.0 or later) or gtk3 or Qt
17     pkgconfig
18     python (version 2.x or 3.x)
19
20 (These programs may require additional dependencies)
21
22 Additional programs can be used to enhance Wireshark's functionality.
23 These can be found by typing ./configure --help or looking at the output
24 at the end of running the configure script.
25
26 The easiest way to install these is by using your operating system's
27 ports or packages system.
28
29
30 2. Compiling Wireshark
31 -----------------------
32 To compile Wireshark with the default options, run configure, make and
33 make install (you may have to run "autogen.sh" first):
34
35      ./configure
36      make
37      make install
38
39 The configure and make steps can be run as a non-root user and you can
40 run Wireshark from the compilation directory itself.  You must run make
41 install as root in order to copy the program to the proper directories.
42
43
44 3. Berkeley Packet Filter (BPF) requirement
45 --------------------------------------------
46 In order to capture packets (with Wireshark/TShark, tcpdump, or any
47 other packet capture program) on a BSD system, your kernel must have the
48 Berkeley Packet Filter mechanism enabled.  The default kernel
49 configurations in recent versions of BSD systems have this enabled
50 already.  To verify the bpf device is present, look in the /dev
51 directory:
52
53     ls -l /dev/bpf*
54
55 You should see one or more bpf devices listed similar to this:
56
57     crw-------  1 root  wheel    0,  90 Aug 10 21:05 /dev/bpf0
58     crw-------  1 root  wheel    0,  91 Aug 10 21:05 /dev/bpf1
59
60 Packet-capturing programs will pick the first bpf device that's not in
61 use.  Recent versions of most BSDs will create bpf devices as needed, so
62 you don't have to configure the number of devices that will be
63 available.
64
65 4. Running wireshark as a non-root user
66 -------------------------------------------
67 Since the bpf devices are read-only by the owner (root), you normally
68 have to run packet capturing programs such as Wireshark as root.  It is
69 safer to run programs as a non-root user if possible.  To run Wireshark
70 as a non-root user, you must change the permissions on the bpf device(s).
71 If you are the only user that needs to use Wireshark, the easiest way
72 is to change the owner of each bpf device to your username.  You can also
73 add the read/write ability to the group (typically wheel) and add users
74 that need to use Wireshark to the wheel group.  Check your operating
75 system's documentation on how to make permanent these changes as they
76 are often reset upon reboot; if /dev is implemented with devfs, it might
77 be possible to configure devfs to create all bpf devices owned by a
78 particular user and/or group and with particular permissions.  In
79 FreeBSD 6.0 and later this can be done by creating an /etc/devfs.rules
80 file with content such as
81
82         [localrules=10]
83         add path 'bpf*' {mode and permissions}
84
85 where "mode and permissions" can include clauses such as
86
87         mode {octal permissions}
88
89 to set the permissions on the device (e.g., "mode 0660" to set the
90 permissions to rw-rw-r--),
91
92         user {user}
93
94 to set the user who owns the device, or
95
96         group {group}
97
98 to set the group that owns the device and adding a line such as
99
100         devfs_system_ruleset=localrules
101
102 to /etc/rc.conf.  For example, an /etc/devfs.rules file with
103
104         [localrules=10]
105         add path 'bpf*' mode 0660 group wheel
106
107 will grant read and write permissions on all BPF devices to all users in
108 the "wheel" group.