root/i2c-tools/trunk/README @ 6171

Revision 6055, 3.0 KB (checked in by khali, 2 years ago)

Add a copy of the LGPL v2.1, and clarify licenses.

Line 
1I2C TOOLS FOR LINUX
2===================
3
4This package contains an heterogeneous set of I2C tools for the Linux kernel
5as well as an I2C library. The tools were originally part of the lm-sensors
6project but were finally split into their own package for convenience. The
7library is used by some of the tools, but can also be used by third-party
8applications. The tools and library compile, run and have been tested on
9GNU/Linux.
10
11The latest version of the code can be downloaded from:
12  http://www.lm-sensors.org/wiki/I2CTools
13
14
15CONTENTS
16--------
17
18The various tools included in this package are grouped by category, each
19category has its own sub-directory:
20
21* eeprom
22  Perl scripts for decoding different types of EEPROMs (SPD, EDID...) These
23  scripts rely on the "eeprom" kernel driver. They are installed by default.
24
25* eepromer
26  Tools for writing to EEPROMs. These tools rely on the "i2c-dev" kernel
27  driver. They are not installed by default.
28
29* include
30  C/C++ header files for I2C and SMBus access over i2c-dev. Installed by
31  default.
32
33* lib
34  The I2C library, used by eepromer, py-smbus and tools. Installed by
35  default.
36
37* py-smbus
38  Python wrapper for SMBus access over i2c-dev. Not installed by default.
39
40* stub
41  A helper script to use with the i2c-stub kernel driver. Installed by
42  default.
43
44* tools
45  I2C device detection and register dump tools. These tools rely on the
46  "i2c-dev" kernel driver. They are installed by default.
47
48
49LICENSE
50-------
51
52Check the documentation of individual tools for licensing information.
53The library is released under the LGPL version 2.1 or later, while most
54tools are released under the GPL version 2 or later, but there are a few
55exceptions.
56
57
58INSTALLATION
59------------
60
61There's no configure script, so simply run "make" to build the library and
62tools, and "make install" to install them. You also can use "make uninstall"
63to remove all the files you installed. By default, files are installed in
64/usr/local but you can change the location by editing the Makefile file and
65setting prefix to wherever you want. You may change the C compiler and the
66compilation flags as well, and also decide whether to build the static
67library or not.
68
69Optionally, you can run "make strip" prior to "make install" if you want
70smaller binaries. However, be aware that this will prevent any further
71attempt to debug the library and tools.
72
73If you wish to include sub-directories that are not enabled by default, then
74just set them via the EXTRA make variable. For example, to build py-smbus,
75do:
76  $ make EXTRA="py-smbus"
77
78
79DOCUMENTATION
80-------------
81
82The main tools have manual pages, which are installed by "make install".
83See these manual pages for command line interface details and tool specific
84information.
85
86The other tools come with simple text documentation, which isn't installed.
87
88
89QUESTIONS AND BUG REPORTS
90-------------------------
91
92Please post your questions and bug reports to the linux-i2c mailing list:
93  linux-i2c@vger.kernel.org
94For additional information about this list, see:
95  http://vger.kernel.org/vger-lists.html#linux-i2c
Note: See TracBrowser for help on using the browser.