################################################################################
#                                                                              #
#     PowerPanel for Linux Installation Guide                                  #
#                                                                              #
################################################################################

The PowerPanel for Linux software is primary to help system to monitor UPS, 
which has USB or serial port. The pwrstatd program will run as a daemon process,
it startups since system is booting. The pwrstatd communicates with UPS and help
system to do graceful shutdown while the power events are aware. The another 
program called pwrstat, which helps user to get status of the UPS and settings 
of the pwrstatd daemon. It also allows user to configure the UPS and pwrstatd 
daemon.


# Pre-requirement
1. The root authority is necessary for following instruction. You can use 'su'
   command to change authority as root.


# Installation


1. Un-compress installation package.
In terminal, change current directory as package location and typing command in
x86 linux as:

tar -xzvf powerpanel-ver-rev-i386.tar.gz

or typing command in x64 linux as:

tar -xzvf powerpanel-ver-rev-x86_64.tar.gz

Note:
A. The ver-rev denotes a version and release number, you have to replace it by 
   physical one, for example, "1.1-0".

B. It will create a directory powerpanel-ver-rev after un-compress 
   successfully.

2. Install software.

2.0. You have to read completely and agree the content of Software License 
     Agreement which file is in ./doc/LICENSE before installation. 

2.1. Change current directory to powerpanel-ver-rev as:

cd powerpanel-ver-rev

2.2. Run installation command as:

./install.sh

Note. It will show 'Installation accomplished!' message after installation done.
The daemon process will startup to monitoring UPS immediately.


# Un-installation


1. Change current directory to un-commpressed package directory.
2. Run un-installation command as:
./uninstall.sh


# Notice

1. You can find more information on un-compressed package directory 
   'powerpanel-ver-rev/doc'. The file describe as below:

LICENSE, PowerPanel for Linux software license agreement. 
README, information about this version of release.
install-guide, for this document.
user-manual, To instruct how to use this software.
deploy-guide, To instruct how software should be deployed. You may need this
              guide if you meet trouble at installation.

2. To ensure UPS is working well, you can use 'pwrstat -status' command to 
   check its status. Please in terminal typing as:

pwrstat -status

3. To get more information about 'pwrstat' command, typing command as:

pwrstat -help

4. The 'pwrstat' command is also need root authority, please see Pre-requirement
   section.

5. To get more information about 'pwrstat' and 'pwrstatd' man page helps, typing
   command as:

man pwrstat
man pwrstatd
