]> mj.ucw.cz Git - pciutils.git/blobdiff - README
Added more parts of the Windows port.
[pciutils.git] / README
diff --git a/README b/README
index cedd409e8c2395be04cf62851a9fa77b932b4e3b..44f836a588fdf459249c165157fde57bed343774 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,24 @@
-This package contains the PCI Utilities, version 2.1.9.
+This package contains the PCI Utilities, version @VERSION@.
 
-Copyright (c) 1997--2002 Martin Mares <mj@ucw.cz>
+Copyright (c) 1997--2004 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
-(at your opinion) any newer version. This is the same distribution
-policy as for the Linux kernel itself -- see /usr/src/linux/COPYING
-for details.
+(at your opinion) any newer version. See http://www.gnu.org/ for details.
+
+
+############################################################################
+
+Beware, this is a preliminary test version!  Anything might not work!
+
+Some more things I intend to merge before the 2.2.0 release:
+
+   o  pcimodules and possibly other Linux module related stuff
+   o  New ID's from the pciids project
+   o  Avoid calling show_ext_caps() for non-ext devices.
+
+############################################################################
+
 
 
 1. What's that?
@@ -15,9 +27,10 @@ The PCI Utilities package contains a library for portable access to PCI bus
 configuration registers and several utilities based on this library.
 
 Currently, pciutils work on all versions of Linux and they also have somewhat
-experimental support for FreeBSD and AIX. It should be very easy to add support
-for other systems as well (volunteers wanted; if you want to try that, please
-send the patches to me, so that I can include them in the next version).
+experimental support for FreeBSD, NetBSD, AIX, GNU Hurd and Solaris/x86.
+It should be very easy to add support for other systems as well (volunteers
+wanted; if you want to try that, I'll be very glad to see the patches and
+include them in the next version).
 
 The utilities include:  (See manual pages for more details)
 
@@ -28,6 +41,8 @@ The utilities include:  (See manual pages for more details)
     CAUTION: There is a couple of dangerous points and caveats, please read
     the manual page first!
 
+  - update-pciids: download the current version of the pci.ids file.
+
 
 2. Compiling and (un)installing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -48,23 +63,29 @@ than I release new versions of this package.
 
 If you are missing names for any of your devices or you just want to stay
 on the bleeding edge, download the most recent pci.ids file from
-http://pciids.sf.net/. If your devices still appear as unknown, please
-send us their ID's and names, the detailed instructions for submissions
-are listed on the sf.net web page.
+http://pciids.sf.net/ (e.g., by running the update-ids utility).
+
+If your devices still appear as unknown, please send us their ID's and
+names, the detailed instructions for submissions are listed on the
+sf.net web page.
 
 
 4. Available access methods
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The library (and therefore all the utilities) know a variety of methods for
-accessing the PCI registers. Here is a list of them:
+accessing the PCI registers. Here is a list of them, sorted by autodetection
+priority:
 
    /proc/bus/pci       on all Linux systems since kernel 2.1.82.
-   direct port access  on all Linux systems with i386, to be used when
-                       /proc/bus/pci is unavailable or you want to scan
-                       the bus manually when hunting kernel bugs.
-   dumps               reading of dumps produced by `lspci -x'.
-   lsdev + odmget      used on AIX
+   /sys/bus/pci                on all Linux systems since kernel 2.5.xx.
+   direct port access  on i386 systems running Linux, GNU Hurd or Solaris/x86;
+                       available only to root, useful if no other access
+                       method is available or you want to hunt kernel bugs
    /dev/pci            used on FreeBSD
+   lsdev + odmget      used on AIX
+   libpci              used on NetBSD
+   dumps               reading of dumps produced by `lspci -x'
+                       (this one is not autodetected)
 
 
 5. Using the library
@@ -90,7 +111,7 @@ the Linux PCI support will be probably discussed there, too.
 7. Miscellanea
 ~~~~~~~~~~~~~~
 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 .
+notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.shtml .
 
 There also exists a utility called PowerTweak which is able to fine tune
 parameters of many chipsets much better than the Bridge Optimization code