-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.in
94 lines (61 loc) · 2.5 KB
/
README.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
General Information
===================
This is libusb version @LIBUSB_VERSION@. libusb is a library which allows
userspace application access to USB devices.
The official ftp site is:
ftp://ftp.libusb.sourceforge.net/pub/libusb/
The official web site is:
http://libusb.sourceforge.net/
A mailing list is located at:
Installation
============
See the file 'INSTALL'
How to report bugs
==================
To report a bug, visit http://www.sourceforge.net/projects/libusb/ and fill
out a bug report form.
Please make sure to include:
* The version of libusb
* Information about your system. For instance:
- What operating system and version
- For Linux, what version of the C library
And anything else you think is relevant.
* How to reproduce the bug.
If you can reproduce it with the testlibusb program that is built
in the libusb/ directory, that will be most convenient. Otherwise,
please include a short test program that exhibits the behavior.
As a last resort, you can also provide a pointer to a larger piece
of software that can be downloaded.
* If the bug was a crash, the exact text that was printed out
when the crash occured.
* Further information such as stack traces may be useful, but
is not necessary.
Patches
=======
Patches can be sent to [email protected].
If the patch fixes a bug, it is usually a good idea to include
all the information described in "How to Report Bugs".
Building
========
It should be as simple as running these two commands:
./configure
make
One common problem is building the SGML documentation. On some systems,
like SuSE, you will need to set the SGML_CATALOG_FILES environment
variable to something similar to this (actual paths may vary):
export SGML_CATALOG_FILES="/usr/share/sgml/CATALOG.docbook_3:/usr/share/sgml/CATALOG.docbook-dsssl-stylesheets:/usr/share/sgml/openjade/catalog"
On recent versions of Fedora Core (FC5 Test 2 atleast), this command may be
needed:
export SGML_CATALOG_FILES="/etc/sgml/catalog"
or possibly:
export SGML_CATALOG_FILES="/etc/sgml/docbook"
C++ Support
===========
There are reasonable unit tests available - run "make check" to do the
tests. Note that some of the tests will unexpectedly pass if you don't have
a specfic type of Logitech mouse connected, and some are expected to fail
unless you are running as root (or otherwise have permissions to access the
device).
Building the C++ documentation requires Doxygen
(http://www.stack.nl/~dimitri/doxygen/)