summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorstekloff <stekloff>2005-04-06 20:57:01 +0000
committerstekloff <stekloff>2005-04-06 20:57:01 +0000
commitdd8c511d725f816bc64592028ff178616fcde607 (patch)
tree55250e02ac67ceeb3c2bac3b1e29a78c22be1ac2 /README
parent855a337e54321d9aa2b97c38ffa4787d3105257c (diff)
downloadsysfsutils-master.tar.gz
Merging tag sysfsutils-1_3_0 with main trunk.HEADoriginmaster
Diffstat (limited to 'README')
-rw-r--r--README44
1 files changed, 35 insertions, 9 deletions
diff --git a/README b/README
index 1572053..fa71a87 100644
--- a/README
+++ b/README
@@ -1,11 +1,12 @@
- System Utilities Package - Includes Libsysfs(v. 0.1.1)
+ System Utilities Package - Includes Libsysfs(v. 1.2.0)
======================================================
Contents
--------
1. Introduction
2. How to Install
+ 2.1 Caveats/Known issues
3. Licenses
4. Reporting Bugs
@@ -23,38 +24,63 @@ 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
-----------------
-Use make to create the library and the commands.
+Run the "configure" script to generate Makefiles. Use "make" to build the
+library and utilities.
+
+For a successful install, run "make install" as super-user. "make uninstall"
+will clean up all installed files.
+
+
+2.1 Caveats/Known issues
+------------------------
+
+The header files (libsysfs.h and dlist.h) are installed in /usr/include/sysfs
+by default. This _cannot_ be changed by using the --prefix or --includedir
+parameters while running the "configure" script.
+
+As a consequence, when a non-root user runs the "configure" script with these
+options and builds the package, and tries to install it, "make install" will
+return an error since the non-root user will not have "write" permission to
+/usr/include/sysfs to install the headers.
+
+However, the library and binaries will be installed at the requested location.
+The header files will have to be manually copied over by the user to the
+desired directory.
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:
+The commands and tests 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:
-sysutils/cmd/GPL
+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:
-sysutils/lib/LGPL
+sysfsutils/lib/LGPL
4. Reporting Bugs
-----------------
Please direct all bugs to either the linux-diag mailing list -
-linux-diag@lists.sourceforge.net - or to the authors:
+linux-diag-devel@lists.sourceforge.net - or to the authors:
Ananth Mavinakayanahalli <ananth@in.ibm.com>
Daniel Stekloff <dsteklof@us.ibm.com>