Skip to content

Commit 01619a7

Browse files
wcooleywcooley
committed
Moved pre-reqs to INSTALL from README
1 parent 5ba1afb commit 01619a7

File tree

2 files changed

+78
-72
lines changed

2 files changed

+78
-72
lines changed

‎INSTALL

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
===================
2+
System Requirements
3+
===================
4+
5+
The USB REVue toolset was developed and tested under Ubuntu 10.04 and 11.04.
6+
Some aspects work in 10.04 and some are known to not work. For other distros,
7+
YMMV, depending on whether the minimum requirements are met.
8+
9+
* tcpdump (corresponding with libpcap)
10+
- Needed only for capture
11+
* libpcap 1.1.0 (1.0.0 is known to not work)
12+
- 1.0.0 uses the read(2) interface to usbmon, which does not result in
13+
a complete capture; 1.1.0 uses the mmap(2) interface.
14+
- Needed by most tools
15+
- Ubuntu 11.04: libpcap0.8 (yes, this really is version 1.1.1)
16+
- Fedora 14: libpcap (1.1.1)
17+
* usbmon (Linux kernel)
18+
- Needed only for packet capture
19+
- Ubuntu 10.04 and later (possibly earlier): Included; needs setup
20+
- Fedora 14 and later (possibly earlier): Included; needs setup
21+
- See 'Setup usbmon' below
22+
* Python Modules:
23+
* python-pcapy
24+
- Needed by most tools
25+
- Ubuntu 10.04 and later: python-pcapy
26+
- Fedora 14: pcapy
27+
* python-qt4
28+
- Needed by usbgraph.py, usbstatisfier.py, usbview.py
29+
- Ubuntu 10.04 and later: python-qt4
30+
- Fedora 14: PyQt4
31+
* python-gflags
32+
- Needed by usbmodify.py, usbstatisfier.py
33+
- Ubuntu 11.04: python-gflags
34+
- Fedora 14: python-gflags
35+
* Qwt5
36+
- Needed only by usbgraph.py
37+
- Ubuntu 10.04 and later: python-qwt5-qt4
38+
- Fedora 14: PyQwt
39+
* pyusb 1.0.0
40+
- Needed only by usbreplay.py
41+
- Source: http://sourceforge.net/projects/pyusb/
42+
- Ubuntu 11.04: Not currently packaged
43+
- Fedora 14: Not currently packaged
44+
45+
In addition, for usbreplay, ensure that pyusb-1.0.0 is inserted into the
46+
python tree. For example, on some linux systems, a good location would be:
47+
/usr/lib/python2.7. Pyusb, for example, allows imports of usb.core and
48+
usb.util.
49+
50+
------------
51+
Setup usbmon
52+
------------
53+
54+
'usbmon' is a Linux-kernel USB tracing facility which is suppored by recent
55+
versions of libpcap as a packet-source. Many modern Linux distributions, such
56+
as Fedora and Ubuntu, ship with usbmon enabled. Setting it up for use, however,
57+
varies: 'debugfs' must be mounted; if 'usbmon' is built as a module, the module
58+
must be loaded.
59+
60+
* Ubuntu:
61+
* Module: Must be loaded
62+
* Debugfs: Mounted by default.
63+
* Fedora:
64+
* Module: Compiled in; no module to be loaded.
65+
* Debugfs: Not mounted by default.
66+
67+
* Loading module:
68+
sudo modprobe usbmon
69+
* Mounting debugfs:
70+
sudo mount -t debugfs none /sys/kernel/debug
71+
72+
======================
73+
Installing From Source
74+
======================
75+
76+
Typical Python `distutils` install:
77+
78+
sudo python setup.py install

‎README

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,3 @@
1-
2-
===================
3-
System Requirements
4-
===================
5-
6-
The USB REVue toolset was developed and tested under Ubuntu 10.04 and 11.04.
7-
Some aspects work in 10.04 and some are known to not work. For other distros,
8-
YMMV, depending on whether the minimum requirements are met.
9-
10-
* tcpdump (corresponding with libpcap)
11-
- Needed only for capture
12-
* libpcap 1.1.0 (1.0.0 is known to not work)
13-
- 1.0.0 uses the read(2) interface to usbmon, which does not result in
14-
a complete capture; 1.1.0 uses the mmap(2) interface.
15-
- Needed by most tools
16-
- Ubuntu 11.04: libpcap0.8 (yes, this really is version 1.1.1)
17-
- Fedora 14: libpcap (1.1.1)
18-
* usbmon (Linux kernel)
19-
- Needed only for packet capture
20-
- Ubuntu 10.04 and later (possibly earlier): Included; needs setup
21-
- Fedora 14 and later (possibly earlier): Included; needs setup
22-
- See 'Setup usbmon' below
23-
* Python Modules:
24-
* python-pcapy
25-
- Needed by most tools
26-
- Ubuntu 10.04 and later: python-pcapy
27-
- Fedora 14: pcapy
28-
* python-qt4
29-
- Needed by usbgraph.py, usbstatisfier.py, usbview.py
30-
- Ubuntu 10.04 and later: python-qt4
31-
- Fedora 14: PyQt4
32-
* python-gflags
33-
- Needed by usbmodify.py, usbstatisfier.py
34-
- Ubuntu 11.04: python-gflags
35-
- Fedora 14: python-gflags
36-
* Qwt5
37-
- Needed only by usbgraph.py
38-
- Ubuntu 10.04 and later: python-qwt5-qt4
39-
- Fedora 14: PyQwt
40-
* pyusb 1.0.0
41-
- Needed only by usbreplay.py
42-
- Source: http://sourceforge.net/projects/pyusb/
43-
- Ubuntu 11.04: Not currently packaged
44-
- Fedora 14: Not currently packaged
45-
46-
In addition, for usbreplay, ensure that pyusb-1.0.0 is inserted into the
47-
python tree. For example, on some linux systems, a good location would be:
48-
/usr/lib/python2.7. Pyusb, for example, allows imports of usb.core and
49-
usb.util.
50-
51-
------------
52-
Setup usbmon
53-
------------
54-
55-
'usbmon' is a Linux-kernel USB tracing facility which is suppored by recent
56-
versions of libpcap as a packet-source. Many modern Linux distributions, such
57-
as Fedora and Ubuntu, ship with usbmon enabled. Setting it up for use, however,
58-
varies: 'debugfs' must be mounted; if 'usbmon' is built as a module, the module
59-
must be loaded.
60-
61-
* Ubuntu:
62-
* Module: Must be loaded
63-
* Debugfs: Mounted by default.
64-
* Fedora:
65-
* Module: Compiled in; no module to be loaded.
66-
* Debugfs: Not mounted by default.
67-
68-
* Loading module:
69-
sudo modprobe usbmon
70-
* Mounting debugfs:
71-
sudo mount -t debugfs none /sys/kernel/debug
72-
731
======
742
Viewer
753
======

0 commit comments

Comments
 (0)