summaryrefslogtreecommitdiff
path: root/README
blob: 06c4534305d52c85787dca17e3cf7e0ff94889af (plain)
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

	System Utilities Package - Includes Libsysfs(v. 0.2.0)
	======================================================

Contents
--------
 1. Introduction
 2. How to Install
 3. Licenses
 4. Reporting Bugs


1. Introduction
---------------

This package's purpose is to provide a set of utilities for interfacing
with sysfs, a virtual filesystem in Linux kernel versions 2.5+ that
provides a tree of system devices. While a filesystem is a very useful
interface, we've decided to provide a stable programming interface
that will hopefully make it easier for applications to query system devices
and their attributes.

This package currently includes:

- libsysfs: a library for accessing system devices.
- lsbus: a small application to query system bus information.
- systool: an application to view system device information by bus, class,
	and topology.
- A number of example usage routines in the "test" directory.
- A comprehensive testsuite, also shipped as part of the "test" directory. This
	testsuite can be used to test _all_ the APIs exported by Libsysfs. 
	Please refer the libsysfs.txt file in the "docs" directory for 
	details as to how to use the testsuite.


2. How to Install
-----------------

Run the "configure" script to generate Makefiles. Use "make" to build the
library and utilities. Use "make install" to install the binaries and the
header files. "make uninstall" will delete all installed binaries and
header files.

The header files are installed in /usr/include/sysfs by default. In case
a different path is desired, specify "includedir=xxx" while running configure
as in

./configure --includedir="path for header installs"


3. Licenses
-----------

The commands are licensed under the GNU Public License (GPL) Version2,
June 1991. The full text of the GPL is located in this package's "cmd"
directory:

sysfsutils/cmd/GPL

The library is licensed under the GNU Lesser Public License (LGPL) 
Version 2.1, February 1999. The full text of the LGPL is located in
this package's "lib" directory:

sysfsutils/lib/LGPL


4. Reporting Bugs
-----------------

Please direct all bugs to either the linux-diag mailing list - 
linux-diag-devel@lists.sourceforge.net - or to the authors:

Ananth Mavinakayanahalli <ananth@in.ibm.com>
Daniel Stekloff <dsteklof@us.ibm.com>