/**
 * patSysinfo - retrieve lots of information about your server's system status.
 *
 * With patSysinfo you get a lot of data with only a few PHP-statements. Et 
 * voila, you get a lot of data your code can deal with it.
 *
 * $Id: install.txt,v 1.2 2004/02/26 00:18:21 gerd Exp $
 *
 * @access		public
 * @package		patSysinfo
 * @todo		pear-installer
 */

patError Installation
=====================
This is a very short document that tries to help you setting up patSysinfo for basic
usage. Please read the readme.txt for further information.

REQUIREMENTS:
=============
patSysinfo uses patError! patError is also available from http://www.php-tools.net

Furthermore, there are several requirements depending on the platform patSysinfo should run on:

Windows
-------
Some of the basic features of patSysinfo use the programme "systeminfo.exe" which belongs to the 
Windows installation of Windows XP Professional. If you can't find it, you must install the 
"Windows Support Tools" from Microsoft (Follow the installation guide "to install windows support 
tools" at http://www.microsoft.com - search google for: "install windows support tools" and follow 
the first link). 

I don't know if these tools are also available for Windows XP Home or if they are included in the 
installation CD-ROM or available for download. If you are running Windows 2000 or similar, systeminfo 
should be available - i guess. 

CAUTION: 
 - patSysinfo for Windows was only tested on my personal computer! It was never used in productivity
   environment! 
-  As Microsoft says: "Certain Support Tools, if used improperly, might cause your computer to stop 
   functioning. It is recommended that only experienced users install and use Support Tools."

By default the executables will be installed somewhere in your windows directory e.g. 
    C:\WINDOWS\system32
	
Two ways to find the executables:

1) Setting PATH-variable
If you want to start these programmes from any other place, you should add the installation path 
to the environment variable PATH. To do that you must:

  - Check the installation directory of "systeminfo.exe" (for example)
  - Check you current PATH-variable:
      Run the program "cmd", enter the command "echo %PATH%" and examine the output.
	                             - or - 
	  Klick: Start -> Control Panel -> System -> Advanced -> Environment Variables 
	  search for the variable named "PATH" it's value.
   - Edit the value of the variable "PATH"
   - Check if you can start "systeminfo" from any directory.

2) Tell patSysinfo where to find the executables
Take a look at the file "patSysinfo/OS/Windows.php" and search for "PATSYSINFO_OS_WINDOWS_SYSTEMINFO".
This is the constant identifier for the "systeminfo"-command. You can define this constant within your
PHP-code BEFORE patSysinfo includes this file to set it to a correct value. E.g.:

<?PHP
   define( 'PATSYSINFO_OS_WINDOWS_SYSTEMINFO', 'C:\WINDOWS\system32\systeminfo.exe' );
?>

DO NOT CHANGE THE DEFINES INSIDE PATSYSINFO!

Other functions of patSysinfo use other programmes, like "tasklist.exe". If you run in trouble because
patSysinfo cannot find some of these programmes, you should try to fix the problem as described above.

Linux
-----
patSysinfo for Linux is gernally based on the /proc-filesytem and some (common) programmes. 
The /proc-filesystem is available since kernel verion 2.0.* (I guess) and provides an easy interface
to system-information and -settings. You can check the /proc-filesytem by the following command:
    $ cat /proc/version
This should output the kernel version-string running on this computer. If you got an error-message, 
you are in trouble. Further information about /proc-filesystem can be found in the Linux-Kernel
documentation. 

The programmes used by patSysinfo "wc" for example, should be in the default PATH. In case if
they cannot be found, you should either adjust the environment-variable PATH or "define" the paths to
the executables inside your PHP-code BEFORE patSysinfo includes "patSysinfo/OS/Linux.php". (Take
a look in this file and search for "PATSYSINFO_OS_LINUX_" to find the used defines.)

DO NOT CHANGE THE DEFINES INSIDE PATSYSINFO!

BSDs and other Unix?
--------------------
patSysinfo does not support any Unix-like OS without /proc-filesystem. The reason for this is quite simple:
We are running Linux on our server :-) 

INSTALLATION:
=============
patSysinfo contains of the factory class in the file patSysinfo.php file and some driver files 
all located in the directory patSysinfo. All you have to do is to copy both, the directory and 
the file to your prefered include directory.

    [file]  patSysinfo.php
    [dir]   patSysinfo 


TESTING:
========
For testing patSysinfo, include "patSysinfo.php" and...
Example:
<?PHP
	// include patErrorManager!
	include_once 'include/patErrorManager.php';
	
	// include patSysinfo
	include_once 'include/patSysinfo.php';
	
	echo patSysinfo::getOSName();
	
	$info	=	&patSysinfo::create();
	
	echo $info->getOsVersion();
?>
That's all, if this test runs smooth, patSysinfo should be available on your system.

TROUBLESHOOTING:
================
- Increase the verbosity of patError - the information provided by patError can help you 
  to fix your problem.


Have fun, gERD
Viel Spass am Gerät, gERD