/+---------------------------------------------------------------------------
//
//  Copyright (C) Intel Corporation, 2004 - 2008.
//
//  File:       README 
//
//  Contents:   a short description for developers
//
//----------------------------------------------------------------------------

Intel(R) Management & Security Status
=====================================

The 'Intel(R) Management & Security Status' (MEStatus) is a graphical user
interface application used to monitor Intel(R) AMT and Intel(R) TPM states.
User is able to verify whether Intel(R) AMT and Intel(R) TPM are enabled
and running on the system.
'Intel(R) Management & Security Status' is displayed in the system icon tray.
If configured the 'Intel(R) Management & Security Status' icon (MEStatus)
is launched every time user starts X session.
By default 'Intel(R) Management & Security Status' icon (MEstatus) terminates
if one of Intel(R) AMT or Intel(R) TPM is not enabled or not running.
This behavior can be changed in 'MEStatusApp' GUI application.
To use MEStatus make sure that Intel(R) UNS (User Notification Service)
is running.


Required libraries/tools:
-------------------------------------

- libGLADEmm: Version 2.4 or newer
- GTKmm: Version 2.4 or newer
- libnotify

GTKmm version 2.10 or newer is strongly recommended.
To build and run MEstatus and MEStatusApp with earlier GTKmm version < 2.10
- IGTKXMM library


Building and installing the MEStatus:
-------------------------------------
1. In order to build and install the MEStatus and MEStatusApp
   with GTKmm versions < 2.10   (=  2.4, 2.6 or 2.8 )
   you must first build the IGTKXMM library.
   (Skip this point if have GTKmm version 2.10 or newer.)
   call:
        './configure'
        'make'
        'make install'
        'ldconfig /usr/local/lib'

2. To build MEStatus call
        './configure'
        'make'
3. Call 'make install' to install MEStatus and MEStatusApp.

If Intel(R) UNS (User Notification Service) have been configured with
user specified prefix, MEStatus have to be configured with the same prefix.

By default MEStatus and MEStatusApp install to '/usr/local/bin' directory
and resources are placed into '/usr/local/share/mestatus' directory.
To start it manually run MEStatus from binary installation directory.
To configure MEStatus or check Intel(R) AMT or Intel(R) TPM status
run MEStatusApp from binary installation directory.

To configure MEStatus to start automatically with KDE session create starting 
script in user's '.kde/Autostart' directory.


'Intel(R) Management & Security Status' usage:
-----------------------------------------------
By default MEStatus runs only if Intel(R) AMT and Intel(R) TPM are enabled
and running on the system.
The GUI window appears when the status icon is double clicked
or 'Open' is selected from status icon popup menu.

If MEStatus is configured to run in all Intel(R) AMT and Intel(R) TPM states
status icon behavior is:
When Intel(R) AMT and Intel(R) TPM are enabled the red 'x' is not displayed.
When Intel(R) AMT and Intel(R) TPM states are not detected the red '?' is displayed.

MEStatusApp opens GUI window, but status icon is not displayed.

Event history is read from 'iATEventHistory.dat' file
located (by default) in '/usr/local/share' directory.
Event history file 'iATEventHistory.dat' is created and updated
by Intel(R) UNS (User Notification Service).


'Intel(R) Management & Security Status' customization:
-----------------------------------
MEStatus and MEStatusApp use 
machine configuration file /etc/IntelAMTCheck.config
and/or user configuration files ~/.IntelAMTCheck.user.config
Configuration options are stored in format:

option_name = option_value

Machine configuration file '/etc/IntelAMTCheck.config'
is used to set following options:

 - "CheckAMTStatusTimeout"      - Intel(R) AMT & iTPM status check timeout in ms
                                   default: 10000
 - "OemUrl"                     - URL to OEM vendor web page
                                   default: "http://www.intel.com/vpro"
 - "AMTStatusInitMaxRetries"    - max. number of retries checking initial 
                                  Intel(R) AMT & iTPM status
                                   default: 7
 - "EventHistoryMaxReadSize"    - max. number of displayed events
                                   default: 256


User configuration files '~/.IntelAMTCheck.user.config'
are used to store following informations:

 - "AMTLastEnabled"         - 1 (true) if Intel(R) AMT status
                              was enabled in previous run
                              It's updated by MEStatus application
                              when Intel(R) AMT status is changed.
 - "AlwaysShowStatusIcon"   - 1 (true) if status icon can be always available
                              even when Intel(R) AMT or iTPM are not enabled.
                               default: 0 (false) - show status icon only if
                                Intel(R) AMT and iTPM are enabled while
                                application is starting
			      It's updated by MEStatus application
			      as result of user GUI action.
			      MEStatus restart is required to take efect.
 - "PopupForCurrentUser"    - 1 (true) if show notification bubbles/popups
                               default: 1 (true)


Resource installation directory (default '/usr/local/share/intel/MEStatus/res')
contains files:

- oemlogo.gif    - vendor logo displayed in GUI window

- ATChk-on.ico   - tray icon for Enabled state of Intel(R) AMT & iTPM

- ATChk-off.ico  - tray icon for Disabled state of Intel(R) AMT or iTPM

- ATChk-unk.ico  - tray icon for Unknown state of Intel(R) AMT & iTPM

- ATChk-warn.ico - tray icon used when new events come
                       and user attention is required.

- ATChk32.ico    - icon of 'Intel(R) Management & Security Status'

- MEStatus.glade - glade GUI configuration of MEStatus(App) windows

- wired.ico      - wired network interface icon used in GUI

- wireless.ico   - wireless network interface icon used in GUI

