IBM XL Compiler Usage Logger Tool


By using IBM XL Compiler Usage Logger Tool you agree to the terms of the
license as specified in the following files:

      - LicenseAgreement.pdf
      - license.pdf

These files are located in the root directory of the installation media.
You will need a PDF viewer to view these files.


* INTRODUCTION *

The IBM XL Compiler Usage Logger Tool is a utility designed to provide user data for the user IDs invoking the XL C, XL C/C++, and XL Fortran for AIX compilers on a system.


The IBM XL Compiler Usage Logger Tool can be used with the following products:

C for AIX, V6.0
XL C Enterprise Edition for AIX, V7.0
XL C Enterprise Edition for AIX, V8.0
VisualAge C++ for AIX, V6.0
XL C/C++ Enterprise Edition for AIX, V7.0
XL C/C++ Enterprise Edition for AIX, V8.0
XL Fortran for AIX, V8.1
XL Fortran Enterprise Edition for AIX, V9.1
XL Fortran Enterprise Edition for AIX, V10.1


* WARNING *


Using the scripts in this package will require configuration changes to your
machines.  As such,  there is a chance that configuration errors may render the
compiler inoperable.  

Backups of your  machine and configuration is highly recommended before
installing  this tool, to enable recovery should a problem be encountered.
Always test this in a non-production environment before attempting to use it on
a production machine.  


* WHAT THIS TOOL DOES *


This tool will replace XL compiler invocation commands with a script
that will collect information about the invoking users.  The information is
recorded in a file, in a user-specified directory.

After installing this tool and allowing users to invoke the compiler for the desired data collection period, you can inspect the files in the directory to determine the user IDs that had accessed the compiler during that period.


* INSTALLATION *


Note that these instructions are for a default installation of the XL
compilers.  If you have an NDI install of the compiler, use this script at your
own risk.  

In order to log the invoking user IDs, this tool will replace the installed compiler invocation commands and will be configured to execute the original commands from a new location.  This will require modifications to your compiler installation.  Note that the modifications may cause AIX package checking tools to report errors.  You should refrain from running and correcting errors reported by these tools during data collection.

It should be noted that you are required to customize these scripts for your specific needs.

After customizing the scripts you should be able to execute them as super-user
to install the XL Compiler Usage Logger Tool.  After installation, depending on
your customizations, the XL Compiler Usage Logger Tool should begin logging
compiler executions immediately.

Note that during the install a backup file will be created.  Retain this backup in order to uninstall later.  


* UNINSTALLATION *


To uninstall the wrapper script, you should execute the CUSTOMIZED uninstall script for your compiler (xlc_uninstall.ksh or xlf_uninstall.ksh).  This will restore the back-up file created by the install script.


* CUSTOMIZING THE INSTALL/UNINSTALL SCRIPTS *


Script:  xlc_install.ksh, xlc_uninstall.ksh, xlf_install.ksh, xlf_uninstall.ksh

Specify the name of the wrapper script by modifying the WRAPPER_SCRIPT
variable.

Specify the location of the back-up tar file which will be created by
specifying the BACKJUP_FILE variable.

Specify the location of your compiler installation using the
INSTALLATION_LOCATION variable.


* CUSTOMIZING THE XL COMPILER USAGE LOGGER SCRIPT *


Script:  cul.ksh

The script contains comments to assist you with customizations.  The
customization options are described briefly below.

To customize the script to disable logging, set the DISABLELOGGING variable to
1.

The tool will log to the default directory (unless manually reconfigured):
	/var/tmp/xl_comp_users

You can alter the directory used for logging by customizing the script or by
setting the XL_COMP_USER_DIR environment variable.

To see error messages from the script, set the HUSH variable to 0.

Installing this tool requires copying of data in installation directories.
Thus, some additional free space will be required under the installation path
(/usr) in order to facilitate the copying.  

As a precaution it is recommended that a back-up of the current XL compiler
invocation commands be made to a location of your choosing which will also
require additional disk space.  

The tool may be installed and uninstalled manually by inspecting the
installation and uninstallation scripts provided to derive an understanding of
the steps required.


* USAGE INSTRUCTIONS AND COLLECTING DATA *


Once the tool has been customized and installed, each invocation will log usage data to the selected location.  No additional actions are required.

In order to inspect the data collected, you simply need to list the contents of the directory where data is being collected.  If desired you may archive this directory to keep the report.

By default output will be of the form:
	username_userid_hostname

For example:
	user1_1001_myhostname