]> mj.ucw.cz Git - pciutils.git/blobdiff - README
Work-around for Solaris tr.
[pciutils.git] / README
diff --git a/README b/README
index 26bfa58601b45df84caf402a885cf3fc78da9fca..5c67759216d364abe9fb3885184708892d9238b8 100644 (file)
--- a/README
+++ b/README
@@ -1,41 +1,36 @@
 This package contains the PCI Utilities, version @VERSION@.
 
-Copyright (c) 1997--2004 Martin Mares <mj@ucw.cz>
+Copyright (c) 1997--2006 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. 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.
-   o  Kill memory leaks in lib/names.c
-
-############################################################################
-
-
-
 1. What's that?
 ~~~~~~~~~~~~~~~
 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, NetBSD, AIX, GNU Hurd and Solaris/x86.
+In runs on the following systems:
+
+       Linux           (via /sys/bus/pci, /proc/bus/pci or i386 ports)
+       FreeBSD         (via /dev/pci)
+       NetBSD          (via libpci)
+       OpenBSD         (via /dev/pci)
+       GNU/kFreeBSD    (via /dev/pci)
+       Solaris/i386    (direct port access)
+       Aix             (via /dev/pci and odmget)
+       GNU Hurd        (direct port access)
+       Windows         (direct port access)
+
 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)
 
-  - lspci: displays detailed information about all PCI busses and devices.
+  - lspci: displays detailed information about all PCI buses and devices.
 
   - setpci: allows to read from and write to PCI device configuration
     registers. For example, you can adjust the latency timers with it.
@@ -50,9 +45,19 @@ The utilities include:  (See manual pages for more details)
 Just run "make" to compile the package and then "make install" to install it.
 
 If you want to change the default installation location, please override
-the ROOT and PREFIX variables specified in the Makefile -- e.g., you can
-use "make PREFIX=/opt/pciutils ROOT=/opt/pciutils install" to create
-a separate installation not interfering with the rest of your system.
+the PREFIX variable specified in the Makefile -- e.g., you can use
+"make PREFIX=/opt/pciutils install" to create a separate installation
+not interfering with the rest of your system.  Setting the DESTDIR variable
+will allow you to install to a different directory from the one you intend
+to eventually run it from.  This is useful for people who are packaging
+pciutils to install on other computers.
+
+The configure script will automatically enable support for a compressed
+pci.ids if you have zlib installed.  You can override its guess by using
+"make ZLIB=no" or "make ZLIB=yes".  If compressed support is enabled,
+pciutils will use pci.ids.gz in preference to pci.ids, even if the
+pci.ids file is newer.  If the pci.ids.gz file is missing, it will use
+pci.ids instead.
 
 When you are bored of dumping PCI registers, just use "make uninstall".
 
@@ -71,22 +76,17 @@ 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, sorted by autodetection
-priority:
-
-   /proc/bus/pci       on all Linux systems since kernel 2.1.82.
-   /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)
+4. Getting new versions
+~~~~~~~~~~~~~~~~~~~~~~~
+New versions of pciutils are available at the following places:
+
+       ftp://atrey.karlin.mff.cuni.cz/pub/linux/pci/
+       ftp://ftp.kernel.org/pub/software/utils/pciutils/ (expect a couple of hours delay)
+       ftp://metalab.unc.edu/pub/Linux/hardware/ (expect a couple of days delay)
+
+There is also a public GIT tree at:
+
+       git://git.kernel.org/pub/scm/utils/pciutils/pciutils.git
 
 
 5. Using the library