Documentation updates, small application update (still not doing

anything useful)


git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@100 7894878c-1315-0410-8ee3-d5d059ff63e0

INSTALL

@@ -1,3 +1,10 @@
+Please read this file thoroughly before you try to install and run things. It
+will safe you many headaches. Installation is not really difficult, but there
+are a few pitfalls.
+
+COMPILATION AND INSTALLATION
+============================
+
 Basic installation is uncomplicated. Run 'make all', followed by an optional
 'make install'. Everything is compiled using the Makefile in the root of
 this package. Some interesting variables:
@@ -38,8 +45,8 @@ NOT compatible with this module! Actually, Simon Vogl's modules package
 (which IS compatible) is scheduled to replace the current support. If you
 actually use these modules, you have a problem; they can not coexist
 with Simon's modules. Theoretically, you should be able to replace
-the old modules with the new stuff in our i2c directory, recompile
-the kernel, and then compile our modules with I2C=0. If you try
+the old modules in the kernel tree with the new stuff in our i2c directory,
+recompile the kernel, and then compile our modules with I2C=0. If you try
 this, please share the results with us!
 
 Please make sure that /usr/include/linux and /usr/include/asm are symlinks 
@@ -49,6 +56,10 @@ with). If the tree and the running kernel do not match, you will either
 be unable to insert the modules at all, or you can expect strange 
 behaviour (probably leading to crashes).
 
+
+TESTING AND RUNNING
+===================
+
 When you have compiled this package, you will be left with a lot of modules.
 It can be tricky to know which modules you need to insert. For this reason,
 I suggest you go the 'modprobe' way, as described within doc/modules.
@@ -64,19 +75,39 @@ Now you should have new directories under /proc/sys/dev/sensors and some files
 beginning with i2c in /proc/bus.
 
 If you have installed the modules, as described within doc/modules, you can
-do 'modprobe piix4 && modprobe lm78 && modprobe i2c-proc' (the last is
-optional) from any directory to reach the same situation.
+do 'modprobe isa && modprobe piix4 && modprobe lm78 && modprobe i2c-proc' 
+(the last is optional) from any directory to reach the same situation.
+
+This package also contains a library of functions which can be used to
+access sensor data in a more programmer-friendly way. It will be built as
+both a shared and a static library, and installed in your LIB directory
+(normally /usr/local/lib). It needs a configuration file, which is usually
+called 'sensors.conf', and can be placed in /etc, /usr/lib/sensors,
+/usr/local/lib/sensors, /usr/lib, or /usr/local/lib. [NOTE: No real
+standard config file is written yet. A very simple example can be found in 
+the prog/sensors directory.]
 
 Where version 1 of this package had the human-readable /proc/sensors file,
-this version will include a user-space program which gathers all data
-and displays it in a comparable format. Regrettably, this program is not
-yet finished. To understand the files that are present now, read doc/lm78, 
-doc/lm75 etc.
+this version includes a user-space program which gathers all data
+and displays it in a comparable format. This program is called 'sensors'.
+Everybody can use it to read sensors values; only root can use it to
+set minimum and maximum values [NOTE: not yet implemented]
+
+If you want to run 'sensors' without installing the package, you must
+use the following command to make it able to find its shared library:
+  (bash) export LD_LIBRARY_PATH=/WHEREVER/lm_sensors-2.X.Y/lib:$LD_LIBRARY_PATH
+  (tcsh) setenv LD_LIBRARYPATH /WHEREVER/lm_sensors-2.X.Y/lib:$LD_LIBRARY_PATH
+Replace /WHEREVER/lm_sensors-2.X.Y with the base directory of the package
+source code.
 
 One of the next releases of this package will have a user-space probe program,
 which tells you which chips and busses are present, and which modules you
 will have to load. At this moment, just try to load the modules; if no chip
-or bus is detected, the module will fail to insert.
+or bus is detected, the module will fail to insert. [NOTE: not true for
+the bit-lp.o and bit-elv.o drivers. Don't try them without expecting 
+fake devices]
 
-Please examine the files in the doc subdirectory for more information, or
-try to mail us at <lm78@stimpy.netroedge.com>. Good luck!
+Please examine the files in the doc subdirectory for more information, 
+especially about individual driver. You can always mail us at 
+<lm78@stimpy.netroedge.com>. Alternatively, consider useing the (free)
+support site at http://www.netroedge.com/~lm78/support.html. Good luck!

README

@@ -3,7 +3,6 @@ modules for general SMBus access and hardware monitoring. There are quite
 a few changes compared with 1.x.y versions; read doc/version-2 for the
 most interesting ones.
 
-
 WARNING! This is a BETA release. It is not compatible with any programs
 which are built upon the 1.x.y versions, like wmlm78 or klm. We expect
 version 2 will soon be supported by them, though. As beta release, there
@@ -12,12 +11,16 @@ everything is tested exhaustively, either, often because we simply do
 not have access to the hardware. Please share your experiences, both
 good and bad, regarding this package with us at <lm78@stimpy.netroedge.com>.
 
+WARNING! If you downloaded this package through our CVS archive, you walk
+the cutting edge. Things may not even compile! On the other hand, you will
+be the first to profit from new drivers and other changes. Have fun!
+
 As a rule of thumb: if you have a PIIX4 with LM78/79 and LM75 chips, things
 should run without problem. The GL518 driver is completely untested. All
 supporting modules in the src directory should work without problem. If
 you have a VIA chipset, we would like to hear whether you can access the
-SMBus with it - this is not very well tested either. If you have a Winbond
-chip, use the LM78/LM75 drivers until a specific Winbond driver is written.
+SMBus with it - this is not very well tested either. The new Winbond driver
+should basically work, though not all functionality may be present yet.
 If you have a LM80, you are out of luck at this moment.
 
 We expect many updates and new releases the next few weeks (with both bug

prog/sensors/main.c

@@ -117,7 +117,7 @@ int open_this_config_file(char *filename)
 
 int main (int argc, char *argv[])
 {
-  int c;
+  int c,res;
 
   struct option long_opts[] =  {
     { "help", no_argument, NULL, 'h' },
@@ -148,13 +148,8 @@ int main (int argc, char *argv[])
     }
   }
   open_config_file();
-  exit(0);
-}
 
-
-
-/*
-  if ((res = sensors_init(stdin))) {
+  if ((res = sensors_init(config_file))) {
     if (res == SENSORS_ERR_PROC)
       fprintf(stderr,
               "/proc/sys/dev/sensors/chips or /proc/bus/i2c unreadable:\n"
@@ -163,9 +158,4 @@ int main (int argc, char *argv[])
       fprintf(stderr,"%s\n",sensors_strerror(res));
     exit(1);
   }
-  for (i = 0; i < sensors_proc_bus_count; i++)
-    printf("%d: %s %s\n",sensors_proc_bus[i].number,
-           sensors_proc_bus[i].adapter,sensors_proc_bus[i].algorithm);
 }
-
-*/