Add Windows version info resource.
[obnox/wireshark/wip.git] / README.bsd
1 $Id$
2
3 Installing Wireshark on FreeBSD/OpenBSD/NetBSD
4 ========================================================================
5
6      1. Extra packages required
7      2. Compiling Wireshark 
8      3. Berkeley Packet Filter (BPF) requirement
9      4. Running Wireshark as a non-root user
10
11
12 1. Extra packages required
13 ---------------------------
14 Wireshark requires a number of additional programs to function.
15 Install the latest versions of the following programs before compiling:
16
17     atk
18     cairo
19     expat
20     gettext
21     glib2
22     glitz
23     gtk2 / gtk+2
24     jpeg
25     libiconv
26     pango
27     pkgconfig
28     png
29     tiff
30
31 The easiest way to install these is by using your operating system's
32 ports or packages system.
33
34
35 2. Compiling Wireshark
36 -----------------------
37 To compile Wireshark with the default options, run configure, make and
38 make install:
39
40      ./configure
41      make
42      make install
43
44 The configure and make steps can be run as a non-root user and you can
45 run Wireshark from the compilation directory itself.  You must run make
46 install as root in order to copy the program to the proper directories.
47
48
49 3. Berkeley Packet Filter (BPF) requirement
50 --------------------------------------------
51 In order to capture packets (with Wireshark/TShark, tcpdump, or any
52 other packet capture program) on a BSD system, your kernel must have the
53 Berkeley Packet Filter mechanism enabled.  The default kernel
54 configurations in recent versions of BSD systems have this enabled
55 already.  To verify the bpf device is present, look in the /dev
56 directory:
57
58     ls -l /dev/bpf*
59
60 You should see one or more bpf devices listed similar to this:
61
62     crw-------  1 root  wheel    0,  90 Aug 10 21:05 /dev/bpf0
63     crw-------  1 root  wheel    0,  91 Aug 10 21:05 /dev/bpf1
64
65 Packet-capturing programs will pick the first bpf device that's not in
66 use.  Recent versions of most BSDs will create bpf devices as needed, so
67 you don't have to configure the number of devices that will be
68 available.
69
70 4. Running wireshark as a non-root user
71 -------------------------------------------
72 Since the bpf devices are read-only by the owner (root), you normally
73 have to run packet capturing programs such as Wireshark as root.  It is
74 safer to run programs as a non-root user if possible.  To run Wireshark
75 as a non-root user, you must change the permissions on the bpf device(s).
76 If you are the only user that needs to use Wireshark, the easiest way
77 is to change the owner of each bpf device to your username.  You can also
78 add the read/write ability to the group (typically wheel) and add users
79 that need to use Wireshark to the wheel group.  Check your operating
80 system's documentation on how to make permanent these changes as they
81 are often reset upon reboot; if /dev is implemented with devfs, it might
82 be possible to configure devfs to create all bpf devices owned by a
83 particular user and/or group and with particular permissions.