]> mj.ucw.cz Git - pciutils.git/blobdiff - README
Fixed the "dist" target.
[pciutils.git] / README
diff --git a/README b/README
index 5c47c7250dd6ab935b41077ce74c17f3fc476d11..02e7e9385d765d287fcb6b19859c8937c882e692 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
-This package contains the Linux PCI Utilities, version 1.0.
+This package contains the PCI Utilities, version 2.1.9.
 
-Copyright (c) 1998 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
+Copyright (c) 1997--2001 Martin Mares <mj@ucw.cz>
 
 All files in this package can be freely distributed and used according
 to the terms of the GNU General Public License, either version 2 or
@@ -8,27 +8,50 @@ to the terms of the GNU General Public License, either version 2 or
 policy as for the Linux kernel itself -- see /usr/src/linux/COPYING
 for details.
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-   The Linux PCI Utilities currently contain only one utility -- lspci,
-indented for displaying of detailed information about all PCI busses and
-devices in the system, replacing the original /proc/pci interface. See
-the manual page (lspci.8) for more details.
+   The PCI Utilities package contains a library for portable access to PCI bus
+configuration space and several utilities based on this library. Current
+version works only on Linux and also has an experimental support for FreeBSD,
+but it can be easily extended to work on other systems as well.
+
+   The utilities include:  (See manual pages for more details)
+
+       - lspci: displays detailed information about all PCI busses and devices
+         in the system, replacing the original /proc/pci interface.
+
+       - setpci: allows to read from and write to PCI device configuration
+         registers. For example, you can adjust the latency timers with it.
+
+   The library (and therefore all the utilities) can access PCI registers
+either via the /proc/bus/pci interface present since Linux 2.1.82 or
+via direct hardware access (to be used with older kernels and also for
+hardware diagnostics). It's also capable of reading and interpreting
+register dumps printed by `lspci -x'. Unfortunately, there is no documentation
+on how to use the library yet, so if you want to play with it, just ask
+me for whatever you want.
+
+   To compile the package, just run "make". To install it, "make install".
 
    If you have any bug reports or suggestions, send them to the author.
 
    If you want, subscribe to linux-pci@atrey.karlin.mff.cuni.cz (send
-"subscribe linux-pci Your Full Name" to listproc@atrey.karlin.mff.cuni.cz).
+"subscribe linux-pci" to majordomo@atrey.karlin.mff.cuni.cz).
 Release notes about new versions will be send to the list and problems with
 the Linux PCI support will be probably discussed there, too.
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-TODO:
+   You also might want to look at the pciutils web page containing release
+notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.html .
 
-       - Work-around the PIIX4 ACPI crash?
+   If you're missing any PCI ID's, please look at the home page of the Linux
+PCI ID Repository at http://pciids.sourceforge.net/ and download an updated
+pci.ids file first. If the current version doesn't contain your devices,
+please send us an update either using the Web interface of the Repository
+or just mail a unified diff against the latest pci.ids to pci-ids@ucw.cz.
 
-       - Better displaying of IRQ's generated by both PCI and CardBus bridges.
+   There also exists a utility called PowerTweak which is able to fine tune
+parameters of many chipsets much better than the Bridge Optimization code
+in Linux kernel (already removed in 2.3.x). See http://powertweak.sf.net/
+for more information.
 
-       - Full displaying of CardBus bridge configuration. (Has anyone seen
-         full specs of the CardBus bridge / header type 2?)
+                                       Have fun
+                                                       Martin